Constants
AclConfigService_UpdateAclConfig_FullMethodName, AclConfigService_GetAclConfig_FullMethodName
const (
AclConfigService_UpdateAclConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.AclConfigService/UpdateAclConfig"
AclConfigService_GetAclConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.AclConfigService/GetAclConfig"
)AssistantService_StreamAssist_FullMethodName, AssistantService_CreateAssistant_FullMethodName, AssistantService_DeleteAssistant_FullMethodName, AssistantService_UpdateAssistant_FullMethodName, AssistantService_GetAssistant_FullMethodName, AssistantService_ListAssistants_FullMethodName
const (
AssistantService_StreamAssist_FullMethodName = "/google.cloud.discoveryengine.v1beta.AssistantService/StreamAssist"
AssistantService_CreateAssistant_FullMethodName = "/google.cloud.discoveryengine.v1beta.AssistantService/CreateAssistant"
AssistantService_DeleteAssistant_FullMethodName = "/google.cloud.discoveryengine.v1beta.AssistantService/DeleteAssistant"
AssistantService_UpdateAssistant_FullMethodName = "/google.cloud.discoveryengine.v1beta.AssistantService/UpdateAssistant"
AssistantService_GetAssistant_FullMethodName = "/google.cloud.discoveryengine.v1beta.AssistantService/GetAssistant"
AssistantService_ListAssistants_FullMethodName = "/google.cloud.discoveryengine.v1beta.AssistantService/ListAssistants"
)CmekConfigService_UpdateCmekConfig_FullMethodName, CmekConfigService_GetCmekConfig_FullMethodName, CmekConfigService_ListCmekConfigs_FullMethodName, CmekConfigService_DeleteCmekConfig_FullMethodName
const (
CmekConfigService_UpdateCmekConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.CmekConfigService/UpdateCmekConfig"
CmekConfigService_GetCmekConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.CmekConfigService/GetCmekConfig"
CmekConfigService_ListCmekConfigs_FullMethodName = "/google.cloud.discoveryengine.v1beta.CmekConfigService/ListCmekConfigs"
CmekConfigService_DeleteCmekConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.CmekConfigService/DeleteCmekConfig"
)CompletionService_CompleteQuery_FullMethodName, CompletionService_AdvancedCompleteQuery_FullMethodName, CompletionService_ImportSuggestionDenyListEntries_FullMethodName, CompletionService_PurgeSuggestionDenyListEntries_FullMethodName, CompletionService_ImportCompletionSuggestions_FullMethodName, CompletionService_PurgeCompletionSuggestions_FullMethodName, CompletionService_RemoveSuggestion_FullMethodName
const (
CompletionService_CompleteQuery_FullMethodName = "/google.cloud.discoveryengine.v1beta.CompletionService/CompleteQuery"
CompletionService_AdvancedCompleteQuery_FullMethodName = "/google.cloud.discoveryengine.v1beta.CompletionService/AdvancedCompleteQuery"
CompletionService_ImportSuggestionDenyListEntries_FullMethodName = "/google.cloud.discoveryengine.v1beta.CompletionService/ImportSuggestionDenyListEntries"
CompletionService_PurgeSuggestionDenyListEntries_FullMethodName = "/google.cloud.discoveryengine.v1beta.CompletionService/PurgeSuggestionDenyListEntries"
CompletionService_ImportCompletionSuggestions_FullMethodName = "/google.cloud.discoveryengine.v1beta.CompletionService/ImportCompletionSuggestions"
CompletionService_PurgeCompletionSuggestions_FullMethodName = "/google.cloud.discoveryengine.v1beta.CompletionService/PurgeCompletionSuggestions"
CompletionService_RemoveSuggestion_FullMethodName = "/google.cloud.discoveryengine.v1beta.CompletionService/RemoveSuggestion"
)ControlService_CreateControl_FullMethodName, ControlService_DeleteControl_FullMethodName, ControlService_UpdateControl_FullMethodName, ControlService_GetControl_FullMethodName, ControlService_ListControls_FullMethodName
const (
ControlService_CreateControl_FullMethodName = "/google.cloud.discoveryengine.v1beta.ControlService/CreateControl"
ControlService_DeleteControl_FullMethodName = "/google.cloud.discoveryengine.v1beta.ControlService/DeleteControl"
ControlService_UpdateControl_FullMethodName = "/google.cloud.discoveryengine.v1beta.ControlService/UpdateControl"
ControlService_GetControl_FullMethodName = "/google.cloud.discoveryengine.v1beta.ControlService/GetControl"
ControlService_ListControls_FullMethodName = "/google.cloud.discoveryengine.v1beta.ControlService/ListControls"
)ConversationalSearchService_ConverseConversation_FullMethodName, ConversationalSearchService_CreateConversation_FullMethodName, ConversationalSearchService_DeleteConversation_FullMethodName, ConversationalSearchService_UpdateConversation_FullMethodName, ConversationalSearchService_GetConversation_FullMethodName, ConversationalSearchService_ListConversations_FullMethodName, ConversationalSearchService_AnswerQuery_FullMethodName, ConversationalSearchService_StreamAnswerQuery_FullMethodName, ConversationalSearchService_GetAnswer_FullMethodName, ConversationalSearchService_CreateSession_FullMethodName, ConversationalSearchService_DeleteSession_FullMethodName, ConversationalSearchService_UpdateSession_FullMethodName, ConversationalSearchService_GetSession_FullMethodName, ConversationalSearchService_ListSessions_FullMethodName
const (
ConversationalSearchService_ConverseConversation_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/ConverseConversation"
ConversationalSearchService_CreateConversation_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/CreateConversation"
ConversationalSearchService_DeleteConversation_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/DeleteConversation"
ConversationalSearchService_UpdateConversation_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/UpdateConversation"
ConversationalSearchService_GetConversation_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/GetConversation"
ConversationalSearchService_ListConversations_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/ListConversations"
ConversationalSearchService_AnswerQuery_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/AnswerQuery"
ConversationalSearchService_StreamAnswerQuery_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/StreamAnswerQuery"
ConversationalSearchService_GetAnswer_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/GetAnswer"
ConversationalSearchService_CreateSession_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/CreateSession"
ConversationalSearchService_DeleteSession_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/DeleteSession"
ConversationalSearchService_UpdateSession_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/UpdateSession"
ConversationalSearchService_GetSession_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/GetSession"
ConversationalSearchService_ListSessions_FullMethodName = "/google.cloud.discoveryengine.v1beta.ConversationalSearchService/ListSessions"
)DataStoreService_CreateDataStore_FullMethodName, DataStoreService_GetDataStore_FullMethodName, DataStoreService_ListDataStores_FullMethodName, DataStoreService_DeleteDataStore_FullMethodName, DataStoreService_UpdateDataStore_FullMethodName
const (
DataStoreService_CreateDataStore_FullMethodName = "/google.cloud.discoveryengine.v1beta.DataStoreService/CreateDataStore"
DataStoreService_GetDataStore_FullMethodName = "/google.cloud.discoveryengine.v1beta.DataStoreService/GetDataStore"
DataStoreService_ListDataStores_FullMethodName = "/google.cloud.discoveryengine.v1beta.DataStoreService/ListDataStores"
DataStoreService_DeleteDataStore_FullMethodName = "/google.cloud.discoveryengine.v1beta.DataStoreService/DeleteDataStore"
DataStoreService_UpdateDataStore_FullMethodName = "/google.cloud.discoveryengine.v1beta.DataStoreService/UpdateDataStore"
)DocumentService_GetDocument_FullMethodName, DocumentService_ListDocuments_FullMethodName, DocumentService_CreateDocument_FullMethodName, DocumentService_UpdateDocument_FullMethodName, DocumentService_DeleteDocument_FullMethodName, DocumentService_ImportDocuments_FullMethodName, DocumentService_PurgeDocuments_FullMethodName, DocumentService_BatchGetDocumentsMetadata_FullMethodName
const (
DocumentService_GetDocument_FullMethodName = "/google.cloud.discoveryengine.v1beta.DocumentService/GetDocument"
DocumentService_ListDocuments_FullMethodName = "/google.cloud.discoveryengine.v1beta.DocumentService/ListDocuments"
DocumentService_CreateDocument_FullMethodName = "/google.cloud.discoveryengine.v1beta.DocumentService/CreateDocument"
DocumentService_UpdateDocument_FullMethodName = "/google.cloud.discoveryengine.v1beta.DocumentService/UpdateDocument"
DocumentService_DeleteDocument_FullMethodName = "/google.cloud.discoveryengine.v1beta.DocumentService/DeleteDocument"
DocumentService_ImportDocuments_FullMethodName = "/google.cloud.discoveryengine.v1beta.DocumentService/ImportDocuments"
DocumentService_PurgeDocuments_FullMethodName = "/google.cloud.discoveryengine.v1beta.DocumentService/PurgeDocuments"
DocumentService_BatchGetDocumentsMetadata_FullMethodName = "/google.cloud.discoveryengine.v1beta.DocumentService/BatchGetDocumentsMetadata"
)EngineService_CreateEngine_FullMethodName, EngineService_DeleteEngine_FullMethodName, EngineService_UpdateEngine_FullMethodName, EngineService_GetEngine_FullMethodName, EngineService_ListEngines_FullMethodName, EngineService_PauseEngine_FullMethodName, EngineService_ResumeEngine_FullMethodName, EngineService_TuneEngine_FullMethodName, EngineService_GetIamPolicy_FullMethodName, EngineService_SetIamPolicy_FullMethodName
const (
EngineService_CreateEngine_FullMethodName = "/google.cloud.discoveryengine.v1beta.EngineService/CreateEngine"
EngineService_DeleteEngine_FullMethodName = "/google.cloud.discoveryengine.v1beta.EngineService/DeleteEngine"
EngineService_UpdateEngine_FullMethodName = "/google.cloud.discoveryengine.v1beta.EngineService/UpdateEngine"
EngineService_GetEngine_FullMethodName = "/google.cloud.discoveryengine.v1beta.EngineService/GetEngine"
EngineService_ListEngines_FullMethodName = "/google.cloud.discoveryengine.v1beta.EngineService/ListEngines"
EngineService_PauseEngine_FullMethodName = "/google.cloud.discoveryengine.v1beta.EngineService/PauseEngine"
EngineService_ResumeEngine_FullMethodName = "/google.cloud.discoveryengine.v1beta.EngineService/ResumeEngine"
EngineService_TuneEngine_FullMethodName = "/google.cloud.discoveryengine.v1beta.EngineService/TuneEngine"
EngineService_GetIamPolicy_FullMethodName = "/google.cloud.discoveryengine.v1beta.EngineService/GetIamPolicy"
EngineService_SetIamPolicy_FullMethodName = "/google.cloud.discoveryengine.v1beta.EngineService/SetIamPolicy"
)EvaluationService_GetEvaluation_FullMethodName, EvaluationService_ListEvaluations_FullMethodName, EvaluationService_CreateEvaluation_FullMethodName, EvaluationService_ListEvaluationResults_FullMethodName
const (
EvaluationService_GetEvaluation_FullMethodName = "/google.cloud.discoveryengine.v1beta.EvaluationService/GetEvaluation"
EvaluationService_ListEvaluations_FullMethodName = "/google.cloud.discoveryengine.v1beta.EvaluationService/ListEvaluations"
EvaluationService_CreateEvaluation_FullMethodName = "/google.cloud.discoveryengine.v1beta.EvaluationService/CreateEvaluation"
EvaluationService_ListEvaluationResults_FullMethodName = "/google.cloud.discoveryengine.v1beta.EvaluationService/ListEvaluationResults"
)GroundedGenerationService_StreamGenerateGroundedContent_FullMethodName, GroundedGenerationService_GenerateGroundedContent_FullMethodName, GroundedGenerationService_CheckGrounding_FullMethodName
const (
GroundedGenerationService_StreamGenerateGroundedContent_FullMethodName = "/google.cloud.discoveryengine.v1beta.GroundedGenerationService/StreamGenerateGroundedContent"
GroundedGenerationService_GenerateGroundedContent_FullMethodName = "/google.cloud.discoveryengine.v1beta.GroundedGenerationService/GenerateGroundedContent"
GroundedGenerationService_CheckGrounding_FullMethodName = "/google.cloud.discoveryengine.v1beta.GroundedGenerationService/CheckGrounding"
)IdentityMappingStoreService_CreateIdentityMappingStore_FullMethodName, IdentityMappingStoreService_GetIdentityMappingStore_FullMethodName, IdentityMappingStoreService_DeleteIdentityMappingStore_FullMethodName, IdentityMappingStoreService_ImportIdentityMappings_FullMethodName, IdentityMappingStoreService_PurgeIdentityMappings_FullMethodName, IdentityMappingStoreService_ListIdentityMappings_FullMethodName, IdentityMappingStoreService_ListIdentityMappingStores_FullMethodName
const (
IdentityMappingStoreService_CreateIdentityMappingStore_FullMethodName = "/google.cloud.discoveryengine.v1beta.IdentityMappingStoreService/CreateIdentityMappingStore"
IdentityMappingStoreService_GetIdentityMappingStore_FullMethodName = "/google.cloud.discoveryengine.v1beta.IdentityMappingStoreService/GetIdentityMappingStore"
IdentityMappingStoreService_DeleteIdentityMappingStore_FullMethodName = "/google.cloud.discoveryengine.v1beta.IdentityMappingStoreService/DeleteIdentityMappingStore"
IdentityMappingStoreService_ImportIdentityMappings_FullMethodName = "/google.cloud.discoveryengine.v1beta.IdentityMappingStoreService/ImportIdentityMappings"
IdentityMappingStoreService_PurgeIdentityMappings_FullMethodName = "/google.cloud.discoveryengine.v1beta.IdentityMappingStoreService/PurgeIdentityMappings"
IdentityMappingStoreService_ListIdentityMappings_FullMethodName = "/google.cloud.discoveryengine.v1beta.IdentityMappingStoreService/ListIdentityMappings"
IdentityMappingStoreService_ListIdentityMappingStores_FullMethodName = "/google.cloud.discoveryengine.v1beta.IdentityMappingStoreService/ListIdentityMappingStores"
)LicenseConfigService_CreateLicenseConfig_FullMethodName, LicenseConfigService_UpdateLicenseConfig_FullMethodName, LicenseConfigService_GetLicenseConfig_FullMethodName, LicenseConfigService_ListLicenseConfigs_FullMethodName, LicenseConfigService_DistributeLicenseConfig_FullMethodName, LicenseConfigService_RetractLicenseConfig_FullMethodName
const (
LicenseConfigService_CreateLicenseConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.LicenseConfigService/CreateLicenseConfig"
LicenseConfigService_UpdateLicenseConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.LicenseConfigService/UpdateLicenseConfig"
LicenseConfigService_GetLicenseConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.LicenseConfigService/GetLicenseConfig"
LicenseConfigService_ListLicenseConfigs_FullMethodName = "/google.cloud.discoveryengine.v1beta.LicenseConfigService/ListLicenseConfigs"
LicenseConfigService_DistributeLicenseConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.LicenseConfigService/DistributeLicenseConfig"
LicenseConfigService_RetractLicenseConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.LicenseConfigService/RetractLicenseConfig"
)SampleQueryService_GetSampleQuery_FullMethodName, SampleQueryService_ListSampleQueries_FullMethodName, SampleQueryService_CreateSampleQuery_FullMethodName, SampleQueryService_UpdateSampleQuery_FullMethodName, SampleQueryService_DeleteSampleQuery_FullMethodName, SampleQueryService_ImportSampleQueries_FullMethodName
const (
SampleQueryService_GetSampleQuery_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQueryService/GetSampleQuery"
SampleQueryService_ListSampleQueries_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQueryService/ListSampleQueries"
SampleQueryService_CreateSampleQuery_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQueryService/CreateSampleQuery"
SampleQueryService_UpdateSampleQuery_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQueryService/UpdateSampleQuery"
SampleQueryService_DeleteSampleQuery_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQueryService/DeleteSampleQuery"
SampleQueryService_ImportSampleQueries_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQueryService/ImportSampleQueries"
)SampleQuerySetService_GetSampleQuerySet_FullMethodName, SampleQuerySetService_ListSampleQuerySets_FullMethodName, SampleQuerySetService_CreateSampleQuerySet_FullMethodName, SampleQuerySetService_UpdateSampleQuerySet_FullMethodName, SampleQuerySetService_DeleteSampleQuerySet_FullMethodName
const (
SampleQuerySetService_GetSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQuerySetService/GetSampleQuerySet"
SampleQuerySetService_ListSampleQuerySets_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQuerySetService/ListSampleQuerySets"
SampleQuerySetService_CreateSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQuerySetService/CreateSampleQuerySet"
SampleQuerySetService_UpdateSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQuerySetService/UpdateSampleQuerySet"
SampleQuerySetService_DeleteSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1beta.SampleQuerySetService/DeleteSampleQuerySet"
)SchemaService_GetSchema_FullMethodName, SchemaService_ListSchemas_FullMethodName, SchemaService_CreateSchema_FullMethodName, SchemaService_UpdateSchema_FullMethodName, SchemaService_DeleteSchema_FullMethodName
const (
SchemaService_GetSchema_FullMethodName = "/google.cloud.discoveryengine.v1beta.SchemaService/GetSchema"
SchemaService_ListSchemas_FullMethodName = "/google.cloud.discoveryengine.v1beta.SchemaService/ListSchemas"
SchemaService_CreateSchema_FullMethodName = "/google.cloud.discoveryengine.v1beta.SchemaService/CreateSchema"
SchemaService_UpdateSchema_FullMethodName = "/google.cloud.discoveryengine.v1beta.SchemaService/UpdateSchema"
SchemaService_DeleteSchema_FullMethodName = "/google.cloud.discoveryengine.v1beta.SchemaService/DeleteSchema"
)SearchService_Search_FullMethodName, SearchService_SearchLite_FullMethodName
const (
SearchService_Search_FullMethodName = "/google.cloud.discoveryengine.v1beta.SearchService/Search"
SearchService_SearchLite_FullMethodName = "/google.cloud.discoveryengine.v1beta.SearchService/SearchLite"
)SearchTuningService_TrainCustomModel_FullMethodName, SearchTuningService_ListCustomModels_FullMethodName
const (
SearchTuningService_TrainCustomModel_FullMethodName = "/google.cloud.discoveryengine.v1beta.SearchTuningService/TrainCustomModel"
SearchTuningService_ListCustomModels_FullMethodName = "/google.cloud.discoveryengine.v1beta.SearchTuningService/ListCustomModels"
)ServingConfigService_CreateServingConfig_FullMethodName, ServingConfigService_DeleteServingConfig_FullMethodName, ServingConfigService_UpdateServingConfig_FullMethodName, ServingConfigService_GetServingConfig_FullMethodName, ServingConfigService_ListServingConfigs_FullMethodName
const (
ServingConfigService_CreateServingConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.ServingConfigService/CreateServingConfig"
ServingConfigService_DeleteServingConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.ServingConfigService/DeleteServingConfig"
ServingConfigService_UpdateServingConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.ServingConfigService/UpdateServingConfig"
ServingConfigService_GetServingConfig_FullMethodName = "/google.cloud.discoveryengine.v1beta.ServingConfigService/GetServingConfig"
ServingConfigService_ListServingConfigs_FullMethodName = "/google.cloud.discoveryengine.v1beta.ServingConfigService/ListServingConfigs"
)SessionService_CreateSession_FullMethodName, SessionService_DeleteSession_FullMethodName, SessionService_UpdateSession_FullMethodName, SessionService_GetSession_FullMethodName, SessionService_ListSessions_FullMethodName
const (
SessionService_CreateSession_FullMethodName = "/google.cloud.discoveryengine.v1beta.SessionService/CreateSession"
SessionService_DeleteSession_FullMethodName = "/google.cloud.discoveryengine.v1beta.SessionService/DeleteSession"
SessionService_UpdateSession_FullMethodName = "/google.cloud.discoveryengine.v1beta.SessionService/UpdateSession"
SessionService_GetSession_FullMethodName = "/google.cloud.discoveryengine.v1beta.SessionService/GetSession"
SessionService_ListSessions_FullMethodName = "/google.cloud.discoveryengine.v1beta.SessionService/ListSessions"
)SiteSearchEngineService_GetSiteSearchEngine_FullMethodName, SiteSearchEngineService_CreateTargetSite_FullMethodName, SiteSearchEngineService_BatchCreateTargetSites_FullMethodName, SiteSearchEngineService_GetTargetSite_FullMethodName, SiteSearchEngineService_UpdateTargetSite_FullMethodName, SiteSearchEngineService_DeleteTargetSite_FullMethodName, SiteSearchEngineService_ListTargetSites_FullMethodName, SiteSearchEngineService_CreateSitemap_FullMethodName, SiteSearchEngineService_DeleteSitemap_FullMethodName, SiteSearchEngineService_FetchSitemaps_FullMethodName, SiteSearchEngineService_EnableAdvancedSiteSearch_FullMethodName, SiteSearchEngineService_DisableAdvancedSiteSearch_FullMethodName, SiteSearchEngineService_RecrawlUris_FullMethodName, SiteSearchEngineService_BatchVerifyTargetSites_FullMethodName, SiteSearchEngineService_FetchDomainVerificationStatus_FullMethodName
const (
SiteSearchEngineService_GetSiteSearchEngine_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/GetSiteSearchEngine"
SiteSearchEngineService_CreateTargetSite_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/CreateTargetSite"
SiteSearchEngineService_BatchCreateTargetSites_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/BatchCreateTargetSites"
SiteSearchEngineService_GetTargetSite_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/GetTargetSite"
SiteSearchEngineService_UpdateTargetSite_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/UpdateTargetSite"
SiteSearchEngineService_DeleteTargetSite_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/DeleteTargetSite"
SiteSearchEngineService_ListTargetSites_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/ListTargetSites"
SiteSearchEngineService_CreateSitemap_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/CreateSitemap"
SiteSearchEngineService_DeleteSitemap_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/DeleteSitemap"
SiteSearchEngineService_FetchSitemaps_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/FetchSitemaps"
SiteSearchEngineService_EnableAdvancedSiteSearch_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/EnableAdvancedSiteSearch"
SiteSearchEngineService_DisableAdvancedSiteSearch_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/DisableAdvancedSiteSearch"
SiteSearchEngineService_RecrawlUris_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/RecrawlUris"
SiteSearchEngineService_BatchVerifyTargetSites_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/BatchVerifyTargetSites"
SiteSearchEngineService_FetchDomainVerificationStatus_FullMethodName = "/google.cloud.discoveryengine.v1beta.SiteSearchEngineService/FetchDomainVerificationStatus"
)UserEventService_WriteUserEvent_FullMethodName, UserEventService_CollectUserEvent_FullMethodName, UserEventService_PurgeUserEvents_FullMethodName, UserEventService_ImportUserEvents_FullMethodName
const (
UserEventService_WriteUserEvent_FullMethodName = "/google.cloud.discoveryengine.v1beta.UserEventService/WriteUserEvent"
UserEventService_CollectUserEvent_FullMethodName = "/google.cloud.discoveryengine.v1beta.UserEventService/CollectUserEvent"
UserEventService_PurgeUserEvents_FullMethodName = "/google.cloud.discoveryengine.v1beta.UserEventService/PurgeUserEvents"
UserEventService_ImportUserEvents_FullMethodName = "/google.cloud.discoveryengine.v1beta.UserEventService/ImportUserEvents"
)UserLicenseService_ListUserLicenses_FullMethodName, UserLicenseService_ListLicenseConfigsUsageStats_FullMethodName, UserLicenseService_BatchUpdateUserLicenses_FullMethodName
const (
UserLicenseService_ListUserLicenses_FullMethodName = "/google.cloud.discoveryengine.v1beta.UserLicenseService/ListUserLicenses"
UserLicenseService_ListLicenseConfigsUsageStats_FullMethodName = "/google.cloud.discoveryengine.v1beta.UserLicenseService/ListLicenseConfigsUsageStats"
UserLicenseService_BatchUpdateUserLicenses_FullMethodName = "/google.cloud.discoveryengine.v1beta.UserLicenseService/BatchUpdateUserLicenses"
)UserStoreService_GetUserStore_FullMethodName, UserStoreService_UpdateUserStore_FullMethodName
const (
UserStoreService_GetUserStore_FullMethodName = "/google.cloud.discoveryengine.v1beta.UserStoreService/GetUserStore"
UserStoreService_UpdateUserStore_FullMethodName = "/google.cloud.discoveryengine.v1beta.UserStoreService/UpdateUserStore"
)ProjectService_ProvisionProject_FullMethodName
const (
ProjectService_ProvisionProject_FullMethodName = "/google.cloud.discoveryengine.v1beta.ProjectService/ProvisionProject"
)RankService_Rank_FullMethodName
const (
RankService_Rank_FullMethodName = "/google.cloud.discoveryengine.v1beta.RankService/Rank"
)RecommendationService_Recommend_FullMethodName
const (
RecommendationService_Recommend_FullMethodName = "/google.cloud.discoveryengine.v1beta.RecommendationService/Recommend"
)Variables
Answer_State_name, Answer_State_value
var (
Answer_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "IN_PROGRESS",
2: "FAILED",
3: "SUCCEEDED",
4: "STREAMING",
}
Answer_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"IN_PROGRESS": 1,
"FAILED": 2,
"SUCCEEDED": 3,
"STREAMING": 4,
}
)Enum value maps for Answer_State.
Answer_AnswerSkippedReason_name, Answer_AnswerSkippedReason_value
var (
Answer_AnswerSkippedReason_name = map[int32]string{
0: "ANSWER_SKIPPED_REASON_UNSPECIFIED",
1: "ADVERSARIAL_QUERY_IGNORED",
2: "NON_ANSWER_SEEKING_QUERY_IGNORED",
3: "OUT_OF_DOMAIN_QUERY_IGNORED",
4: "POTENTIAL_POLICY_VIOLATION",
5: "NO_RELEVANT_CONTENT",
6: "JAIL_BREAKING_QUERY_IGNORED",
7: "CUSTOMER_POLICY_VIOLATION",
8: "NON_ANSWER_SEEKING_QUERY_IGNORED_V2",
9: "LOW_GROUNDED_ANSWER",
10: "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED",
11: "UNHELPFUL_ANSWER",
}
Answer_AnswerSkippedReason_value = map[string]int32{
"ANSWER_SKIPPED_REASON_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY_IGNORED": 1,
"NON_ANSWER_SEEKING_QUERY_IGNORED": 2,
"OUT_OF_DOMAIN_QUERY_IGNORED": 3,
"POTENTIAL_POLICY_VIOLATION": 4,
"NO_RELEVANT_CONTENT": 5,
"JAIL_BREAKING_QUERY_IGNORED": 6,
"CUSTOMER_POLICY_VIOLATION": 7,
"NON_ANSWER_SEEKING_QUERY_IGNORED_V2": 8,
"LOW_GROUNDED_ANSWER": 9,
"USER_DEFINED_CLASSIFICATION_QUERY_IGNORED": 10,
"UNHELPFUL_ANSWER": 11,
}
)Enum value maps for Answer_AnswerSkippedReason.
Answer_BlobAttachment_AttributionType_name, Answer_BlobAttachment_AttributionType_value
var (
Answer_BlobAttachment_AttributionType_name = map[int32]string{
0: "ATTRIBUTION_TYPE_UNSPECIFIED",
1: "CORPUS",
2: "GENERATED",
}
Answer_BlobAttachment_AttributionType_value = map[string]int32{
"ATTRIBUTION_TYPE_UNSPECIFIED": 0,
"CORPUS": 1,
"GENERATED": 2,
}
)Enum value maps for Answer_BlobAttachment_AttributionType.
Answer_Step_State_name, Answer_Step_State_value
var (
Answer_Step_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "IN_PROGRESS",
2: "FAILED",
3: "SUCCEEDED",
}
Answer_Step_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"IN_PROGRESS": 1,
"FAILED": 2,
"SUCCEEDED": 3,
}
)Enum value maps for Answer_Step_State.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_name, Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_value
var (
Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "ADVERSARIAL_QUERY",
2: "NON_ANSWER_SEEKING_QUERY",
3: "JAIL_BREAKING_QUERY",
4: "NON_ANSWER_SEEKING_QUERY_V2",
5: "USER_DEFINED_CLASSIFICATION_QUERY",
}
Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY": 1,
"NON_ANSWER_SEEKING_QUERY": 2,
"JAIL_BREAKING_QUERY": 3,
"NON_ANSWER_SEEKING_QUERY_V2": 4,
"USER_DEFINED_CLASSIFICATION_QUERY": 5,
}
)Enum value maps for Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.
AssistAnswer_State_name, AssistAnswer_State_value
var (
AssistAnswer_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "IN_PROGRESS",
2: "FAILED",
3: "SUCCEEDED",
4: "SKIPPED",
5: "CANCELLED",
}
AssistAnswer_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"IN_PROGRESS": 1,
"FAILED": 2,
"SUCCEEDED": 3,
"SKIPPED": 4,
"CANCELLED": 5,
}
)Enum value maps for AssistAnswer_State.
AssistAnswer_AssistSkippedReason_name, AssistAnswer_AssistSkippedReason_value
var (
AssistAnswer_AssistSkippedReason_name = map[int32]string{
0: "ASSIST_SKIPPED_REASON_UNSPECIFIED",
1: "NON_ASSIST_SEEKING_QUERY_IGNORED",
2: "CUSTOMER_POLICY_VIOLATION",
}
AssistAnswer_AssistSkippedReason_value = map[string]int32{
"ASSIST_SKIPPED_REASON_UNSPECIFIED": 0,
"NON_ASSIST_SEEKING_QUERY_IGNORED": 1,
"CUSTOMER_POLICY_VIOLATION": 2,
}
)Enum value maps for AssistAnswer_AssistSkippedReason.
AssistAnswer_CustomerPolicyEnforcementResult_Verdict_name, AssistAnswer_CustomerPolicyEnforcementResult_Verdict_value
var (
AssistAnswer_CustomerPolicyEnforcementResult_Verdict_name = map[int32]string{
0: "UNSPECIFIED",
1: "ALLOW",
2: "BLOCK",
}
AssistAnswer_CustomerPolicyEnforcementResult_Verdict_value = map[string]int32{
"UNSPECIFIED": 0,
"ALLOW": 1,
"BLOCK": 2,
}
)Enum value maps for AssistAnswer_CustomerPolicyEnforcementResult_Verdict.
AssistantContent_CodeExecutionResult_Outcome_name, AssistantContent_CodeExecutionResult_Outcome_value
var (
AssistantContent_CodeExecutionResult_Outcome_name = map[int32]string{
0: "OUTCOME_UNSPECIFIED",
1: "OUTCOME_OK",
2: "OUTCOME_FAILED",
3: "OUTCOME_DEADLINE_EXCEEDED",
}
AssistantContent_CodeExecutionResult_Outcome_value = map[string]int32{
"OUTCOME_UNSPECIFIED": 0,
"OUTCOME_OK": 1,
"OUTCOME_FAILED": 2,
"OUTCOME_DEADLINE_EXCEEDED": 3,
}
)Enum value maps for AssistantContent_CodeExecutionResult_Outcome.
AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language_name, AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language_value
var (
AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language_name = map[int32]string{
0: "LANGUAGE_UNSPECIFIED",
1: "PYTHON",
2: "SQL",
}
AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language_value = map[string]int32{
"LANGUAGE_UNSPECIFIED": 0,
"PYTHON": 1,
"SQL": 2,
}
)Enum value maps for AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language.
Assistant_WebGroundingType_name, Assistant_WebGroundingType_value
var (
Assistant_WebGroundingType_name = map[int32]string{
0: "WEB_GROUNDING_TYPE_UNSPECIFIED",
1: "WEB_GROUNDING_TYPE_DISABLED",
2: "WEB_GROUNDING_TYPE_GOOGLE_SEARCH",
3: "WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH",
}
Assistant_WebGroundingType_value = map[string]int32{
"WEB_GROUNDING_TYPE_UNSPECIFIED": 0,
"WEB_GROUNDING_TYPE_DISABLED": 1,
"WEB_GROUNDING_TYPE_GOOGLE_SEARCH": 2,
"WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH": 3,
}
)Enum value maps for Assistant_WebGroundingType.
Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType_name, Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType_value
var (
Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType_name = map[int32]string{
0: "BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED",
1: "SIMPLE_STRING_MATCH",
2: "WORD_BOUNDARY_STRING_MATCH",
}
Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType_value = map[string]int32{
"BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED": 0,
"SIMPLE_STRING_MATCH": 1,
"WORD_BOUNDARY_STRING_MATCH": 2,
}
)Enum value maps for Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType.
Assistant_CustomerPolicy_ModelArmorConfig_FailureMode_name, Assistant_CustomerPolicy_ModelArmorConfig_FailureMode_value
var (
Assistant_CustomerPolicy_ModelArmorConfig_FailureMode_name = map[int32]string{
0: "FAILURE_MODE_UNSPECIFIED",
1: "FAIL_OPEN",
2: "FAIL_CLOSED",
}
Assistant_CustomerPolicy_ModelArmorConfig_FailureMode_value = map[string]int32{
"FAILURE_MODE_UNSPECIFIED": 0,
"FAIL_OPEN": 1,
"FAIL_CLOSED": 2,
}
)Enum value maps for Assistant_CustomerPolicy_ModelArmorConfig_FailureMode.
Chunk_StructureType_name, Chunk_StructureType_value
var (
Chunk_StructureType_name = map[int32]string{
0: "STRUCTURE_TYPE_UNSPECIFIED",
1: "SHAREHOLDER_STRUCTURE",
2: "SIGNATURE_STRUCTURE",
3: "CHECKBOX_STRUCTURE",
}
Chunk_StructureType_value = map[string]int32{
"STRUCTURE_TYPE_UNSPECIFIED": 0,
"SHAREHOLDER_STRUCTURE": 1,
"SIGNATURE_STRUCTURE": 2,
"CHECKBOX_STRUCTURE": 3,
}
)Enum value maps for Chunk_StructureType.
CmekConfig_State_name, CmekConfig_State_value
var (
CmekConfig_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "CREATING",
2: "ACTIVE",
3: "KEY_ISSUE",
4: "DELETING",
7: "DELETE_FAILED",
5: "UNUSABLE",
6: "ACTIVE_ROTATING",
8: "DELETED",
9: "EXPIRED",
}
CmekConfig_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"CREATING": 1,
"ACTIVE": 2,
"KEY_ISSUE": 3,
"DELETING": 4,
"DELETE_FAILED": 7,
"UNUSABLE": 5,
"ACTIVE_ROTATING": 6,
"DELETED": 8,
"EXPIRED": 9,
}
)Enum value maps for CmekConfig_State.
CmekConfig_NotebookLMState_name, CmekConfig_NotebookLMState_value
var (
CmekConfig_NotebookLMState_name = map[int32]string{
0: "NOTEBOOK_LM_STATE_UNSPECIFIED",
1: "NOTEBOOK_LM_NOT_READY",
2: "NOTEBOOK_LM_READY",
3: "NOTEBOOK_LM_NOT_ENABLED",
}
CmekConfig_NotebookLMState_value = map[string]int32{
"NOTEBOOK_LM_STATE_UNSPECIFIED": 0,
"NOTEBOOK_LM_NOT_READY": 1,
"NOTEBOOK_LM_READY": 2,
"NOTEBOOK_LM_NOT_ENABLED": 3,
}
)Enum value maps for CmekConfig_NotebookLMState.
IndustryVertical_name, IndustryVertical_value
var (
IndustryVertical_name = map[int32]string{
0: "INDUSTRY_VERTICAL_UNSPECIFIED",
1: "GENERIC",
2: "MEDIA",
7: "HEALTHCARE_FHIR",
}
IndustryVertical_value = map[string]int32{
"INDUSTRY_VERTICAL_UNSPECIFIED": 0,
"GENERIC": 1,
"MEDIA": 2,
"HEALTHCARE_FHIR": 7,
}
)Enum value maps for IndustryVertical.
SolutionType_name, SolutionType_value
var (
SolutionType_name = map[int32]string{
0: "SOLUTION_TYPE_UNSPECIFIED",
1: "SOLUTION_TYPE_RECOMMENDATION",
2: "SOLUTION_TYPE_SEARCH",
3: "SOLUTION_TYPE_CHAT",
4: "SOLUTION_TYPE_GENERATIVE_CHAT",
5: "SOLUTION_TYPE_AI_MODE",
}
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,
"SOLUTION_TYPE_AI_MODE": 5,
}
)Enum value maps for SolutionType.
SearchUseCase_name, SearchUseCase_value
var (
SearchUseCase_name = map[int32]string{
0: "SEARCH_USE_CASE_UNSPECIFIED",
1: "SEARCH_USE_CASE_SEARCH",
2: "SEARCH_USE_CASE_BROWSE",
}
SearchUseCase_value = map[string]int32{
"SEARCH_USE_CASE_UNSPECIFIED": 0,
"SEARCH_USE_CASE_SEARCH": 1,
"SEARCH_USE_CASE_BROWSE": 2,
}
)Enum value maps for SearchUseCase.
SearchTier_name, SearchTier_value
var (
SearchTier_name = map[int32]string{
0: "SEARCH_TIER_UNSPECIFIED",
1: "SEARCH_TIER_STANDARD",
2: "SEARCH_TIER_ENTERPRISE",
}
SearchTier_value = map[string]int32{
"SEARCH_TIER_UNSPECIFIED": 0,
"SEARCH_TIER_STANDARD": 1,
"SEARCH_TIER_ENTERPRISE": 2,
}
)Enum value maps for SearchTier.
SearchAddOn_name, SearchAddOn_value
var (
SearchAddOn_name = map[int32]string{
0: "SEARCH_ADD_ON_UNSPECIFIED",
1: "SEARCH_ADD_ON_LLM",
}
SearchAddOn_value = map[string]int32{
"SEARCH_ADD_ON_UNSPECIFIED": 0,
"SEARCH_ADD_ON_LLM": 1,
}
)Enum value maps for SearchAddOn.
SubscriptionTier_name, SubscriptionTier_value
var (
SubscriptionTier_name = map[int32]string{
0: "SUBSCRIPTION_TIER_UNSPECIFIED",
1: "SUBSCRIPTION_TIER_SEARCH",
2: "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT",
3: "SUBSCRIPTION_TIER_NOTEBOOK_LM",
4: "SUBSCRIPTION_TIER_FRONTLINE_WORKER",
10: "SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
6: "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
7: "SUBSCRIPTION_TIER_ENTERPRISE",
15: "SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
8: "SUBSCRIPTION_TIER_EDU",
9: "SUBSCRIPTION_TIER_EDU_PRO",
11: "SUBSCRIPTION_TIER_EDU_EMERGING",
12: "SUBSCRIPTION_TIER_EDU_PRO_EMERGING",
13: "SUBSCRIPTION_TIER_FRONTLINE_STARTER",
}
SubscriptionTier_value = map[string]int32{
"SUBSCRIPTION_TIER_UNSPECIFIED": 0,
"SUBSCRIPTION_TIER_SEARCH": 1,
"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT": 2,
"SUBSCRIPTION_TIER_NOTEBOOK_LM": 3,
"SUBSCRIPTION_TIER_FRONTLINE_WORKER": 4,
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER": 10,
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS": 6,
"SUBSCRIPTION_TIER_ENTERPRISE": 7,
"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING": 15,
"SUBSCRIPTION_TIER_EDU": 8,
"SUBSCRIPTION_TIER_EDU_PRO": 9,
"SUBSCRIPTION_TIER_EDU_EMERGING": 11,
"SUBSCRIPTION_TIER_EDU_PRO_EMERGING": 12,
"SUBSCRIPTION_TIER_FRONTLINE_STARTER": 13,
}
)Enum value maps for SubscriptionTier.
SubscriptionTerm_name, SubscriptionTerm_value
var (
SubscriptionTerm_name = map[int32]string{
0: "SUBSCRIPTION_TERM_UNSPECIFIED",
1: "SUBSCRIPTION_TERM_ONE_MONTH",
2: "SUBSCRIPTION_TERM_ONE_YEAR",
3: "SUBSCRIPTION_TERM_THREE_YEARS",
6: "SUBSCRIPTION_TERM_CUSTOM",
}
SubscriptionTerm_value = map[string]int32{
"SUBSCRIPTION_TERM_UNSPECIFIED": 0,
"SUBSCRIPTION_TERM_ONE_MONTH": 1,
"SUBSCRIPTION_TERM_ONE_YEAR": 2,
"SUBSCRIPTION_TERM_THREE_YEARS": 3,
"SUBSCRIPTION_TERM_CUSTOM": 6,
}
)Enum value maps for SubscriptionTerm.
IdpConfig_IdpType_name, IdpConfig_IdpType_value
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.
SuggestionDenyListEntry_MatchOperator_name, SuggestionDenyListEntry_MatchOperator_value
var (
SuggestionDenyListEntry_MatchOperator_name = map[int32]string{
0: "MATCH_OPERATOR_UNSPECIFIED",
1: "EXACT_MATCH",
2: "CONTAINS",
}
SuggestionDenyListEntry_MatchOperator_value = map[string]int32{
"MATCH_OPERATOR_UNSPECIFIED": 0,
"EXACT_MATCH": 1,
"CONTAINS": 2,
}
)Enum value maps for SuggestionDenyListEntry_MatchOperator.
AdvancedCompleteQueryRequest_SuggestionType_name, AdvancedCompleteQueryRequest_SuggestionType_value
var (
AdvancedCompleteQueryRequest_SuggestionType_name = map[int32]string{
0: "SUGGESTION_TYPE_UNSPECIFIED",
1: "QUERY",
2: "PEOPLE",
3: "CONTENT",
4: "RECENT_SEARCH",
5: "GOOGLE_WORKSPACE",
}
AdvancedCompleteQueryRequest_SuggestionType_value = map[string]int32{
"SUGGESTION_TYPE_UNSPECIFIED": 0,
"QUERY": 1,
"PEOPLE": 2,
"CONTENT": 3,
"RECENT_SEARCH": 4,
"GOOGLE_WORKSPACE": 5,
}
)Enum value maps for AdvancedCompleteQueryRequest_SuggestionType.
AdvancedCompleteQueryResponse_PersonSuggestion_PersonType_name, AdvancedCompleteQueryResponse_PersonSuggestion_PersonType_value
var (
AdvancedCompleteQueryResponse_PersonSuggestion_PersonType_name = map[int32]string{
0: "PERSON_TYPE_UNSPECIFIED",
1: "CLOUD_IDENTITY",
2: "THIRD_PARTY_IDENTITY",
}
AdvancedCompleteQueryResponse_PersonSuggestion_PersonType_value = map[string]int32{
"PERSON_TYPE_UNSPECIFIED": 0,
"CLOUD_IDENTITY": 1,
"THIRD_PARTY_IDENTITY": 2,
}
)Enum value maps for AdvancedCompleteQueryResponse_PersonSuggestion_PersonType.
AdvancedCompleteQueryResponse_ContentSuggestion_ContentType_name, AdvancedCompleteQueryResponse_ContentSuggestion_ContentType_value
var (
AdvancedCompleteQueryResponse_ContentSuggestion_ContentType_name = map[int32]string{
0: "CONTENT_TYPE_UNSPECIFIED",
1: "GOOGLE_WORKSPACE",
2: "THIRD_PARTY",
}
AdvancedCompleteQueryResponse_ContentSuggestion_ContentType_value = map[string]int32{
"CONTENT_TYPE_UNSPECIFIED": 0,
"GOOGLE_WORKSPACE": 1,
"THIRD_PARTY": 2,
}
)Enum value maps for AdvancedCompleteQueryResponse_ContentSuggestion_ContentType.
Control_BoostAction_InterpolationBoostSpec_AttributeType_name, Control_BoostAction_InterpolationBoostSpec_AttributeType_value
var (
Control_BoostAction_InterpolationBoostSpec_AttributeType_name = map[int32]string{
0: "ATTRIBUTE_TYPE_UNSPECIFIED",
1: "NUMERICAL",
2: "FRESHNESS",
}
Control_BoostAction_InterpolationBoostSpec_AttributeType_value = map[string]int32{
"ATTRIBUTE_TYPE_UNSPECIFIED": 0,
"NUMERICAL": 1,
"FRESHNESS": 2,
}
)Enum value maps for Control_BoostAction_InterpolationBoostSpec_AttributeType.
Control_BoostAction_InterpolationBoostSpec_InterpolationType_name, Control_BoostAction_InterpolationBoostSpec_InterpolationType_value
var (
Control_BoostAction_InterpolationBoostSpec_InterpolationType_name = map[int32]string{
0: "INTERPOLATION_TYPE_UNSPECIFIED",
1: "LINEAR",
}
Control_BoostAction_InterpolationBoostSpec_InterpolationType_value = map[string]int32{
"INTERPOLATION_TYPE_UNSPECIFIED": 0,
"LINEAR": 1,
}
)Enum value maps for Control_BoostAction_InterpolationBoostSpec_InterpolationType.
Conversation_State_name, Conversation_State_value
var (
Conversation_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "IN_PROGRESS",
2: "COMPLETED",
}
Conversation_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"IN_PROGRESS": 1,
"COMPLETED": 2,
}
)Enum value maps for Conversation_State.
AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold_name, AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold_value
var (
AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold_name = map[int32]string{
0: "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
1: "BLOCK_LOW_AND_ABOVE",
2: "BLOCK_MEDIUM_AND_ABOVE",
3: "BLOCK_ONLY_HIGH",
4: "BLOCK_NONE",
5: "OFF",
}
AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold_value = map[string]int32{
"HARM_BLOCK_THRESHOLD_UNSPECIFIED": 0,
"BLOCK_LOW_AND_ABOVE": 1,
"BLOCK_MEDIUM_AND_ABOVE": 2,
"BLOCK_ONLY_HIGH": 3,
"BLOCK_NONE": 4,
"OFF": 5,
}
)Enum value maps for AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold.
AnswerQueryRequest_GroundingSpec_FilteringLevel_name, AnswerQueryRequest_GroundingSpec_FilteringLevel_value
var (
AnswerQueryRequest_GroundingSpec_FilteringLevel_name = map[int32]string{
0: "FILTERING_LEVEL_UNSPECIFIED",
1: "FILTERING_LEVEL_LOW",
2: "FILTERING_LEVEL_HIGH",
}
AnswerQueryRequest_GroundingSpec_FilteringLevel_value = map[string]int32{
"FILTERING_LEVEL_UNSPECIFIED": 0,
"FILTERING_LEVEL_LOW": 1,
"FILTERING_LEVEL_HIGH": 2,
}
)Enum value maps for AnswerQueryRequest_GroundingSpec_FilteringLevel.
AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource_name, AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource_value
var (
AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource_name = map[int32]string{
0: "IMAGE_SOURCE_UNSPECIFIED",
1: "ALL_AVAILABLE_SOURCES",
2: "CORPUS_IMAGE_ONLY",
3: "FIGURE_GENERATION_ONLY",
}
AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource_value = map[string]int32{
"IMAGE_SOURCE_UNSPECIFIED": 0,
"ALL_AVAILABLE_SOURCES": 1,
"CORPUS_IMAGE_ONLY": 2,
"FIGURE_GENERATION_ONLY": 3,
}
)Enum value maps for AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_name, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_value
var (
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "ADVERSARIAL_QUERY",
2: "NON_ANSWER_SEEKING_QUERY",
3: "JAIL_BREAKING_QUERY",
4: "NON_ANSWER_SEEKING_QUERY_V2",
5: "USER_DEFINED_CLASSIFICATION_QUERY",
}
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY": 1,
"NON_ANSWER_SEEKING_QUERY": 2,
"JAIL_BREAKING_QUERY": 3,
"NON_ANSWER_SEEKING_QUERY_V2": 4,
"USER_DEFINED_CLASSIFICATION_QUERY": 5,
}
)Enum value maps for AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.
AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType_name, AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType_value
var (
AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType_name = map[int32]string{
0: "MODEL_TYPE_UNSPECIFIED",
1: "SMALL",
2: "LARGE",
}
AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType_value = map[string]int32{
"MODEL_TYPE_UNSPECIFIED": 0,
"SMALL": 1,
"LARGE": 2,
}
)Enum value maps for AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType.
CustomTuningModel_ModelState_name, CustomTuningModel_ModelState_value
var (
CustomTuningModel_ModelState_name = map[int32]string{
0: "MODEL_STATE_UNSPECIFIED",
1: "TRAINING_PAUSED",
2: "TRAINING",
3: "TRAINING_COMPLETE",
4: "READY_FOR_SERVING",
5: "TRAINING_FAILED",
6: "NO_IMPROVEMENT",
7: "INPUT_VALIDATION_FAILED",
}
CustomTuningModel_ModelState_value = map[string]int32{
"MODEL_STATE_UNSPECIFIED": 0,
"TRAINING_PAUSED": 1,
"TRAINING": 2,
"TRAINING_COMPLETE": 3,
"READY_FOR_SERVING": 4,
"TRAINING_FAILED": 5,
"NO_IMPROVEMENT": 6,
"INPUT_VALIDATION_FAILED": 7,
}
)Enum value maps for CustomTuningModel_ModelState.
DataStore_ContentConfig_name, DataStore_ContentConfig_value
var (
DataStore_ContentConfig_name = map[int32]string{
0: "CONTENT_CONFIG_UNSPECIFIED",
1: "NO_CONTENT",
2: "CONTENT_REQUIRED",
3: "PUBLIC_WEBSITE",
4: "GOOGLE_WORKSPACE",
}
DataStore_ContentConfig_value = map[string]int32{
"CONTENT_CONFIG_UNSPECIFIED": 0,
"NO_CONTENT": 1,
"CONTENT_REQUIRED": 2,
"PUBLIC_WEBSITE": 3,
"GOOGLE_WORKSPACE": 4,
}
)Enum value maps for DataStore_ContentConfig.
DataStore_ConfigurableBillingApproach_name, DataStore_ConfigurableBillingApproach_value
var (
DataStore_ConfigurableBillingApproach_name = map[int32]string{
0: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
1: "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE",
2: "CONFIGURABLE_CONSUMPTION_EMBEDDING",
}
DataStore_ConfigurableBillingApproach_value = map[string]int32{
"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED": 0,
"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE": 1,
"CONFIGURABLE_CONSUMPTION_EMBEDDING": 2,
}
)Enum value maps for DataStore_ConfigurableBillingApproach.
DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode_name, DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode_value
var (
DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode_name = map[int32]string{
0: "AUTH_MODE_UNSPECIFIED",
1: "AUTH_MODE_SERVICE_ACCOUNT",
2: "AUTH_MODE_END_USER_ACCOUNT",
}
DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode_value = map[string]int32{
"AUTH_MODE_UNSPECIFIED": 0,
"AUTH_MODE_SERVICE_ACCOUNT": 1,
"AUTH_MODE_END_USER_ACCOUNT": 2,
}
)Enum value maps for DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode.
NaturalLanguageQueryUnderstandingConfig_Mode_name, NaturalLanguageQueryUnderstandingConfig_Mode_value
var (
NaturalLanguageQueryUnderstandingConfig_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "DISABLED",
2: "ENABLED",
}
NaturalLanguageQueryUnderstandingConfig_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"DISABLED": 1,
"ENABLED": 2,
}
)Enum value maps for NaturalLanguageQueryUnderstandingConfig_Mode.
WorkspaceConfig_Type_name, WorkspaceConfig_Type_value
var (
WorkspaceConfig_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "GOOGLE_DRIVE",
2: "GOOGLE_MAIL",
3: "GOOGLE_SITES",
4: "GOOGLE_CALENDAR",
5: "GOOGLE_CHAT",
6: "GOOGLE_GROUPS",
7: "GOOGLE_KEEP",
8: "GOOGLE_PEOPLE",
}
WorkspaceConfig_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"GOOGLE_DRIVE": 1,
"GOOGLE_MAIL": 2,
"GOOGLE_SITES": 3,
"GOOGLE_CALENDAR": 4,
"GOOGLE_CHAT": 5,
"GOOGLE_GROUPS": 6,
"GOOGLE_KEEP": 7,
"GOOGLE_PEOPLE": 8,
}
)Enum value maps for WorkspaceConfig_Type.
BatchGetDocumentsMetadataResponse_State_name, BatchGetDocumentsMetadataResponse_State_value
var (
BatchGetDocumentsMetadataResponse_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "INDEXED",
2: "NOT_IN_TARGET_SITE",
3: "NOT_IN_INDEX",
}
BatchGetDocumentsMetadataResponse_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"INDEXED": 1,
"NOT_IN_TARGET_SITE": 2,
"NOT_IN_INDEX": 3,
}
)Enum value maps for BatchGetDocumentsMetadataResponse_State.
Engine_AppType_name, Engine_AppType_value
var (
Engine_AppType_name = map[int32]string{
0: "APP_TYPE_UNSPECIFIED",
1: "APP_TYPE_INTRANET",
}
Engine_AppType_value = map[string]int32{
"APP_TYPE_UNSPECIFIED": 0,
"APP_TYPE_INTRANET": 1,
}
)Enum value maps for Engine_AppType.
Engine_FeatureState_name, Engine_FeatureState_value
var (
Engine_FeatureState_name = map[int32]string{
0: "FEATURE_STATE_UNSPECIFIED",
1: "FEATURE_STATE_ON",
2: "FEATURE_STATE_OFF",
}
Engine_FeatureState_value = map[string]int32{
"FEATURE_STATE_UNSPECIFIED": 0,
"FEATURE_STATE_ON": 1,
"FEATURE_STATE_OFF": 2,
}
)Enum value maps for Engine_FeatureState.
Engine_ConfigurableBillingApproach_name, Engine_ConfigurableBillingApproach_value
var (
Engine_ConfigurableBillingApproach_name = map[int32]string{
0: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
1: "CONFIGURABLE_BILLING_APPROACH_ENABLED",
}
Engine_ConfigurableBillingApproach_value = map[string]int32{
"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED": 0,
"CONFIGURABLE_BILLING_APPROACH_ENABLED": 1,
}
)Enum value maps for Engine_ConfigurableBillingApproach.
Engine_ModelState_name, Engine_ModelState_value
var (
Engine_ModelState_name = map[int32]string{
0: "MODEL_STATE_UNSPECIFIED",
1: "MODEL_ENABLED",
2: "MODEL_DISABLED",
}
Engine_ModelState_value = map[string]int32{
"MODEL_STATE_UNSPECIFIED": 0,
"MODEL_ENABLED": 1,
"MODEL_DISABLED": 2,
}
)Enum value maps for Engine_ModelState.
Engine_MarketplaceAgentVisibility_name, Engine_MarketplaceAgentVisibility_value
var (
Engine_MarketplaceAgentVisibility_name = map[int32]string{
0: "MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED",
1: "SHOW_AVAILABLE_AGENTS_ONLY",
2: "SHOW_AGENTS_ALREADY_INTEGRATED",
3: "SHOW_AGENTS_ALREADY_PURCHASED",
4: "SHOW_ALL_AGENTS",
}
Engine_MarketplaceAgentVisibility_value = map[string]int32{
"MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED": 0,
"SHOW_AVAILABLE_AGENTS_ONLY": 1,
"SHOW_AGENTS_ALREADY_INTEGRATED": 2,
"SHOW_AGENTS_ALREADY_PURCHASED": 3,
"SHOW_ALL_AGENTS": 4,
}
)Enum value maps for Engine_MarketplaceAgentVisibility.
Engine_MediaRecommendationEngineConfig_TrainingState_name, Engine_MediaRecommendationEngineConfig_TrainingState_value
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.
Evaluation_State_name, Evaluation_State_value
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.
Feedback_FeedbackType_name, Feedback_FeedbackType_value
var (
Feedback_FeedbackType_name = map[int32]string{
0: "FEEDBACK_TYPE_UNSPECIFIED",
1: "LIKE",
2: "DISLIKE",
}
Feedback_FeedbackType_value = map[string]int32{
"FEEDBACK_TYPE_UNSPECIFIED": 0,
"LIKE": 1,
"DISLIKE": 2,
}
)Enum value maps for Feedback_FeedbackType.
Feedback_Reason_name, Feedback_Reason_value
var (
Feedback_Reason_name = map[int32]string{
0: "REASON_UNSPECIFIED",
1: "INACCURATE_RESPONSE",
2: "NOT_RELEVANT",
3: "INCOMPREHENSIVE",
4: "OFFENSIVE_OR_UNSAFE",
6: "FORMAT_AND_STYLES",
7: "BAD_CITATION",
8: "CANVAS_NOT_GENERATED",
9: "CANVAS_QUALITY_BAD",
10: "CANVAS_EXPORT_FAILED",
}
Feedback_Reason_value = map[string]int32{
"REASON_UNSPECIFIED": 0,
"INACCURATE_RESPONSE": 1,
"NOT_RELEVANT": 2,
"INCOMPREHENSIVE": 3,
"OFFENSIVE_OR_UNSAFE": 4,
"FORMAT_AND_STYLES": 6,
"BAD_CITATION": 7,
"CANVAS_NOT_GENERATED": 8,
"CANVAS_QUALITY_BAD": 9,
"CANVAS_EXPORT_FAILED": 10,
}
)Enum value maps for Feedback_Reason.
Feedback_FeedbackSource_name, Feedback_FeedbackSource_value
var (
Feedback_FeedbackSource_name = map[int32]string{
0: "FEEDBACK_SOURCE_UNSPECIFIED",
1: "GOOGLE_CONSOLE",
2: "GOOGLE_WIDGET",
3: "GOOGLE_WEBAPP",
4: "GOOGLE_AGENTSPACE_MOBILE",
}
Feedback_FeedbackSource_value = map[string]int32{
"FEEDBACK_SOURCE_UNSPECIFIED": 0,
"GOOGLE_CONSOLE": 1,
"GOOGLE_WIDGET": 2,
"GOOGLE_WEBAPP": 3,
"GOOGLE_AGENTSPACE_MOBILE": 4,
}
)Enum value maps for Feedback_FeedbackSource.
GenerateGroundedContentRequest_GenerationSpec_ProvisionedThroughputSetting_name, GenerateGroundedContentRequest_GenerationSpec_ProvisionedThroughputSetting_value
var (
GenerateGroundedContentRequest_GenerationSpec_ProvisionedThroughputSetting_name = map[int32]string{
0: "PROVISIONED_THROUGHPUT_SETTING_UNSPECIFIED",
1: "PROVISIONED_THROUGHPUT_ONLY",
2: "PAY_AS_YOU_GO_ONLY",
}
GenerateGroundedContentRequest_GenerationSpec_ProvisionedThroughputSetting_value = map[string]int32{
"PROVISIONED_THROUGHPUT_SETTING_UNSPECIFIED": 0,
"PROVISIONED_THROUGHPUT_ONLY": 1,
"PAY_AS_YOU_GO_ONLY": 2,
}
)Enum value maps for GenerateGroundedContentRequest_GenerationSpec_ProvisionedThroughputSetting.
GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version_name, GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version_value
var (
GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version_name = map[int32]string{
0: "VERSION_UNSPECIFIED",
1: "V1_INDEPENDENT",
}
GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version_value = map[string]int32{
"VERSION_UNSPECIFIED": 0,
"V1_INDEPENDENT": 1,
}
)Enum value maps for GenerateGroundedContentRequest_DynamicRetrievalConfiguration_DynamicRetrievalPredictor_Version.
GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source_name, GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source_value
var (
GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source_name = map[int32]string{
0: "SOURCE_UNSPECIFIED",
1: "VERTEX_AI_SEARCH",
3: "GOOGLE_SEARCH",
2: "INLINE_CONTENT",
4: "GOOGLE_MAPS",
}
GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source_value = map[string]int32{
"SOURCE_UNSPECIFIED": 0,
"VERTEX_AI_SEARCH": 1,
"GOOGLE_SEARCH": 3,
"INLINE_CONTENT": 2,
"GOOGLE_MAPS": 4,
}
)Enum value maps for GenerateGroundedContentResponse_Candidate_GroundingMetadata_RetrievalMetadata_Source.
GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version_name, GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version_value
var (
GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version_name = map[int32]string{
0: "VERSION_UNSPECIFIED",
1: "V1_INDEPENDENT",
}
GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version_value = map[string]int32{
"VERSION_UNSPECIFIED": 0,
"V1_INDEPENDENT": 1,
}
)Enum value maps for GenerateGroundedContentResponse_Candidate_GroundingMetadata_DynamicRetrievalPredictorMetadata_Version.
Citation_PhishBlockThreshold_name, Citation_PhishBlockThreshold_value
var (
Citation_PhishBlockThreshold_name = map[int32]string{
0: "PHISH_BLOCK_THRESHOLD_UNSPECIFIED",
30: "BLOCK_LOW_AND_ABOVE",
40: "BLOCK_MEDIUM_AND_ABOVE",
50: "BLOCK_HIGH_AND_ABOVE",
55: "BLOCK_HIGHER_AND_ABOVE",
60: "BLOCK_VERY_HIGH_AND_ABOVE",
100: "BLOCK_ONLY_EXTREMELY_HIGH",
}
Citation_PhishBlockThreshold_value = map[string]int32{
"PHISH_BLOCK_THRESHOLD_UNSPECIFIED": 0,
"BLOCK_LOW_AND_ABOVE": 30,
"BLOCK_MEDIUM_AND_ABOVE": 40,
"BLOCK_HIGH_AND_ABOVE": 50,
"BLOCK_HIGHER_AND_ABOVE": 55,
"BLOCK_VERY_HIGH_AND_ABOVE": 60,
"BLOCK_ONLY_EXTREMELY_HIGH": 100,
}
)Enum value maps for Citation_PhishBlockThreshold.
BigtableOptions_Type_name, BigtableOptions_Type_value
var (
BigtableOptions_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "STRING",
2: "NUMBER",
3: "INTEGER",
4: "VAR_INTEGER",
5: "BIG_NUMERIC",
6: "BOOLEAN",
7: "JSON",
}
BigtableOptions_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"STRING": 1,
"NUMBER": 2,
"INTEGER": 3,
"VAR_INTEGER": 4,
"BIG_NUMERIC": 5,
"BOOLEAN": 6,
"JSON": 7,
}
)Enum value maps for BigtableOptions_Type.
BigtableOptions_Encoding_name, BigtableOptions_Encoding_value
var (
BigtableOptions_Encoding_name = map[int32]string{
0: "ENCODING_UNSPECIFIED",
1: "TEXT",
2: "BINARY",
}
BigtableOptions_Encoding_value = map[string]int32{
"ENCODING_UNSPECIFIED": 0,
"TEXT": 1,
"BINARY": 2,
}
)Enum value maps for BigtableOptions_Encoding.
ImportDocumentsRequest_ReconciliationMode_name, ImportDocumentsRequest_ReconciliationMode_value
var (
ImportDocumentsRequest_ReconciliationMode_name = map[int32]string{
0: "RECONCILIATION_MODE_UNSPECIFIED",
1: "INCREMENTAL",
2: "FULL",
}
ImportDocumentsRequest_ReconciliationMode_value = map[string]int32{
"RECONCILIATION_MODE_UNSPECIFIED": 0,
"INCREMENTAL": 1,
"FULL": 2,
}
)Enum value maps for ImportDocumentsRequest_ReconciliationMode.
LicenseConfig_State_name, LicenseConfig_State_value
var (
LicenseConfig_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "EXPIRED",
3: "NOT_STARTED",
4: "WITHDRAWN",
5: "DEACTIVATING",
}
LicenseConfig_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"EXPIRED": 2,
"NOT_STARTED": 3,
"WITHDRAWN": 4,
"DEACTIVATING": 5,
}
)Enum value maps for LicenseConfig_State.
Project_ServiceTerms_State_name, Project_ServiceTerms_State_value
var (
Project_ServiceTerms_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "TERMS_ACCEPTED",
2: "TERMS_PENDING",
3: "TERMS_DECLINED",
}
Project_ServiceTerms_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"TERMS_ACCEPTED": 1,
"TERMS_PENDING": 2,
"TERMS_DECLINED": 3,
}
)Enum value maps for Project_ServiceTerms_State.
Project_ConfigurableBillingStatus_UpdateType_name, Project_ConfigurableBillingStatus_UpdateType_value
var (
Project_ConfigurableBillingStatus_UpdateType_name = map[int32]string{
0: "UPDATE_TYPE_UNSPECIFIED",
1: "CREATE",
2: "DELETE",
3: "SCALE_UP",
4: "SCALE_DOWN",
}
Project_ConfigurableBillingStatus_UpdateType_value = map[string]int32{
"UPDATE_TYPE_UNSPECIFIED": 0,
"CREATE": 1,
"DELETE": 2,
"SCALE_UP": 3,
"SCALE_DOWN": 4,
}
)Enum value maps for Project_ConfigurableBillingStatus_UpdateType.
HarmCategory_name, HarmCategory_value
var (
HarmCategory_name = map[int32]string{
0: "HARM_CATEGORY_UNSPECIFIED",
1: "HARM_CATEGORY_HATE_SPEECH",
2: "HARM_CATEGORY_DANGEROUS_CONTENT",
3: "HARM_CATEGORY_HARASSMENT",
4: "HARM_CATEGORY_SEXUALLY_EXPLICIT",
5: "HARM_CATEGORY_CIVIC_INTEGRITY",
}
HarmCategory_value = map[string]int32{
"HARM_CATEGORY_UNSPECIFIED": 0,
"HARM_CATEGORY_HATE_SPEECH": 1,
"HARM_CATEGORY_DANGEROUS_CONTENT": 2,
"HARM_CATEGORY_HARASSMENT": 3,
"HARM_CATEGORY_SEXUALLY_EXPLICIT": 4,
"HARM_CATEGORY_CIVIC_INTEGRITY": 5,
}
)Enum value maps for HarmCategory.
SafetyRating_HarmProbability_name, SafetyRating_HarmProbability_value
var (
SafetyRating_HarmProbability_name = map[int32]string{
0: "HARM_PROBABILITY_UNSPECIFIED",
1: "NEGLIGIBLE",
2: "LOW",
3: "MEDIUM",
4: "HIGH",
}
SafetyRating_HarmProbability_value = map[string]int32{
"HARM_PROBABILITY_UNSPECIFIED": 0,
"NEGLIGIBLE": 1,
"LOW": 2,
"MEDIUM": 3,
"HIGH": 4,
}
)Enum value maps for SafetyRating_HarmProbability.
SafetyRating_HarmSeverity_name, SafetyRating_HarmSeverity_value
var (
SafetyRating_HarmSeverity_name = map[int32]string{
0: "HARM_SEVERITY_UNSPECIFIED",
1: "HARM_SEVERITY_NEGLIGIBLE",
2: "HARM_SEVERITY_LOW",
3: "HARM_SEVERITY_MEDIUM",
4: "HARM_SEVERITY_HIGH",
}
SafetyRating_HarmSeverity_value = map[string]int32{
"HARM_SEVERITY_UNSPECIFIED": 0,
"HARM_SEVERITY_NEGLIGIBLE": 1,
"HARM_SEVERITY_LOW": 2,
"HARM_SEVERITY_MEDIUM": 3,
"HARM_SEVERITY_HIGH": 4,
}
)Enum value maps for SafetyRating_HarmSeverity.
SearchRequest_RankingExpressionBackend_name, SearchRequest_RankingExpressionBackend_value
var (
SearchRequest_RankingExpressionBackend_name = map[int32]string{
0: "RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
1: "BYOE",
2: "CLEARBOX",
3: "RANK_BY_EMBEDDING",
4: "RANK_BY_FORMULA",
}
SearchRequest_RankingExpressionBackend_value = map[string]int32{
"RANKING_EXPRESSION_BACKEND_UNSPECIFIED": 0,
"BYOE": 1,
"CLEARBOX": 2,
"RANK_BY_EMBEDDING": 3,
"RANK_BY_FORMULA": 4,
}
)Enum value maps for SearchRequest_RankingExpressionBackend.
SearchRequest_RelevanceThreshold_name, SearchRequest_RelevanceThreshold_value
var (
SearchRequest_RelevanceThreshold_name = map[int32]string{
0: "RELEVANCE_THRESHOLD_UNSPECIFIED",
1: "LOWEST",
2: "LOW",
3: "MEDIUM",
4: "HIGH",
}
SearchRequest_RelevanceThreshold_value = map[string]int32{
"RELEVANCE_THRESHOLD_UNSPECIFIED": 0,
"LOWEST": 1,
"LOW": 2,
"MEDIUM": 3,
"HIGH": 4,
}
)Enum value maps for SearchRequest_RelevanceThreshold.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_name, SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_value
var (
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_name = map[int32]string{
0: "ATTRIBUTE_TYPE_UNSPECIFIED",
1: "NUMERICAL",
2: "FRESHNESS",
}
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_value = map[string]int32{
"ATTRIBUTE_TYPE_UNSPECIFIED": 0,
"NUMERICAL": 1,
"FRESHNESS": 2,
}
)Enum value maps for SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_name, SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_value
var (
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_name = map[int32]string{
0: "INTERPOLATION_TYPE_UNSPECIFIED",
1: "LINEAR",
}
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_value = map[string]int32{
"INTERPOLATION_TYPE_UNSPECIFIED": 0,
"LINEAR": 1,
}
)Enum value maps for SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType.
SearchRequest_QueryExpansionSpec_Condition_name, SearchRequest_QueryExpansionSpec_Condition_value
var (
SearchRequest_QueryExpansionSpec_Condition_name = map[int32]string{
0: "CONDITION_UNSPECIFIED",
1: "DISABLED",
2: "AUTO",
}
SearchRequest_QueryExpansionSpec_Condition_value = map[string]int32{
"CONDITION_UNSPECIFIED": 0,
"DISABLED": 1,
"AUTO": 2,
}
)Enum value maps for SearchRequest_QueryExpansionSpec_Condition.
SearchRequest_SpellCorrectionSpec_Mode_name, SearchRequest_SpellCorrectionSpec_Mode_value
var (
SearchRequest_SpellCorrectionSpec_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "SUGGESTION_ONLY",
2: "AUTO",
}
SearchRequest_SpellCorrectionSpec_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"SUGGESTION_ONLY": 1,
"AUTO": 2,
}
)Enum value maps for SearchRequest_SpellCorrectionSpec_Mode.
SearchRequest_ContentSearchSpec_SearchResultMode_name, SearchRequest_ContentSearchSpec_SearchResultMode_value
var (
SearchRequest_ContentSearchSpec_SearchResultMode_name = map[int32]string{
0: "SEARCH_RESULT_MODE_UNSPECIFIED",
1: "DOCUMENTS",
2: "CHUNKS",
}
SearchRequest_ContentSearchSpec_SearchResultMode_value = map[string]int32{
"SEARCH_RESULT_MODE_UNSPECIFIED": 0,
"DOCUMENTS": 1,
"CHUNKS": 2,
}
)Enum value maps for SearchRequest_ContentSearchSpec_SearchResultMode.
SearchRequest_ContentSearchSpec_SummarySpec_MultiModalSpec_ImageSource_name, SearchRequest_ContentSearchSpec_SummarySpec_MultiModalSpec_ImageSource_value
var (
SearchRequest_ContentSearchSpec_SummarySpec_MultiModalSpec_ImageSource_name = map[int32]string{
0: "IMAGE_SOURCE_UNSPECIFIED",
1: "ALL_AVAILABLE_SOURCES",
2: "CORPUS_IMAGE_ONLY",
3: "FIGURE_GENERATION_ONLY",
}
SearchRequest_ContentSearchSpec_SummarySpec_MultiModalSpec_ImageSource_value = map[string]int32{
"IMAGE_SOURCE_UNSPECIFIED": 0,
"ALL_AVAILABLE_SOURCES": 1,
"CORPUS_IMAGE_ONLY": 2,
"FIGURE_GENERATION_ONLY": 3,
}
)Enum value maps for SearchRequest_ContentSearchSpec_SummarySpec_MultiModalSpec_ImageSource.
SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_name, SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_value
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.
SearchRequest_NaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_name, SearchRequest_NaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_value
var (
SearchRequest_NaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_name = map[int32]string{
0: "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED",
1: "HARD_FILTER",
2: "SOFT_BOOST",
}
SearchRequest_NaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_value = map[string]int32{
"EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED": 0,
"HARD_FILTER": 1,
"SOFT_BOOST": 2,
}
)Enum value maps for SearchRequest_NaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior.
SearchRequest_SearchAsYouTypeSpec_Condition_name, SearchRequest_SearchAsYouTypeSpec_Condition_value
var (
SearchRequest_SearchAsYouTypeSpec_Condition_name = map[int32]string{
0: "CONDITION_UNSPECIFIED",
1: "DISABLED",
2: "ENABLED",
3: "AUTO",
}
SearchRequest_SearchAsYouTypeSpec_Condition_value = map[string]int32{
"CONDITION_UNSPECIFIED": 0,
"DISABLED": 1,
"ENABLED": 2,
"AUTO": 3,
}
)Enum value maps for SearchRequest_SearchAsYouTypeSpec_Condition.
SearchRequest_DisplaySpec_MatchHighlightingCondition_name, SearchRequest_DisplaySpec_MatchHighlightingCondition_value
var (
SearchRequest_DisplaySpec_MatchHighlightingCondition_name = map[int32]string{
0: "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
1: "MATCH_HIGHLIGHTING_DISABLED",
2: "MATCH_HIGHLIGHTING_ENABLED",
}
SearchRequest_DisplaySpec_MatchHighlightingCondition_value = map[string]int32{
"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED": 0,
"MATCH_HIGHLIGHTING_DISABLED": 1,
"MATCH_HIGHLIGHTING_ENABLED": 2,
}
)Enum value maps for SearchRequest_DisplaySpec_MatchHighlightingCondition.
SearchRequest_CrowdingSpec_Mode_name, SearchRequest_CrowdingSpec_Mode_value
var (
SearchRequest_CrowdingSpec_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "DROP_CROWDED_RESULTS",
2: "DEMOTE_CROWDED_RESULTS_TO_END",
}
SearchRequest_CrowdingSpec_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"DROP_CROWDED_RESULTS": 1,
"DEMOTE_CROWDED_RESULTS_TO_END": 2,
}
)Enum value maps for SearchRequest_CrowdingSpec_Mode.
SearchRequest_PersonalizationSpec_Mode_name, SearchRequest_PersonalizationSpec_Mode_value
var (
SearchRequest_PersonalizationSpec_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "AUTO",
2: "DISABLED",
}
SearchRequest_PersonalizationSpec_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"AUTO": 1,
"DISABLED": 2,
}
)Enum value maps for SearchRequest_PersonalizationSpec_Mode.
SearchResponse_SemanticState_name, SearchResponse_SemanticState_value
var (
SearchResponse_SemanticState_name = map[int32]string{
0: "SEMANTIC_STATE_UNSPECIFIED",
1: "DISABLED",
2: "ENABLED",
}
SearchResponse_SemanticState_value = map[string]int32{
"SEMANTIC_STATE_UNSPECIFIED": 0,
"DISABLED": 1,
"ENABLED": 2,
}
)Enum value maps for SearchResponse_SemanticState.
SearchResponse_Summary_SummarySkippedReason_name, SearchResponse_Summary_SummarySkippedReason_value
var (
SearchResponse_Summary_SummarySkippedReason_name = map[int32]string{
0: "SUMMARY_SKIPPED_REASON_UNSPECIFIED",
1: "ADVERSARIAL_QUERY_IGNORED",
2: "NON_SUMMARY_SEEKING_QUERY_IGNORED",
3: "OUT_OF_DOMAIN_QUERY_IGNORED",
4: "POTENTIAL_POLICY_VIOLATION",
5: "LLM_ADDON_NOT_ENABLED",
6: "NO_RELEVANT_CONTENT",
7: "JAIL_BREAKING_QUERY_IGNORED",
8: "CUSTOMER_POLICY_VIOLATION",
9: "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2",
10: "TIME_OUT",
}
SearchResponse_Summary_SummarySkippedReason_value = map[string]int32{
"SUMMARY_SKIPPED_REASON_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY_IGNORED": 1,
"NON_SUMMARY_SEEKING_QUERY_IGNORED": 2,
"OUT_OF_DOMAIN_QUERY_IGNORED": 3,
"POTENTIAL_POLICY_VIOLATION": 4,
"LLM_ADDON_NOT_ENABLED": 5,
"NO_RELEVANT_CONTENT": 6,
"JAIL_BREAKING_QUERY_IGNORED": 7,
"CUSTOMER_POLICY_VIOLATION": 8,
"NON_SUMMARY_SEEKING_QUERY_IGNORED_V2": 9,
"TIME_OUT": 10,
}
)Enum value maps for SearchResponse_Summary_SummarySkippedReason.
SearchResponse_Summary_BlobAttachment_AttributionType_name, SearchResponse_Summary_BlobAttachment_AttributionType_value
var (
SearchResponse_Summary_BlobAttachment_AttributionType_name = map[int32]string{
0: "ATTRIBUTION_TYPE_UNSPECIFIED",
1: "CORPUS",
2: "GENERATED",
}
SearchResponse_Summary_BlobAttachment_AttributionType_value = map[string]int32{
"ATTRIBUTION_TYPE_UNSPECIFIED": 0,
"CORPUS": 1,
"GENERATED": 2,
}
)Enum value maps for SearchResponse_Summary_BlobAttachment_AttributionType.
SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison_name, SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison_value
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.
SearchResponse_OneBoxResult_OneBoxType_name, SearchResponse_OneBoxResult_OneBoxType_value
var (
SearchResponse_OneBoxResult_OneBoxType_name = map[int32]string{
0: "ONE_BOX_TYPE_UNSPECIFIED",
1: "PEOPLE",
2: "ORGANIZATION",
3: "SLACK",
4: "KNOWLEDGE_GRAPH",
}
SearchResponse_OneBoxResult_OneBoxType_value = map[string]int32{
"ONE_BOX_TYPE_UNSPECIFIED": 0,
"PEOPLE": 1,
"ORGANIZATION": 2,
"SLACK": 3,
"KNOWLEDGE_GRAPH": 4,
}
)Enum value maps for SearchResponse_OneBoxResult_OneBoxType.
Session_State_name, Session_State_value
var (
Session_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "IN_PROGRESS",
}
Session_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"IN_PROGRESS": 1,
}
)Enum value maps for Session_State.
TargetSite_Type_name, TargetSite_Type_value
var (
TargetSite_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "INCLUDE",
2: "EXCLUDE",
}
TargetSite_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"INCLUDE": 1,
"EXCLUDE": 2,
}
)Enum value maps for TargetSite_Type.
TargetSite_IndexingStatus_name, TargetSite_IndexingStatus_value
var (
TargetSite_IndexingStatus_name = map[int32]string{
0: "INDEXING_STATUS_UNSPECIFIED",
1: "PENDING",
2: "FAILED",
3: "SUCCEEDED",
4: "DELETING",
5: "CANCELLABLE",
6: "CANCELLED",
}
TargetSite_IndexingStatus_value = map[string]int32{
"INDEXING_STATUS_UNSPECIFIED": 0,
"PENDING": 1,
"FAILED": 2,
"SUCCEEDED": 3,
"DELETING": 4,
"CANCELLABLE": 5,
"CANCELLED": 6,
}
)Enum value maps for TargetSite_IndexingStatus.
SiteVerificationInfo_SiteVerificationState_name, SiteVerificationInfo_SiteVerificationState_value
var (
SiteVerificationInfo_SiteVerificationState_name = map[int32]string{
0: "SITE_VERIFICATION_STATE_UNSPECIFIED",
1: "VERIFIED",
2: "UNVERIFIED",
3: "EXEMPTED",
}
SiteVerificationInfo_SiteVerificationState_value = map[string]int32{
"SITE_VERIFICATION_STATE_UNSPECIFIED": 0,
"VERIFIED": 1,
"UNVERIFIED": 2,
"EXEMPTED": 3,
}
)Enum value maps for SiteVerificationInfo_SiteVerificationState.
RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_name, RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_value
var (
RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_name = map[int32]string{
0: "CORPUS_TYPE_UNSPECIFIED",
1: "DESKTOP",
2: "MOBILE",
}
RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_value = map[string]int32{
"CORPUS_TYPE_UNSPECIFIED": 0,
"DESKTOP": 1,
"MOBILE": 2,
}
)Enum value maps for RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType.
UserLicense_LicenseAssignmentState_name, UserLicense_LicenseAssignmentState_value
var (
UserLicense_LicenseAssignmentState_name = map[int32]string{
0: "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
1: "ASSIGNED",
2: "UNASSIGNED",
3: "NO_LICENSE",
4: "NO_LICENSE_ATTEMPTED_LOGIN",
5: "BLOCKED",
}
UserLicense_LicenseAssignmentState_value = map[string]int32{
"LICENSE_ASSIGNMENT_STATE_UNSPECIFIED": 0,
"ASSIGNED": 1,
"UNASSIGNED": 2,
"NO_LICENSE": 3,
"NO_LICENSE_ATTEMPTED_LOGIN": 4,
"BLOCKED": 5,
}
)Enum value maps for UserLicense_LicenseAssignmentState.
AclConfigService_ServiceDesc
var AclConfigService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.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/v1beta/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)
AssistantService_ServiceDesc
var AssistantService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.AssistantService",
HandlerType: (*AssistantServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateAssistant",
Handler: _AssistantService_CreateAssistant_Handler,
},
{
MethodName: "DeleteAssistant",
Handler: _AssistantService_DeleteAssistant_Handler,
},
{
MethodName: "UpdateAssistant",
Handler: _AssistantService_UpdateAssistant_Handler,
},
{
MethodName: "GetAssistant",
Handler: _AssistantService_GetAssistant_Handler,
},
{
MethodName: "ListAssistants",
Handler: _AssistantService_ListAssistants_Handler,
},
},
Streams: []grpc.StreamDesc{
{
StreamName: "StreamAssist",
Handler: _AssistantService_StreamAssist_Handler,
ServerStreams: true,
},
},
Metadata: "google/cloud/discoveryengine/v1beta/assistant_service.proto",
}AssistantService_ServiceDesc is the grpc.ServiceDesc for AssistantService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
CmekConfigService_ServiceDesc
var CmekConfigService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.CmekConfigService",
HandlerType: (*CmekConfigServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "UpdateCmekConfig",
Handler: _CmekConfigService_UpdateCmekConfig_Handler,
},
{
MethodName: "GetCmekConfig",
Handler: _CmekConfigService_GetCmekConfig_Handler,
},
{
MethodName: "ListCmekConfigs",
Handler: _CmekConfigService_ListCmekConfigs_Handler,
},
{
MethodName: "DeleteCmekConfig",
Handler: _CmekConfigService_DeleteCmekConfig_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/cmek_config_service.proto",
}CmekConfigService_ServiceDesc is the grpc.ServiceDesc for CmekConfigService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
CompletionService_ServiceDesc
var CompletionService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.CompletionService",
HandlerType: (*CompletionServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CompleteQuery",
Handler: _CompletionService_CompleteQuery_Handler,
},
{
MethodName: "AdvancedCompleteQuery",
Handler: _CompletionService_AdvancedCompleteQuery_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,
},
{
MethodName: "RemoveSuggestion",
Handler: _CompletionService_RemoveSuggestion_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/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)
ControlService_ServiceDesc
var ControlService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.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/v1beta/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)
ConversationalSearchService_ServiceDesc
var ConversationalSearchService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.ConversationalSearchService",
HandlerType: (*ConversationalSearchServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ConverseConversation",
Handler: _ConversationalSearchService_ConverseConversation_Handler,
},
{
MethodName: "CreateConversation",
Handler: _ConversationalSearchService_CreateConversation_Handler,
},
{
MethodName: "DeleteConversation",
Handler: _ConversationalSearchService_DeleteConversation_Handler,
},
{
MethodName: "UpdateConversation",
Handler: _ConversationalSearchService_UpdateConversation_Handler,
},
{
MethodName: "GetConversation",
Handler: _ConversationalSearchService_GetConversation_Handler,
},
{
MethodName: "ListConversations",
Handler: _ConversationalSearchService_ListConversations_Handler,
},
{
MethodName: "AnswerQuery",
Handler: _ConversationalSearchService_AnswerQuery_Handler,
},
{
MethodName: "GetAnswer",
Handler: _ConversationalSearchService_GetAnswer_Handler,
},
{
MethodName: "CreateSession",
Handler: _ConversationalSearchService_CreateSession_Handler,
},
{
MethodName: "DeleteSession",
Handler: _ConversationalSearchService_DeleteSession_Handler,
},
{
MethodName: "UpdateSession",
Handler: _ConversationalSearchService_UpdateSession_Handler,
},
{
MethodName: "GetSession",
Handler: _ConversationalSearchService_GetSession_Handler,
},
{
MethodName: "ListSessions",
Handler: _ConversationalSearchService_ListSessions_Handler,
},
},
Streams: []grpc.StreamDesc{
{
StreamName: "StreamAnswerQuery",
Handler: _ConversationalSearchService_StreamAnswerQuery_Handler,
ServerStreams: true,
},
},
Metadata: "google/cloud/discoveryengine/v1beta/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)
DataStoreService_ServiceDesc
var DataStoreService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.DataStoreService",
HandlerType: (*DataStoreServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateDataStore",
Handler: _DataStoreService_CreateDataStore_Handler,
},
{
MethodName: "GetDataStore",
Handler: _DataStoreService_GetDataStore_Handler,
},
{
MethodName: "ListDataStores",
Handler: _DataStoreService_ListDataStores_Handler,
},
{
MethodName: "DeleteDataStore",
Handler: _DataStoreService_DeleteDataStore_Handler,
},
{
MethodName: "UpdateDataStore",
Handler: _DataStoreService_UpdateDataStore_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/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)
DocumentService_ServiceDesc
var DocumentService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.DocumentService",
HandlerType: (*DocumentServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetDocument",
Handler: _DocumentService_GetDocument_Handler,
},
{
MethodName: "ListDocuments",
Handler: _DocumentService_ListDocuments_Handler,
},
{
MethodName: "CreateDocument",
Handler: _DocumentService_CreateDocument_Handler,
},
{
MethodName: "UpdateDocument",
Handler: _DocumentService_UpdateDocument_Handler,
},
{
MethodName: "DeleteDocument",
Handler: _DocumentService_DeleteDocument_Handler,
},
{
MethodName: "ImportDocuments",
Handler: _DocumentService_ImportDocuments_Handler,
},
{
MethodName: "PurgeDocuments",
Handler: _DocumentService_PurgeDocuments_Handler,
},
{
MethodName: "BatchGetDocumentsMetadata",
Handler: _DocumentService_BatchGetDocumentsMetadata_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/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)
EngineService_ServiceDesc
var EngineService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.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,
},
{
MethodName: "GetIamPolicy",
Handler: _EngineService_GetIamPolicy_Handler,
},
{
MethodName: "SetIamPolicy",
Handler: _EngineService_SetIamPolicy_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/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)
EvaluationService_ServiceDesc
var EvaluationService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.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/v1beta/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)
File_google_cloud_discoveryengine_v1beta_acl_config_proto
var File_google_cloud_discoveryengine_v1beta_acl_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_acl_config_service_proto
var File_google_cloud_discoveryengine_v1beta_acl_config_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_agent_gateway_setting_proto
var File_google_cloud_discoveryengine_v1beta_agent_gateway_setting_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_answer_proto
var File_google_cloud_discoveryengine_v1beta_answer_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_assist_answer_proto
var File_google_cloud_discoveryengine_v1beta_assist_answer_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_assistant_proto
var File_google_cloud_discoveryengine_v1beta_assistant_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_assistant_service_proto
var File_google_cloud_discoveryengine_v1beta_assistant_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_chunk_proto
var File_google_cloud_discoveryengine_v1beta_chunk_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_cmek_config_service_proto
var File_google_cloud_discoveryengine_v1beta_cmek_config_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_common_proto
var File_google_cloud_discoveryengine_v1beta_common_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_completion_proto
var File_google_cloud_discoveryengine_v1beta_completion_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_completion_service_proto
var File_google_cloud_discoveryengine_v1beta_completion_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_control_proto
var File_google_cloud_discoveryengine_v1beta_control_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_control_service_proto
var File_google_cloud_discoveryengine_v1beta_control_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_conversation_proto
var File_google_cloud_discoveryengine_v1beta_conversation_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_conversational_search_service_proto
var File_google_cloud_discoveryengine_v1beta_conversational_search_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_custom_tuning_model_proto
var File_google_cloud_discoveryengine_v1beta_custom_tuning_model_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_data_store_proto
var File_google_cloud_discoveryengine_v1beta_data_store_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_data_store_service_proto
var File_google_cloud_discoveryengine_v1beta_data_store_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_document_processing_config_proto
var File_google_cloud_discoveryengine_v1beta_document_processing_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_document_proto
var File_google_cloud_discoveryengine_v1beta_document_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_document_service_proto
var File_google_cloud_discoveryengine_v1beta_document_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_engine_proto
var File_google_cloud_discoveryengine_v1beta_engine_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_engine_service_proto
var File_google_cloud_discoveryengine_v1beta_engine_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_evaluation_proto
var File_google_cloud_discoveryengine_v1beta_evaluation_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_evaluation_service_proto
var File_google_cloud_discoveryengine_v1beta_evaluation_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_feedback_proto
var File_google_cloud_discoveryengine_v1beta_feedback_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_grounded_generation_service_proto
var File_google_cloud_discoveryengine_v1beta_grounded_generation_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_grounding_proto
var File_google_cloud_discoveryengine_v1beta_grounding_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_identity_mapping_store_proto
var File_google_cloud_discoveryengine_v1beta_identity_mapping_store_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_identity_mapping_store_service_proto
var File_google_cloud_discoveryengine_v1beta_identity_mapping_store_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_import_config_proto
var File_google_cloud_discoveryengine_v1beta_import_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_license_config_proto
var File_google_cloud_discoveryengine_v1beta_license_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_license_config_service_proto
var File_google_cloud_discoveryengine_v1beta_license_config_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_logging_proto
var File_google_cloud_discoveryengine_v1beta_logging_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_project_proto
var File_google_cloud_discoveryengine_v1beta_project_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_project_service_proto
var File_google_cloud_discoveryengine_v1beta_project_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_purge_config_proto
var File_google_cloud_discoveryengine_v1beta_purge_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_rank_service_proto
var File_google_cloud_discoveryengine_v1beta_rank_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_recommendation_service_proto
var File_google_cloud_discoveryengine_v1beta_recommendation_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_safety_proto
var File_google_cloud_discoveryengine_v1beta_safety_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_sample_query_proto
var File_google_cloud_discoveryengine_v1beta_sample_query_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_sample_query_service_proto
var File_google_cloud_discoveryengine_v1beta_sample_query_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_sample_query_set_proto
var File_google_cloud_discoveryengine_v1beta_sample_query_set_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_sample_query_set_service_proto
var File_google_cloud_discoveryengine_v1beta_sample_query_set_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_schema_proto
var File_google_cloud_discoveryengine_v1beta_schema_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_schema_service_proto
var File_google_cloud_discoveryengine_v1beta_schema_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_search_service_proto
var File_google_cloud_discoveryengine_v1beta_search_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_search_tuning_service_proto
var File_google_cloud_discoveryengine_v1beta_search_tuning_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_serving_config_proto
var File_google_cloud_discoveryengine_v1beta_serving_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_serving_config_service_proto
var File_google_cloud_discoveryengine_v1beta_serving_config_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_session_proto
var File_google_cloud_discoveryengine_v1beta_session_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_session_service_proto
var File_google_cloud_discoveryengine_v1beta_session_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_site_search_engine_proto
var File_google_cloud_discoveryengine_v1beta_site_search_engine_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_site_search_engine_service_proto
var File_google_cloud_discoveryengine_v1beta_site_search_engine_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_user_event_proto
var File_google_cloud_discoveryengine_v1beta_user_event_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_user_event_service_proto
var File_google_cloud_discoveryengine_v1beta_user_event_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_user_license_proto
var File_google_cloud_discoveryengine_v1beta_user_license_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_user_license_service_proto
var File_google_cloud_discoveryengine_v1beta_user_license_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_user_store_proto
var File_google_cloud_discoveryengine_v1beta_user_store_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1beta_user_store_service_proto
var File_google_cloud_discoveryengine_v1beta_user_store_service_proto protoreflect.FileDescriptorGroundedGenerationService_ServiceDesc
var GroundedGenerationService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.GroundedGenerationService",
HandlerType: (*GroundedGenerationServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GenerateGroundedContent",
Handler: _GroundedGenerationService_GenerateGroundedContent_Handler,
},
{
MethodName: "CheckGrounding",
Handler: _GroundedGenerationService_CheckGrounding_Handler,
},
},
Streams: []grpc.StreamDesc{
{
StreamName: "StreamGenerateGroundedContent",
Handler: _GroundedGenerationService_StreamGenerateGroundedContent_Handler,
ServerStreams: true,
ClientStreams: true,
},
},
Metadata: "google/cloud/discoveryengine/v1beta/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)
IdentityMappingStoreService_ServiceDesc
var IdentityMappingStoreService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.IdentityMappingStoreService",
HandlerType: (*IdentityMappingStoreServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateIdentityMappingStore",
Handler: _IdentityMappingStoreService_CreateIdentityMappingStore_Handler,
},
{
MethodName: "GetIdentityMappingStore",
Handler: _IdentityMappingStoreService_GetIdentityMappingStore_Handler,
},
{
MethodName: "DeleteIdentityMappingStore",
Handler: _IdentityMappingStoreService_DeleteIdentityMappingStore_Handler,
},
{
MethodName: "ImportIdentityMappings",
Handler: _IdentityMappingStoreService_ImportIdentityMappings_Handler,
},
{
MethodName: "PurgeIdentityMappings",
Handler: _IdentityMappingStoreService_PurgeIdentityMappings_Handler,
},
{
MethodName: "ListIdentityMappings",
Handler: _IdentityMappingStoreService_ListIdentityMappings_Handler,
},
{
MethodName: "ListIdentityMappingStores",
Handler: _IdentityMappingStoreService_ListIdentityMappingStores_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/identity_mapping_store_service.proto",
}IdentityMappingStoreService_ServiceDesc is the grpc.ServiceDesc for IdentityMappingStoreService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
LicenseConfigService_ServiceDesc
var LicenseConfigService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.LicenseConfigService",
HandlerType: (*LicenseConfigServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateLicenseConfig",
Handler: _LicenseConfigService_CreateLicenseConfig_Handler,
},
{
MethodName: "UpdateLicenseConfig",
Handler: _LicenseConfigService_UpdateLicenseConfig_Handler,
},
{
MethodName: "GetLicenseConfig",
Handler: _LicenseConfigService_GetLicenseConfig_Handler,
},
{
MethodName: "ListLicenseConfigs",
Handler: _LicenseConfigService_ListLicenseConfigs_Handler,
},
{
MethodName: "DistributeLicenseConfig",
Handler: _LicenseConfigService_DistributeLicenseConfig_Handler,
},
{
MethodName: "RetractLicenseConfig",
Handler: _LicenseConfigService_RetractLicenseConfig_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/license_config_service.proto",
}LicenseConfigService_ServiceDesc is the grpc.ServiceDesc for LicenseConfigService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
ProjectService_ServiceDesc
var ProjectService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.ProjectService",
HandlerType: (*ProjectServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ProvisionProject",
Handler: _ProjectService_ProvisionProject_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/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)
RankService_ServiceDesc
var RankService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.RankService",
HandlerType: (*RankServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "Rank",
Handler: _RankService_Rank_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/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)
RecommendationService_ServiceDesc
var RecommendationService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.RecommendationService",
HandlerType: (*RecommendationServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "Recommend",
Handler: _RecommendationService_Recommend_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/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)
SampleQueryService_ServiceDesc
var SampleQueryService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.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/v1beta/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)
SampleQuerySetService_ServiceDesc
var SampleQuerySetService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.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/v1beta/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)
SchemaService_ServiceDesc
var SchemaService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.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/v1beta/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)
SearchService_ServiceDesc
var SearchService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.SearchService",
HandlerType: (*SearchServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "Search",
Handler: _SearchService_Search_Handler,
},
{
MethodName: "SearchLite",
Handler: _SearchService_SearchLite_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/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)
SearchTuningService_ServiceDesc
var SearchTuningService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.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/v1beta/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)
ServingConfigService_ServiceDesc
var ServingConfigService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.ServingConfigService",
HandlerType: (*ServingConfigServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateServingConfig",
Handler: _ServingConfigService_CreateServingConfig_Handler,
},
{
MethodName: "DeleteServingConfig",
Handler: _ServingConfigService_DeleteServingConfig_Handler,
},
{
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/v1beta/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)
SessionService_ServiceDesc
var SessionService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.SessionService",
HandlerType: (*SessionServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateSession",
Handler: _SessionService_CreateSession_Handler,
},
{
MethodName: "DeleteSession",
Handler: _SessionService_DeleteSession_Handler,
},
{
MethodName: "UpdateSession",
Handler: _SessionService_UpdateSession_Handler,
},
{
MethodName: "GetSession",
Handler: _SessionService_GetSession_Handler,
},
{
MethodName: "ListSessions",
Handler: _SessionService_ListSessions_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/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)
SiteSearchEngineService_ServiceDesc
var SiteSearchEngineService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.SiteSearchEngineService",
HandlerType: (*SiteSearchEngineServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetSiteSearchEngine",
Handler: _SiteSearchEngineService_GetSiteSearchEngine_Handler,
},
{
MethodName: "CreateTargetSite",
Handler: _SiteSearchEngineService_CreateTargetSite_Handler,
},
{
MethodName: "BatchCreateTargetSites",
Handler: _SiteSearchEngineService_BatchCreateTargetSites_Handler,
},
{
MethodName: "GetTargetSite",
Handler: _SiteSearchEngineService_GetTargetSite_Handler,
},
{
MethodName: "UpdateTargetSite",
Handler: _SiteSearchEngineService_UpdateTargetSite_Handler,
},
{
MethodName: "DeleteTargetSite",
Handler: _SiteSearchEngineService_DeleteTargetSite_Handler,
},
{
MethodName: "ListTargetSites",
Handler: _SiteSearchEngineService_ListTargetSites_Handler,
},
{
MethodName: "CreateSitemap",
Handler: _SiteSearchEngineService_CreateSitemap_Handler,
},
{
MethodName: "DeleteSitemap",
Handler: _SiteSearchEngineService_DeleteSitemap_Handler,
},
{
MethodName: "FetchSitemaps",
Handler: _SiteSearchEngineService_FetchSitemaps_Handler,
},
{
MethodName: "EnableAdvancedSiteSearch",
Handler: _SiteSearchEngineService_EnableAdvancedSiteSearch_Handler,
},
{
MethodName: "DisableAdvancedSiteSearch",
Handler: _SiteSearchEngineService_DisableAdvancedSiteSearch_Handler,
},
{
MethodName: "RecrawlUris",
Handler: _SiteSearchEngineService_RecrawlUris_Handler,
},
{
MethodName: "BatchVerifyTargetSites",
Handler: _SiteSearchEngineService_BatchVerifyTargetSites_Handler,
},
{
MethodName: "FetchDomainVerificationStatus",
Handler: _SiteSearchEngineService_FetchDomainVerificationStatus_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/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)
UserEventService_ServiceDesc
var UserEventService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.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/v1beta/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)
UserLicenseService_ServiceDesc
var UserLicenseService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.UserLicenseService",
HandlerType: (*UserLicenseServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ListUserLicenses",
Handler: _UserLicenseService_ListUserLicenses_Handler,
},
{
MethodName: "ListLicenseConfigsUsageStats",
Handler: _UserLicenseService_ListLicenseConfigsUsageStats_Handler,
},
{
MethodName: "BatchUpdateUserLicenses",
Handler: _UserLicenseService_BatchUpdateUserLicenses_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/user_license_service.proto",
}UserLicenseService_ServiceDesc is the grpc.ServiceDesc for UserLicenseService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
UserStoreService_ServiceDesc
var UserStoreService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1beta.UserStoreService",
HandlerType: (*UserStoreServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetUserStore",
Handler: _UserStoreService_GetUserStore_Handler,
},
{
MethodName: "UpdateUserStore",
Handler: _UserStoreService_UpdateUserStore_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1beta/user_store_service.proto",
}UserStoreService_ServiceDesc is the grpc.ServiceDesc for UserStoreService 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
func RegisterAclConfigServiceServer(s grpc.ServiceRegistrar, srv AclConfigServiceServer)func RegisterAssistantServiceServer
func RegisterAssistantServiceServer(s grpc.ServiceRegistrar, srv AssistantServiceServer)func RegisterCmekConfigServiceServer
func RegisterCmekConfigServiceServer(s grpc.ServiceRegistrar, srv CmekConfigServiceServer)func RegisterCompletionServiceServer
func RegisterCompletionServiceServer(s grpc.ServiceRegistrar, srv CompletionServiceServer)func RegisterControlServiceServer
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 RegisterEvaluationServiceServer
func RegisterEvaluationServiceServer(s grpc.ServiceRegistrar, srv EvaluationServiceServer)func RegisterGroundedGenerationServiceServer
func RegisterGroundedGenerationServiceServer(s grpc.ServiceRegistrar, srv GroundedGenerationServiceServer)func RegisterIdentityMappingStoreServiceServer
func RegisterIdentityMappingStoreServiceServer(s grpc.ServiceRegistrar, srv IdentityMappingStoreServiceServer)func RegisterLicenseConfigServiceServer
func RegisterLicenseConfigServiceServer(s grpc.ServiceRegistrar, srv LicenseConfigServiceServer)func RegisterProjectServiceServer
func RegisterProjectServiceServer(s grpc.ServiceRegistrar, srv ProjectServiceServer)func RegisterRankServiceServer
func RegisterRankServiceServer(s grpc.ServiceRegistrar, srv RankServiceServer)func RegisterRecommendationServiceServer
func RegisterRecommendationServiceServer(s grpc.ServiceRegistrar, srv RecommendationServiceServer)func RegisterSampleQueryServiceServer
func RegisterSampleQueryServiceServer(s grpc.ServiceRegistrar, srv SampleQueryServiceServer)func RegisterSampleQuerySetServiceServer
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
func RegisterSearchTuningServiceServer(s grpc.ServiceRegistrar, srv SearchTuningServiceServer)func RegisterServingConfigServiceServer
func RegisterServingConfigServiceServer(s grpc.ServiceRegistrar, srv ServingConfigServiceServer)func RegisterSessionServiceServer
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)func RegisterUserLicenseServiceServer
func RegisterUserLicenseServiceServer(s grpc.ServiceRegistrar, srv UserLicenseServiceServer)func RegisterUserStoreServiceServer
func RegisterUserStoreServiceServer(s grpc.ServiceRegistrar, srv UserStoreServiceServer)AclConfig
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: Use AclConfig.ProtoReflect.Descriptor instead.
func (*AclConfig) GetIdpConfig
func (*AclConfig) GetName
func (*AclConfig) ProtoMessage
func (*AclConfig) ProtoMessage()func (*AclConfig) ProtoReflect
func (x *AclConfig) ProtoReflect() protoreflect.Messagefunc (*AclConfig) Reset
func (x *AclConfig) Reset()func (*AclConfig) String
AclConfigServiceClient
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.v1beta.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
func NewAclConfigServiceClient(cc grpc.ClientConnInterface) AclConfigServiceClientAclConfigServiceServer
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.v1beta.AclConfig].
GetAclConfig(context.Context, *GetAclConfigRequest) (*AclConfig, error)
}AclConfigServiceServer is the server API for AclConfigService service. All implementations should embed UnimplementedAclConfigServiceServer for forward compatibility
AdvancedCompleteQueryRequest
type AdvancedCompleteQueryRequest struct {
// Required. The completion_config of the parent dataStore or engine resource
// name for which the completion is performed, such as
// `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
// `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
CompletionConfig string `protobuf:"bytes,1,opt,name=completion_config,json=completionConfig,proto3" json:"completion_config,omitempty"`
// Required. The typeahead input used to fetch suggestions. Maximum length is
// 128 characters.
//
// The query can not be empty for most of the suggestion types. If it is
// empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
// suggestion_types contains only the type `RECENT_SEARCH`, the query can
// be an empty string. The is called "zero prefix" feature, which returns
// user's recently searched queries given the empty query.
Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
// Specifies the autocomplete query model, which only applies to the QUERY
// SuggestionType. This overrides any model specified in the Configuration >
// Autocomplete section of the Cloud console. Currently supported values:
//
// * `document` - Using suggestions generated from user-imported documents.
// * `search-history` - Using suggestions generated from the past history of
// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
// API calls. Do not use it when there is no traffic for Search API.
// * `user-event` - Using suggestions generated from user-imported search
// events.
// * `document-completable` - Using suggestions taken directly from
// user-imported document fields marked as completable.
//
// Default values:
//
// * `document` is the default model for regular dataStores.
// * `search-history` is the default model for site search dataStores.
QueryModel string `protobuf:"bytes,3,opt,name=query_model,json=queryModel,proto3" json:"query_model,omitempty"`
// Optional. A unique identifier for tracking visitors. For example, this
// could be implemented with an HTTP cookie, which should be able to uniquely
// identify a visitor on a single device. This unique identifier should not
// change if the visitor logs in or out of the website.
//
// This field should NOT have a fixed value such as `unknown_visitor`.
//
// This should be the same identifier as
// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
// and
// [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].
//
// The field must be a UTF-8 encoded string with a length limit of 128
UserPseudoId string `protobuf:"bytes,4,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
// Optional. Information about the end user.
//
// This should be the same identifier information as
// [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
// and
// [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
UserInfo *UserInfo `protobuf:"bytes,9,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
// Indicates if tail suggestions should be returned if there are no
// suggestions that match the full query. Even if set to true, if there are
// suggestions that match the full query, those are returned and no
// tail suggestions are returned.
IncludeTailSuggestions bool `protobuf:"varint,5,opt,name=include_tail_suggestions,json=includeTailSuggestions,proto3" json:"include_tail_suggestions,omitempty"`
// Optional. Specification to boost suggestions matching the condition.
BoostSpec *AdvancedCompleteQueryRequest_BoostSpec `protobuf:"bytes,6,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
// Optional. Suggestion types to return. If empty or unspecified, query
// suggestions are returned. Only one suggestion type is supported at the
// moment.
SuggestionTypes []AdvancedCompleteQueryRequest_SuggestionType `protobuf:"varint,7,rep,packed,name=suggestion_types,json=suggestionTypes,proto3,enum=google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest_SuggestionType" json:"suggestion_types,omitempty"`
// Optional. Specification of each suggestion type.
SuggestionTypeSpecs []*AdvancedCompleteQueryRequest_SuggestionTypeSpec `protobuf:"bytes,10,rep,name=suggestion_type_specs,json=suggestionTypeSpecs,proto3" json:"suggestion_type_specs,omitempty"`
// Optional. Experiment ids for this request.
ExperimentIds []string `protobuf:"bytes,14,rep,name=experiment_ids,json=experimentIds,proto3" json:"experiment_ids,omitempty"`
// contains filtered or unexported fields
}Request message for [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] method. .
func (*AdvancedCompleteQueryRequest) Descriptor
func (*AdvancedCompleteQueryRequest) Descriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryRequest.ProtoReflect.Descriptor instead.
func (*AdvancedCompleteQueryRequest) GetBoostSpec
func (x *AdvancedCompleteQueryRequest) GetBoostSpec() *AdvancedCompleteQueryRequest_BoostSpecfunc (*AdvancedCompleteQueryRequest) GetCompletionConfig
func (x *AdvancedCompleteQueryRequest) GetCompletionConfig() stringfunc (*AdvancedCompleteQueryRequest) GetExperimentIds
func (x *AdvancedCompleteQueryRequest) GetExperimentIds() []stringfunc (*AdvancedCompleteQueryRequest) GetIncludeTailSuggestions
func (x *AdvancedCompleteQueryRequest) GetIncludeTailSuggestions() boolfunc (*AdvancedCompleteQueryRequest) GetQuery
func (x *AdvancedCompleteQueryRequest) GetQuery() stringfunc (*AdvancedCompleteQueryRequest) GetQueryModel
func (x *AdvancedCompleteQueryRequest) GetQueryModel() stringfunc (*AdvancedCompleteQueryRequest) GetSuggestionTypeSpecs
func (x *AdvancedCompleteQueryRequest) GetSuggestionTypeSpecs() []*AdvancedCompleteQueryRequest_SuggestionTypeSpecfunc (*AdvancedCompleteQueryRequest) GetSuggestionTypes
func (x *AdvancedCompleteQueryRequest) GetSuggestionTypes() []AdvancedCompleteQueryRequest_SuggestionTypefunc (*AdvancedCompleteQueryRequest) GetUserInfo
func (x *AdvancedCompleteQueryRequest) GetUserInfo() *UserInfofunc (*AdvancedCompleteQueryRequest) GetUserPseudoId
func (x *AdvancedCompleteQueryRequest) GetUserPseudoId() stringfunc (*AdvancedCompleteQueryRequest) ProtoMessage
func (*AdvancedCompleteQueryRequest) ProtoMessage()func (*AdvancedCompleteQueryRequest) ProtoReflect
func (x *AdvancedCompleteQueryRequest) ProtoReflect() protoreflect.Messagefunc (*AdvancedCompleteQueryRequest) Reset
func (x *AdvancedCompleteQueryRequest) Reset()func (*AdvancedCompleteQueryRequest) String
func (x *AdvancedCompleteQueryRequest) String() stringAdvancedCompleteQueryRequest_BoostSpec
type AdvancedCompleteQueryRequest_BoostSpec struct {
// Condition boost specifications. If a suggestion matches multiple
// conditions in the specifications, boost values from these specifications
// are all applied and combined in a non-linear way. Maximum number of
// specifications is 20.
//
// Note: Currently only support language condition boost.
ConditionBoostSpecs []*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec `protobuf:"bytes,1,rep,name=condition_boost_specs,json=conditionBoostSpecs,proto3" json:"condition_boost_specs,omitempty"`
// contains filtered or unexported fields
}Specification to boost suggestions based on the condition of the suggestion.
func (*AdvancedCompleteQueryRequest_BoostSpec) Descriptor
func (*AdvancedCompleteQueryRequest_BoostSpec) Descriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryRequest_BoostSpec.ProtoReflect.Descriptor instead.
func (*AdvancedCompleteQueryRequest_BoostSpec) GetConditionBoostSpecs
func (x *AdvancedCompleteQueryRequest_BoostSpec) GetConditionBoostSpecs() []*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpecfunc (*AdvancedCompleteQueryRequest_BoostSpec) ProtoMessage
func (*AdvancedCompleteQueryRequest_BoostSpec) ProtoMessage()func (*AdvancedCompleteQueryRequest_BoostSpec) ProtoReflect
func (x *AdvancedCompleteQueryRequest_BoostSpec) ProtoReflect() protoreflect.Messagefunc (*AdvancedCompleteQueryRequest_BoostSpec) Reset
func (x *AdvancedCompleteQueryRequest_BoostSpec) Reset()func (*AdvancedCompleteQueryRequest_BoostSpec) String
func (x *AdvancedCompleteQueryRequest_BoostSpec) String() stringAdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec
type AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec struct {
// An expression which specifies a boost condition. The syntax is the same
// as [filter expression
// syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax).
// Currently, the only supported condition is a list of BCP-47 lang codes.
//
// Example:
//
// * To boost suggestions in languages `en` or `fr`:
// `(lang_code: ANY("en", "fr"))`
Condition string `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"`
// Strength of the boost, which should be in [-1, 1].
// Negative boost means demotion. Default is 0.0.
//
// Setting to 1.0 gives the suggestions a big promotion. However, it does
// not necessarily mean that the top result will be a boosted suggestion.
//
// Setting to -1.0 gives the suggestions a big demotion. However, other
// suggestions that are relevant might still be shown.
//
// Setting to 0.0 means no boost applied. The boosting condition is
// ignored.
Boost float32 `protobuf:"fixed32,2,opt,name=boost,proto3" json:"boost,omitempty"`
// contains filtered or unexported fields
}Boost applies to suggestions which match a condition.
func (*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) Descriptor
func (*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) Descriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec.ProtoReflect.Descriptor instead.
func (*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) GetBoost
func (x *AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) GetBoost() float32func (*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) GetCondition
func (x *AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) GetCondition() stringfunc (*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) ProtoMessage
func (*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) ProtoMessage()func (*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) ProtoReflect
func (x *AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) ProtoReflect() protoreflect.Messagefunc (*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) Reset
func (x *AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) Reset()func (*AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) String
func (x *AdvancedCompleteQueryRequest_BoostSpec_ConditionBoostSpec) String() stringAdvancedCompleteQueryRequest_SuggestionType
type AdvancedCompleteQueryRequest_SuggestionType int32Suggestion type to return.
AdvancedCompleteQueryRequest_SUGGESTION_TYPE_UNSPECIFIED, AdvancedCompleteQueryRequest_QUERY, AdvancedCompleteQueryRequest_PEOPLE, AdvancedCompleteQueryRequest_CONTENT, AdvancedCompleteQueryRequest_RECENT_SEARCH, AdvancedCompleteQueryRequest_GOOGLE_WORKSPACE
const (
// Default value.
AdvancedCompleteQueryRequest_SUGGESTION_TYPE_UNSPECIFIED AdvancedCompleteQueryRequest_SuggestionType = 0
// Returns query suggestions.
AdvancedCompleteQueryRequest_QUERY AdvancedCompleteQueryRequest_SuggestionType = 1
// Returns people suggestions.
AdvancedCompleteQueryRequest_PEOPLE AdvancedCompleteQueryRequest_SuggestionType = 2
// Returns content suggestions.
AdvancedCompleteQueryRequest_CONTENT AdvancedCompleteQueryRequest_SuggestionType = 3
// Returns recent search suggestions.
AdvancedCompleteQueryRequest_RECENT_SEARCH AdvancedCompleteQueryRequest_SuggestionType = 4
// Returns Google Workspace suggestions.
AdvancedCompleteQueryRequest_GOOGLE_WORKSPACE AdvancedCompleteQueryRequest_SuggestionType = 5
)func (AdvancedCompleteQueryRequest_SuggestionType) Descriptor
func (AdvancedCompleteQueryRequest_SuggestionType) Descriptor() protoreflect.EnumDescriptorfunc (AdvancedCompleteQueryRequest_SuggestionType) Enum
func (x AdvancedCompleteQueryRequest_SuggestionType) Enum() *AdvancedCompleteQueryRequest_SuggestionTypefunc (AdvancedCompleteQueryRequest_SuggestionType) EnumDescriptor
func (AdvancedCompleteQueryRequest_SuggestionType) EnumDescriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryRequest_SuggestionType.Descriptor instead.
func (AdvancedCompleteQueryRequest_SuggestionType) Number
func (x AdvancedCompleteQueryRequest_SuggestionType) Number() protoreflect.EnumNumberfunc (AdvancedCompleteQueryRequest_SuggestionType) String
func (x AdvancedCompleteQueryRequest_SuggestionType) String() stringfunc (AdvancedCompleteQueryRequest_SuggestionType) Type
func (AdvancedCompleteQueryRequest_SuggestionType) Type() protoreflect.EnumTypeAdvancedCompleteQueryRequest_SuggestionTypeSpec
type AdvancedCompleteQueryRequest_SuggestionTypeSpec struct {
// Optional. Suggestion type.
SuggestionType AdvancedCompleteQueryRequest_SuggestionType `protobuf:"varint,1,opt,name=suggestion_type,json=suggestionType,proto3,enum=google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest_SuggestionType" json:"suggestion_type,omitempty"`
// Optional. Maximum number of suggestions to return for each suggestion
// type.
MaxSuggestions int32 `protobuf:"varint,2,opt,name=max_suggestions,json=maxSuggestions,proto3" json:"max_suggestions,omitempty"`
// contains filtered or unexported fields
}Specification of each suggestion type.
func (*AdvancedCompleteQueryRequest_SuggestionTypeSpec) Descriptor
func (*AdvancedCompleteQueryRequest_SuggestionTypeSpec) Descriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryRequest_SuggestionTypeSpec.ProtoReflect.Descriptor instead.
func (*AdvancedCompleteQueryRequest_SuggestionTypeSpec) GetMaxSuggestions
func (x *AdvancedCompleteQueryRequest_SuggestionTypeSpec) GetMaxSuggestions() int32func (*AdvancedCompleteQueryRequest_SuggestionTypeSpec) GetSuggestionType
func (x *AdvancedCompleteQueryRequest_SuggestionTypeSpec) GetSuggestionType() AdvancedCompleteQueryRequest_SuggestionTypefunc (*AdvancedCompleteQueryRequest_SuggestionTypeSpec) ProtoMessage
func (*AdvancedCompleteQueryRequest_SuggestionTypeSpec) ProtoMessage()func (*AdvancedCompleteQueryRequest_SuggestionTypeSpec) ProtoReflect
func (x *AdvancedCompleteQueryRequest_SuggestionTypeSpec) ProtoReflect() protoreflect.Messagefunc (*AdvancedCompleteQueryRequest_SuggestionTypeSpec) Reset
func (x *AdvancedCompleteQueryRequest_SuggestionTypeSpec) Reset()func (*AdvancedCompleteQueryRequest_SuggestionTypeSpec) String
func (x *AdvancedCompleteQueryRequest_SuggestionTypeSpec) String() stringAdvancedCompleteQueryResponse
type AdvancedCompleteQueryResponse struct {
// Results of the matched query suggestions. The result list is ordered and
// the first result is a top suggestion.
QuerySuggestions []*AdvancedCompleteQueryResponse_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"`
// Results of the matched people suggestions. The result list is ordered and
// the first result is the top suggestion.
PeopleSuggestions []*AdvancedCompleteQueryResponse_PersonSuggestion `protobuf:"bytes,3,rep,name=people_suggestions,json=peopleSuggestions,proto3" json:"people_suggestions,omitempty"`
// Results of the matched content suggestions. The result list is ordered and
// the first result is the top suggestion.
ContentSuggestions []*AdvancedCompleteQueryResponse_ContentSuggestion `protobuf:"bytes,4,rep,name=content_suggestions,json=contentSuggestions,proto3" json:"content_suggestions,omitempty"`
// Results of the matched "recent search" suggestions. The result list is
// ordered and the first result is the top suggestion.
RecentSearchSuggestions []*AdvancedCompleteQueryResponse_RecentSearchSuggestion `protobuf:"bytes,5,rep,name=recent_search_suggestions,json=recentSearchSuggestions,proto3" json:"recent_search_suggestions,omitempty"`
// contains filtered or unexported fields
}Response message for [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] method.
func (*AdvancedCompleteQueryResponse) Descriptor
func (*AdvancedCompleteQueryResponse) Descriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryResponse.ProtoReflect.Descriptor instead.
func (*AdvancedCompleteQueryResponse) GetContentSuggestions
func (x *AdvancedCompleteQueryResponse) GetContentSuggestions() []*AdvancedCompleteQueryResponse_ContentSuggestionfunc (*AdvancedCompleteQueryResponse) GetPeopleSuggestions
func (x *AdvancedCompleteQueryResponse) GetPeopleSuggestions() []*AdvancedCompleteQueryResponse_PersonSuggestionfunc (*AdvancedCompleteQueryResponse) GetQuerySuggestions
func (x *AdvancedCompleteQueryResponse) GetQuerySuggestions() []*AdvancedCompleteQueryResponse_QuerySuggestionfunc (*AdvancedCompleteQueryResponse) GetRecentSearchSuggestions
func (x *AdvancedCompleteQueryResponse) GetRecentSearchSuggestions() []*AdvancedCompleteQueryResponse_RecentSearchSuggestionfunc (*AdvancedCompleteQueryResponse) GetTailMatchTriggered
func (x *AdvancedCompleteQueryResponse) GetTailMatchTriggered() boolfunc (*AdvancedCompleteQueryResponse) ProtoMessage
func (*AdvancedCompleteQueryResponse) ProtoMessage()func (*AdvancedCompleteQueryResponse) ProtoReflect
func (x *AdvancedCompleteQueryResponse) ProtoReflect() protoreflect.Messagefunc (*AdvancedCompleteQueryResponse) Reset
func (x *AdvancedCompleteQueryResponse) Reset()func (*AdvancedCompleteQueryResponse) String
func (x *AdvancedCompleteQueryResponse) String() stringAdvancedCompleteQueryResponse_ContentSuggestion
type AdvancedCompleteQueryResponse_ContentSuggestion struct {
// The suggestion for the query.
Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
// The type of the content suggestion.
ContentType AdvancedCompleteQueryResponse_ContentSuggestion_ContentType `protobuf:"varint,2,opt,name=content_type,json=contentType,proto3,enum=google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse_ContentSuggestion_ContentType" json:"content_type,omitempty"`
// The document data snippet in the suggestion. Only a subset of fields will
// be populated.
Document *Document `protobuf:"bytes,4,opt,name=document,proto3" json:"document,omitempty"`
// The name of the dataStore that this suggestion belongs to.
DataStore string `protobuf:"bytes,5,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// The score of each suggestion. The score is in the range of [0, 1].
Score float64 `protobuf:"fixed64,6,opt,name=score,proto3" json:"score,omitempty"`
// The icon uri of the content suggestion.
IconUri string `protobuf:"bytes,7,opt,name=icon_uri,json=iconUri,proto3" json:"icon_uri,omitempty"`
// The destination uri of the content suggestion.
DestinationUri string `protobuf:"bytes,8,opt,name=destination_uri,json=destinationUri,proto3" json:"destination_uri,omitempty"`
// contains filtered or unexported fields
}Suggestions as content.
func (*AdvancedCompleteQueryResponse_ContentSuggestion) Descriptor
func (*AdvancedCompleteQueryResponse_ContentSuggestion) Descriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryResponse_ContentSuggestion.ProtoReflect.Descriptor instead.
func (*AdvancedCompleteQueryResponse_ContentSuggestion) GetContentType
func (x *AdvancedCompleteQueryResponse_ContentSuggestion) GetContentType() AdvancedCompleteQueryResponse_ContentSuggestion_ContentTypefunc (*AdvancedCompleteQueryResponse_ContentSuggestion) GetDataStore
func (x *AdvancedCompleteQueryResponse_ContentSuggestion) GetDataStore() stringfunc (*AdvancedCompleteQueryResponse_ContentSuggestion) GetDestinationUri
func (x *AdvancedCompleteQueryResponse_ContentSuggestion) GetDestinationUri() stringfunc (*AdvancedCompleteQueryResponse_ContentSuggestion) GetDocument
func (x *AdvancedCompleteQueryResponse_ContentSuggestion) GetDocument() *Documentfunc (*AdvancedCompleteQueryResponse_ContentSuggestion) GetIconUri
func (x *AdvancedCompleteQueryResponse_ContentSuggestion) GetIconUri() stringfunc (*AdvancedCompleteQueryResponse_ContentSuggestion) GetScore
func (x *AdvancedCompleteQueryResponse_ContentSuggestion) GetScore() float64func (*AdvancedCompleteQueryResponse_ContentSuggestion) GetSuggestion
func (x *AdvancedCompleteQueryResponse_ContentSuggestion) GetSuggestion() stringfunc (*AdvancedCompleteQueryResponse_ContentSuggestion) ProtoMessage
func (*AdvancedCompleteQueryResponse_ContentSuggestion) ProtoMessage()func (*AdvancedCompleteQueryResponse_ContentSuggestion) ProtoReflect
func (x *AdvancedCompleteQueryResponse_ContentSuggestion) ProtoReflect() protoreflect.Messagefunc (*AdvancedCompleteQueryResponse_ContentSuggestion) Reset
func (x *AdvancedCompleteQueryResponse_ContentSuggestion) Reset()func (*AdvancedCompleteQueryResponse_ContentSuggestion) String
func (x *AdvancedCompleteQueryResponse_ContentSuggestion) String() stringAdvancedCompleteQueryResponse_ContentSuggestion_ContentType
type AdvancedCompleteQueryResponse_ContentSuggestion_ContentType int32The type of the content returned for content suggestions.
AdvancedCompleteQueryResponse_ContentSuggestion_CONTENT_TYPE_UNSPECIFIED, AdvancedCompleteQueryResponse_ContentSuggestion_GOOGLE_WORKSPACE, AdvancedCompleteQueryResponse_ContentSuggestion_THIRD_PARTY
const (
// Default value.
AdvancedCompleteQueryResponse_ContentSuggestion_CONTENT_TYPE_UNSPECIFIED AdvancedCompleteQueryResponse_ContentSuggestion_ContentType = 0
// The suggestion is from a Google Workspace source.
AdvancedCompleteQueryResponse_ContentSuggestion_GOOGLE_WORKSPACE AdvancedCompleteQueryResponse_ContentSuggestion_ContentType = 1
// The suggestion is from a third party source.
AdvancedCompleteQueryResponse_ContentSuggestion_THIRD_PARTY AdvancedCompleteQueryResponse_ContentSuggestion_ContentType = 2
)func (AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) Descriptor
func (AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) Descriptor() protoreflect.EnumDescriptorfunc (AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) Enum
func (x AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) Enum() *AdvancedCompleteQueryResponse_ContentSuggestion_ContentTypefunc (AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) EnumDescriptor
func (AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) EnumDescriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryResponse_ContentSuggestion_ContentType.Descriptor instead.
func (AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) Number
func (x AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) Number() protoreflect.EnumNumberfunc (AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) String
func (x AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) String() stringfunc (AdvancedCompleteQueryResponse_ContentSuggestion_ContentType) Type
AdvancedCompleteQueryResponse_PersonSuggestion
type AdvancedCompleteQueryResponse_PersonSuggestion struct {
// The suggestion for the query.
Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
// The type of the person.
PersonType AdvancedCompleteQueryResponse_PersonSuggestion_PersonType `protobuf:"varint,2,opt,name=person_type,json=personType,proto3,enum=google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse_PersonSuggestion_PersonType" json:"person_type,omitempty"`
// The document data snippet in the suggestion. Only a subset of fields is
// populated.
Document *Document `protobuf:"bytes,4,opt,name=document,proto3" json:"document,omitempty"`
// The name of the dataStore that this suggestion belongs to.
DataStore string `protobuf:"bytes,5,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// The score of each suggestion. The score is in the range of [0, 1].
Score float64 `protobuf:"fixed64,6,opt,name=score,proto3" json:"score,omitempty"`
// The photo uri of the person suggestion.
DisplayPhotoUri string `protobuf:"bytes,7,opt,name=display_photo_uri,json=displayPhotoUri,proto3" json:"display_photo_uri,omitempty"`
// The destination uri of the person suggestion.
DestinationUri string `protobuf:"bytes,8,opt,name=destination_uri,json=destinationUri,proto3" json:"destination_uri,omitempty"`
// contains filtered or unexported fields
}Suggestions as people.
func (*AdvancedCompleteQueryResponse_PersonSuggestion) Descriptor
func (*AdvancedCompleteQueryResponse_PersonSuggestion) Descriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryResponse_PersonSuggestion.ProtoReflect.Descriptor instead.
func (*AdvancedCompleteQueryResponse_PersonSuggestion) GetDataStore
func (x *AdvancedCompleteQueryResponse_PersonSuggestion) GetDataStore() stringfunc (*AdvancedCompleteQueryResponse_PersonSuggestion) GetDestinationUri
func (x *AdvancedCompleteQueryResponse_PersonSuggestion) GetDestinationUri() stringfunc (*AdvancedCompleteQueryResponse_PersonSuggestion) GetDisplayPhotoUri
func (x *AdvancedCompleteQueryResponse_PersonSuggestion) GetDisplayPhotoUri() stringfunc (*AdvancedCompleteQueryResponse_PersonSuggestion) GetDocument
func (x *AdvancedCompleteQueryResponse_PersonSuggestion) GetDocument() *Documentfunc (*AdvancedCompleteQueryResponse_PersonSuggestion) GetPersonType
func (x *AdvancedCompleteQueryResponse_PersonSuggestion) GetPersonType() AdvancedCompleteQueryResponse_PersonSuggestion_PersonTypefunc (*AdvancedCompleteQueryResponse_PersonSuggestion) GetScore
func (x *AdvancedCompleteQueryResponse_PersonSuggestion) GetScore() float64func (*AdvancedCompleteQueryResponse_PersonSuggestion) GetSuggestion
func (x *AdvancedCompleteQueryResponse_PersonSuggestion) GetSuggestion() stringfunc (*AdvancedCompleteQueryResponse_PersonSuggestion) ProtoMessage
func (*AdvancedCompleteQueryResponse_PersonSuggestion) ProtoMessage()func (*AdvancedCompleteQueryResponse_PersonSuggestion) ProtoReflect
func (x *AdvancedCompleteQueryResponse_PersonSuggestion) ProtoReflect() protoreflect.Messagefunc (*AdvancedCompleteQueryResponse_PersonSuggestion) Reset
func (x *AdvancedCompleteQueryResponse_PersonSuggestion) Reset()func (*AdvancedCompleteQueryResponse_PersonSuggestion) String
func (x *AdvancedCompleteQueryResponse_PersonSuggestion) String() stringAdvancedCompleteQueryResponse_PersonSuggestion_PersonType
type AdvancedCompleteQueryResponse_PersonSuggestion_PersonType int32The type of the person based on the source.
AdvancedCompleteQueryResponse_PersonSuggestion_PERSON_TYPE_UNSPECIFIED, AdvancedCompleteQueryResponse_PersonSuggestion_CLOUD_IDENTITY, AdvancedCompleteQueryResponse_PersonSuggestion_THIRD_PARTY_IDENTITY
const (
// Default value.
AdvancedCompleteQueryResponse_PersonSuggestion_PERSON_TYPE_UNSPECIFIED AdvancedCompleteQueryResponse_PersonSuggestion_PersonType = 0
// The suggestion is from a GOOGLE_IDENTITY source.
AdvancedCompleteQueryResponse_PersonSuggestion_CLOUD_IDENTITY AdvancedCompleteQueryResponse_PersonSuggestion_PersonType = 1
// The suggestion is from a THIRD_PARTY_IDENTITY source.
AdvancedCompleteQueryResponse_PersonSuggestion_THIRD_PARTY_IDENTITY AdvancedCompleteQueryResponse_PersonSuggestion_PersonType = 2
)func (AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) Descriptor
func (AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) Descriptor() protoreflect.EnumDescriptorfunc (AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) Enum
func (x AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) Enum() *AdvancedCompleteQueryResponse_PersonSuggestion_PersonTypefunc (AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) EnumDescriptor
func (AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) EnumDescriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryResponse_PersonSuggestion_PersonType.Descriptor instead.
func (AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) Number
func (x AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) Number() protoreflect.EnumNumberfunc (AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) String
func (x AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) String() stringfunc (AdvancedCompleteQueryResponse_PersonSuggestion_PersonType) Type
AdvancedCompleteQueryResponse_QuerySuggestion
type AdvancedCompleteQueryResponse_QuerySuggestion struct {
// The suggestion for the query.
Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
// The unique document field paths that serve as the source of this
// suggestion if it was generated from completable fields.
//
// This field is only populated for the document-completable model.
CompletableFieldPaths []string `protobuf:"bytes,2,rep,name=completable_field_paths,json=completableFieldPaths,proto3" json:"completable_field_paths,omitempty"`
// The name of the dataStore that this suggestion belongs to.
DataStore []string `protobuf:"bytes,3,rep,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// The score of each suggestion. The score is in the range of [0, 1].
Score float64 `protobuf:"fixed64,4,opt,name=score,proto3" json:"score,omitempty"`
// contains filtered or unexported fields
}Suggestions as search queries.
func (*AdvancedCompleteQueryResponse_QuerySuggestion) Descriptor
func (*AdvancedCompleteQueryResponse_QuerySuggestion) Descriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryResponse_QuerySuggestion.ProtoReflect.Descriptor instead.
func (*AdvancedCompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths
func (x *AdvancedCompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths() []stringfunc (*AdvancedCompleteQueryResponse_QuerySuggestion) GetDataStore
func (x *AdvancedCompleteQueryResponse_QuerySuggestion) GetDataStore() []stringfunc (*AdvancedCompleteQueryResponse_QuerySuggestion) GetScore
func (x *AdvancedCompleteQueryResponse_QuerySuggestion) GetScore() float64func (*AdvancedCompleteQueryResponse_QuerySuggestion) GetSuggestion
func (x *AdvancedCompleteQueryResponse_QuerySuggestion) GetSuggestion() stringfunc (*AdvancedCompleteQueryResponse_QuerySuggestion) ProtoMessage
func (*AdvancedCompleteQueryResponse_QuerySuggestion) ProtoMessage()func (*AdvancedCompleteQueryResponse_QuerySuggestion) ProtoReflect
func (x *AdvancedCompleteQueryResponse_QuerySuggestion) ProtoReflect() protoreflect.Messagefunc (*AdvancedCompleteQueryResponse_QuerySuggestion) Reset
func (x *AdvancedCompleteQueryResponse_QuerySuggestion) Reset()func (*AdvancedCompleteQueryResponse_QuerySuggestion) String
func (x *AdvancedCompleteQueryResponse_QuerySuggestion) String() stringAdvancedCompleteQueryResponse_RecentSearchSuggestion
type AdvancedCompleteQueryResponse_RecentSearchSuggestion struct {
// The suggestion for the query.
Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
// The time when this recent rearch happened.
RecentSearchTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=recent_search_time,json=recentSearchTime,proto3" json:"recent_search_time,omitempty"`
// The score of each suggestion. The score is in the range of [0, 1].
Score float64 `protobuf:"fixed64,3,opt,name=score,proto3" json:"score,omitempty"`
// contains filtered or unexported fields
}Suggestions from recent search history.
func (*AdvancedCompleteQueryResponse_RecentSearchSuggestion) Descriptor
func (*AdvancedCompleteQueryResponse_RecentSearchSuggestion) Descriptor() ([]byte, []int)Deprecated: Use AdvancedCompleteQueryResponse_RecentSearchSuggestion.ProtoReflect.Descriptor instead.
func (*AdvancedCompleteQueryResponse_RecentSearchSuggestion) GetRecentSearchTime
func (x *AdvancedCompleteQueryResponse_RecentSearchSuggestion) GetRecentSearchTime() *timestamppb.Timestampfunc (*AdvancedCompleteQueryResponse_RecentSearchSuggestion) GetScore
func (x *AdvancedCompleteQueryResponse_RecentSearchSuggestion) GetScore() float64func (*AdvancedCompleteQueryResponse_RecentSearchSuggestion) GetSuggestion
func (x *AdvancedCompleteQueryResponse_RecentSearchSuggestion) GetSuggestion() stringfunc (*AdvancedCompleteQueryResponse_RecentSearchSuggestion) ProtoMessage
func (*AdvancedCompleteQueryResponse_RecentSearchSuggestion) ProtoMessage()func (*AdvancedCompleteQueryResponse_RecentSearchSuggestion) ProtoReflect
func (x *AdvancedCompleteQueryResponse_RecentSearchSuggestion) ProtoReflect() protoreflect.Messagefunc (*AdvancedCompleteQueryResponse_RecentSearchSuggestion) Reset
func (x *AdvancedCompleteQueryResponse_RecentSearchSuggestion) Reset()func (*AdvancedCompleteQueryResponse_RecentSearchSuggestion) String
func (x *AdvancedCompleteQueryResponse_RecentSearchSuggestion) String() stringAdvancedSiteSearchConfig
type AdvancedSiteSearchConfig struct {
// If set true, initial indexing is disabled for the DataStore.
DisableInitialIndex *bool `protobuf:"varint,3,opt,name=disable_initial_index,json=disableInitialIndex,proto3,oneof" json:"disable_initial_index,omitempty"`
// If set true, automatic refresh is disabled for the DataStore.
DisableAutomaticRefresh *bool `protobuf:"varint,4,opt,name=disable_automatic_refresh,json=disableAutomaticRefresh,proto3,oneof" json:"disable_automatic_refresh,omitempty"`
// contains filtered or unexported fields
}Configuration data for advance site search.
func (*AdvancedSiteSearchConfig) Descriptor
func (*AdvancedSiteSearchConfig) Descriptor() ([]byte, []int)Deprecated: Use AdvancedSiteSearchConfig.ProtoReflect.Descriptor instead.
func (*AdvancedSiteSearchConfig) GetDisableAutomaticRefresh
func (x *AdvancedSiteSearchConfig) GetDisableAutomaticRefresh() boolfunc (*AdvancedSiteSearchConfig) GetDisableInitialIndex
func (x *AdvancedSiteSearchConfig) GetDisableInitialIndex() boolfunc (*AdvancedSiteSearchConfig) ProtoMessage
func (*AdvancedSiteSearchConfig) ProtoMessage()func (*AdvancedSiteSearchConfig) ProtoReflect
func (x *AdvancedSiteSearchConfig) ProtoReflect() protoreflect.Messagefunc (*AdvancedSiteSearchConfig) Reset
func (x *AdvancedSiteSearchConfig) Reset()func (*AdvancedSiteSearchConfig) String
func (x *AdvancedSiteSearchConfig) String() stringAgentGatewaySetting
type AgentGatewaySetting struct {
// Optional. The default egress agent gateway to use, when this setting is
// applied to a Gemini Enterprise resource.
//
// The deployment mode must be GOOGLE_MANAGED, and the governed access path
// must be AGENT_TO_ANYWHERE.
DefaultEgressAgentGateway *AgentGatewaySetting_AgentGatewayReference `protobuf:"bytes,1,opt,name=default_egress_agent_gateway,json=defaultEgressAgentGateway,proto3" json:"default_egress_agent_gateway,omitempty"`
// contains filtered or unexported fields
}Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.
func (*AgentGatewaySetting) Descriptor
func (*AgentGatewaySetting) Descriptor() ([]byte, []int)Deprecated: Use AgentGatewaySetting.ProtoReflect.Descriptor instead.
func (*AgentGatewaySetting) GetDefaultEgressAgentGateway
func (x *AgentGatewaySetting) GetDefaultEgressAgentGateway() *AgentGatewaySetting_AgentGatewayReferencefunc (*AgentGatewaySetting) ProtoMessage
func (*AgentGatewaySetting) ProtoMessage()func (*AgentGatewaySetting) ProtoReflect
func (x *AgentGatewaySetting) ProtoReflect() protoreflect.Messagefunc (*AgentGatewaySetting) Reset
func (x *AgentGatewaySetting) Reset()func (*AgentGatewaySetting) String
func (x *AgentGatewaySetting) String() stringAgentGatewaySetting_AgentGatewayReference
type AgentGatewaySetting_AgentGatewayReference struct {
// Required. Immutable. The resource name of the agent gateway.
//
// Expected format:
// `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Reference to an Agent Gateway resource.
func (*AgentGatewaySetting_AgentGatewayReference) Descriptor
func (*AgentGatewaySetting_AgentGatewayReference) Descriptor() ([]byte, []int)Deprecated: Use AgentGatewaySetting_AgentGatewayReference.ProtoReflect.Descriptor instead.
func (*AgentGatewaySetting_AgentGatewayReference) GetName
func (x *AgentGatewaySetting_AgentGatewayReference) GetName() stringfunc (*AgentGatewaySetting_AgentGatewayReference) ProtoMessage
func (*AgentGatewaySetting_AgentGatewayReference) ProtoMessage()func (*AgentGatewaySetting_AgentGatewayReference) ProtoReflect
func (x *AgentGatewaySetting_AgentGatewayReference) ProtoReflect() protoreflect.Messagefunc (*AgentGatewaySetting_AgentGatewayReference) Reset
func (x *AgentGatewaySetting_AgentGatewayReference) Reset()func (*AgentGatewaySetting_AgentGatewayReference) String
func (x *AgentGatewaySetting_AgentGatewayReference) String() stringAlloyDbSource
type AlloyDbSource struct {
// The project ID that contains the AlloyDB source.
// Has a length limit of 128 characters. If not specified, inherits the
// project ID from the parent request.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Required. The AlloyDB location to copy the data from with a length limit of
// 256 characters.
LocationId string `protobuf:"bytes,2,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
// Required. The AlloyDB cluster to copy the data from with a length limit of
// 256 characters.
ClusterId string `protobuf:"bytes,3,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
// Required. The AlloyDB database to copy the data from with a length limit of
// 256 characters.
DatabaseId string `protobuf:"bytes,4,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// Required. The AlloyDB table to copy the data from with a length limit of
// 256 characters.
TableId string `protobuf:"bytes,5,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Intermediate Cloud Storage directory used for the import with a length
// limit of 2,000 characters. Can be specified if one wants to have the
// AlloyDB export to a specific Cloud Storage directory.
//
// Ensure that the AlloyDB service account has the necessary Cloud
// Storage Admin permissions to access the specified Cloud Storage directory.
GcsStagingDir string `protobuf:"bytes,6,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
// contains filtered or unexported fields
}AlloyDB source import data from.
func (*AlloyDbSource) Descriptor
func (*AlloyDbSource) Descriptor() ([]byte, []int)Deprecated: Use AlloyDbSource.ProtoReflect.Descriptor instead.
func (*AlloyDbSource) GetClusterId
func (x *AlloyDbSource) GetClusterId() stringfunc (*AlloyDbSource) GetDatabaseId
func (x *AlloyDbSource) GetDatabaseId() stringfunc (*AlloyDbSource) GetGcsStagingDir
func (x *AlloyDbSource) GetGcsStagingDir() stringfunc (*AlloyDbSource) GetLocationId
func (x *AlloyDbSource) GetLocationId() stringfunc (*AlloyDbSource) GetProjectId
func (x *AlloyDbSource) GetProjectId() stringfunc (*AlloyDbSource) GetTableId
func (x *AlloyDbSource) GetTableId() stringfunc (*AlloyDbSource) ProtoMessage
func (*AlloyDbSource) ProtoMessage()func (*AlloyDbSource) ProtoReflect
func (x *AlloyDbSource) ProtoReflect() protoreflect.Messagefunc (*AlloyDbSource) Reset
func (x *AlloyDbSource) Reset()func (*AlloyDbSource) String
func (x *AlloyDbSource) String() stringAnswer
type Answer struct {
// Immutable. Fully qualified name
// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The state of the answer generation.
State Answer_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1beta.Answer_State" json:"state,omitempty"`
// The textual answer.
AnswerText string `protobuf:"bytes,3,opt,name=answer_text,json=answerText,proto3" json:"answer_text,omitempty"`
// A score in the range of [0, 1] describing how grounded the answer is by the
// reference chunks.
GroundingScore *float64 `protobuf:"fixed64,12,opt,name=grounding_score,json=groundingScore,proto3,oneof" json:"grounding_score,omitempty"`
// Citations.
Citations []*Answer_Citation `protobuf:"bytes,4,rep,name=citations,proto3" json:"citations,omitempty"`
// Optional. Grounding supports.
GroundingSupports []*Answer_GroundingSupport `protobuf:"bytes,13,rep,name=grounding_supports,json=groundingSupports,proto3" json:"grounding_supports,omitempty"`
// References.
References []*Answer_Reference `protobuf:"bytes,5,rep,name=references,proto3" json:"references,omitempty"`
// Output only. List of blob attachments in the answer.
BlobAttachments []*Answer_BlobAttachment `protobuf:"bytes,15,rep,name=blob_attachments,json=blobAttachments,proto3" json:"blob_attachments,omitempty"`
// Suggested related questions.
RelatedQuestions []string `protobuf:"bytes,6,rep,name=related_questions,json=relatedQuestions,proto3" json:"related_questions,omitempty"`
// Answer generation steps.
Steps []*Answer_Step `protobuf:"bytes,7,rep,name=steps,proto3" json:"steps,omitempty"`
// Query understanding information.
QueryUnderstandingInfo *Answer_QueryUnderstandingInfo `protobuf:"bytes,10,opt,name=query_understanding_info,json=queryUnderstandingInfo,proto3" json:"query_understanding_info,omitempty"`
// Additional answer-skipped reasons. This provides the reason for ignored
// cases. If nothing is skipped, this field is not set.
AnswerSkippedReasons []Answer_AnswerSkippedReason `protobuf:"varint,11,rep,packed,name=answer_skipped_reasons,json=answerSkippedReasons,proto3,enum=google.cloud.discoveryengine.v1beta.Answer_AnswerSkippedReason" json:"answer_skipped_reasons,omitempty"`
// Output only. Answer creation timestamp.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Answer completed timestamp.
CompleteTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"`
// Optional. Safety ratings.
SafetyRatings []*SafetyRating `protobuf:"bytes,14,rep,name=safety_ratings,json=safetyRatings,proto3" json:"safety_ratings,omitempty"`
// contains filtered or unexported fields
}Defines an answer.
func (*Answer) Descriptor
Deprecated: Use Answer.ProtoReflect.Descriptor instead.
func (*Answer) GetAnswerSkippedReasons
func (x *Answer) GetAnswerSkippedReasons() []Answer_AnswerSkippedReasonfunc (*Answer) GetAnswerText
func (*Answer) GetBlobAttachments
func (x *Answer) GetBlobAttachments() []*Answer_BlobAttachmentfunc (*Answer) GetCitations
func (x *Answer) GetCitations() []*Answer_Citationfunc (*Answer) GetCompleteTime
func (x *Answer) GetCompleteTime() *timestamppb.Timestampfunc (*Answer) GetCreateTime
func (x *Answer) GetCreateTime() *timestamppb.Timestampfunc (*Answer) GetGroundingScore
func (*Answer) GetGroundingSupports
func (x *Answer) GetGroundingSupports() []*Answer_GroundingSupportfunc (*Answer) GetName
func (*Answer) GetQueryUnderstandingInfo
func (x *Answer) GetQueryUnderstandingInfo() *Answer_QueryUnderstandingInfofunc (*Answer) GetReferences
func (x *Answer) GetReferences() []*Answer_Referencefunc (*Answer) GetRelatedQuestions
func (*Answer) GetSafetyRatings
func (x *Answer) GetSafetyRatings() []*SafetyRatingfunc (*Answer) GetState
func (x *Answer) GetState() Answer_Statefunc (*Answer) GetSteps
func (x *Answer) GetSteps() []*Answer_Stepfunc (*Answer) ProtoMessage
func (*Answer) ProtoMessage()func (*Answer) ProtoReflect
func (x *Answer) ProtoReflect() protoreflect.Messagefunc (*Answer) Reset
func (x *Answer) Reset()func (*Answer) String
AnswerGenerationSpec
type AnswerGenerationSpec struct {
// Optional. The specification for user specified classifier spec.
UserDefinedClassifierSpec *AnswerGenerationSpec_UserDefinedClassifierSpec `protobuf:"bytes,1,opt,name=user_defined_classifier_spec,json=userDefinedClassifierSpec,proto3" json:"user_defined_classifier_spec,omitempty"`
// contains filtered or unexported fields
}The specification for answer generation.
func (*AnswerGenerationSpec) Descriptor
func (*AnswerGenerationSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerGenerationSpec.ProtoReflect.Descriptor instead.
func (*AnswerGenerationSpec) GetUserDefinedClassifierSpec
func (x *AnswerGenerationSpec) GetUserDefinedClassifierSpec() *AnswerGenerationSpec_UserDefinedClassifierSpecfunc (*AnswerGenerationSpec) ProtoMessage
func (*AnswerGenerationSpec) ProtoMessage()func (*AnswerGenerationSpec) ProtoReflect
func (x *AnswerGenerationSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerGenerationSpec) Reset
func (x *AnswerGenerationSpec) Reset()func (*AnswerGenerationSpec) String
func (x *AnswerGenerationSpec) String() stringAnswerGenerationSpec_UserDefinedClassifierSpec
type AnswerGenerationSpec_UserDefinedClassifierSpec struct {
// Optional. Whether or not to enable and include user defined classifier.
EnableUserDefinedClassifier bool `protobuf:"varint,1,opt,name=enable_user_defined_classifier,json=enableUserDefinedClassifier,proto3" json:"enable_user_defined_classifier,omitempty"`
// Optional. The preamble to be used for the user defined classifier.
Preamble string `protobuf:"bytes,2,opt,name=preamble,proto3" json:"preamble,omitempty"`
// Optional. The model id to be used for the user defined classifier.
ModelId string `protobuf:"bytes,3,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
// Optional. The task marker to be used for the user defined classifier.
TaskMarker string `protobuf:"bytes,4,opt,name=task_marker,json=taskMarker,proto3" json:"task_marker,omitempty"`
// Optional. The top-p value to be used for the user defined classifier.
TopP float64 `protobuf:"fixed64,5,opt,name=top_p,json=topP,proto3" json:"top_p,omitempty"`
// Optional. The top-k value to be used for the user defined classifier.
TopK int64 `protobuf:"varint,6,opt,name=top_k,json=topK,proto3" json:"top_k,omitempty"`
// Optional. The temperature value to be used for the user defined
// classifier.
Temperature float64 `protobuf:"fixed64,7,opt,name=temperature,proto3" json:"temperature,omitempty"`
// Optional. The seed value to be used for the user defined classifier.
Seed int32 `protobuf:"varint,8,opt,name=seed,proto3" json:"seed,omitempty"`
// contains filtered or unexported fields
}The specification for user defined classifier.
func (*AnswerGenerationSpec_UserDefinedClassifierSpec) Descriptor
func (*AnswerGenerationSpec_UserDefinedClassifierSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerGenerationSpec_UserDefinedClassifierSpec.ProtoReflect.Descriptor instead.
func (*AnswerGenerationSpec_UserDefinedClassifierSpec) GetEnableUserDefinedClassifier
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) GetEnableUserDefinedClassifier() boolfunc (*AnswerGenerationSpec_UserDefinedClassifierSpec) GetModelId
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) GetModelId() stringfunc (*AnswerGenerationSpec_UserDefinedClassifierSpec) GetPreamble
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) GetPreamble() stringfunc (*AnswerGenerationSpec_UserDefinedClassifierSpec) GetSeed
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) GetSeed() int32func (*AnswerGenerationSpec_UserDefinedClassifierSpec) GetTaskMarker
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) GetTaskMarker() stringfunc (*AnswerGenerationSpec_UserDefinedClassifierSpec) GetTemperature
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) GetTemperature() float64func (*AnswerGenerationSpec_UserDefinedClassifierSpec) GetTopK
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) GetTopK() int64func (*AnswerGenerationSpec_UserDefinedClassifierSpec) GetTopP
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) GetTopP() float64func (*AnswerGenerationSpec_UserDefinedClassifierSpec) ProtoMessage
func (*AnswerGenerationSpec_UserDefinedClassifierSpec) ProtoMessage()func (*AnswerGenerationSpec_UserDefinedClassifierSpec) ProtoReflect
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerGenerationSpec_UserDefinedClassifierSpec) Reset
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) Reset()func (*AnswerGenerationSpec_UserDefinedClassifierSpec) String
func (x *AnswerGenerationSpec_UserDefinedClassifierSpec) String() stringAnswerQueryRequest
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`.
//
// Or the resource name of the agent engine serving config, such as:
// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`.
// (use when `enable_agent_invocation` set to true, and you have custom
// `AI_MODE` agent engine configured)
//
// This field is used to identify the serving configuration name, set
// of models used to make the search.
ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
// Required. Current user query.
Query *Query `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
// The session resource name. Not required.
//
// When session field is not set, the API is in sessionless mode.
//
// We support auto session mode: users can use the wildcard symbol `-` as
// session ID. A new ID will be automatically generated and assigned.
Session string `protobuf:"bytes,3,opt,name=session,proto3" json:"session,omitempty"`
// Model specification.
SafetySpec *AnswerQueryRequest_SafetySpec `protobuf:"bytes,4,opt,name=safety_spec,json=safetySpec,proto3" json:"safety_spec,omitempty"`
// Related questions specification.
RelatedQuestionsSpec *AnswerQueryRequest_RelatedQuestionsSpec `protobuf:"bytes,5,opt,name=related_questions_spec,json=relatedQuestionsSpec,proto3" json:"related_questions_spec,omitempty"`
// Optional. Grounding specification.
GroundingSpec *AnswerQueryRequest_GroundingSpec `protobuf:"bytes,6,opt,name=grounding_spec,json=groundingSpec,proto3" json:"grounding_spec,omitempty"`
// Answer generation specification.
AnswerGenerationSpec *AnswerQueryRequest_AnswerGenerationSpec `protobuf:"bytes,7,opt,name=answer_generation_spec,json=answerGenerationSpec,proto3" json:"answer_generation_spec,omitempty"`
// Search specification.
SearchSpec *AnswerQueryRequest_SearchSpec `protobuf:"bytes,8,opt,name=search_spec,json=searchSpec,proto3" json:"search_spec,omitempty"`
// Query understanding specification.
QueryUnderstandingSpec *AnswerQueryRequest_QueryUnderstandingSpec `protobuf:"bytes,9,opt,name=query_understanding_spec,json=queryUnderstandingSpec,proto3" json:"query_understanding_spec,omitempty"`
// Deprecated: This field is deprecated. Streaming Answer API will be
// supported.
//
// Asynchronous mode control.
//
// If enabled, the response will be returned with answer/session resource
// name without final answer. The API users need to do the polling to get
// the latest status of answer/session by calling
// [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetAnswer]
// or
// [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
// method.
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/conversational_search_service.proto.
AsynchronousMode bool `protobuf:"varint,10,opt,name=asynchronous_mode,json=asynchronousMode,proto3" json:"asynchronous_mode,omitempty"`
// A unique identifier for tracking visitors. For example, this could be
// implemented with an HTTP cookie, which should be able to uniquely identify
// a visitor on a single device. This unique identifier should not change if
// the visitor logs in or out of the website.
//
// This field should NOT have a fixed value such as `unknown_visitor`.
//
// The field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
UserPseudoId string `protobuf:"bytes,12,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
// The user labels applied to a resource must meet the following requirements:
//
// - Each resource can have multiple labels, up to a maximum of 64.
// - Each label must be a key-value pair.
// - Keys have a minimum length of 1 character and a maximum length of 63
// characters and cannot be empty. Values can be empty and have a maximum
// length of 63 characters.
// - Keys and values can contain only lowercase letters, numeric characters,
// underscores, and dashes. All characters must use UTF-8 encoding, and
// international characters are allowed.
// - The key portion of a label must be unique. However, you can use the same
// key with multiple resources.
// - Keys must start with a lowercase letter or international character.
//
// See [Google Cloud
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
// for more details.
UserLabels map[string]string `protobuf:"bytes,13,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. End user specification.
EndUserSpec *AnswerQueryRequest_EndUserSpec `protobuf:"bytes,14,opt,name=end_user_spec,json=endUserSpec,proto3" json:"end_user_spec,omitempty"`
// contains filtered or unexported fields
}Request message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] method.
func (*AnswerQueryRequest) Descriptor
func (*AnswerQueryRequest) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest) GetAnswerGenerationSpec
func (x *AnswerQueryRequest) GetAnswerGenerationSpec() *AnswerQueryRequest_AnswerGenerationSpecfunc (*AnswerQueryRequest) GetAsynchronousMode
func (x *AnswerQueryRequest) GetAsynchronousMode() boolDeprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/conversational_search_service.proto.
func (*AnswerQueryRequest) GetEndUserSpec
func (x *AnswerQueryRequest) GetEndUserSpec() *AnswerQueryRequest_EndUserSpecfunc (*AnswerQueryRequest) GetGroundingSpec
func (x *AnswerQueryRequest) GetGroundingSpec() *AnswerQueryRequest_GroundingSpecfunc (*AnswerQueryRequest) GetQuery
func (x *AnswerQueryRequest) GetQuery() *Queryfunc (*AnswerQueryRequest) GetQueryUnderstandingSpec
func (x *AnswerQueryRequest) GetQueryUnderstandingSpec() *AnswerQueryRequest_QueryUnderstandingSpecfunc (*AnswerQueryRequest) GetRelatedQuestionsSpec
func (x *AnswerQueryRequest) GetRelatedQuestionsSpec() *AnswerQueryRequest_RelatedQuestionsSpecfunc (*AnswerQueryRequest) GetSafetySpec
func (x *AnswerQueryRequest) GetSafetySpec() *AnswerQueryRequest_SafetySpecfunc (*AnswerQueryRequest) GetSearchSpec
func (x *AnswerQueryRequest) GetSearchSpec() *AnswerQueryRequest_SearchSpecfunc (*AnswerQueryRequest) GetServingConfig
func (x *AnswerQueryRequest) GetServingConfig() stringfunc (*AnswerQueryRequest) GetSession
func (x *AnswerQueryRequest) GetSession() stringfunc (*AnswerQueryRequest) GetUserLabels
func (x *AnswerQueryRequest) GetUserLabels() map[string]stringfunc (*AnswerQueryRequest) GetUserPseudoId
func (x *AnswerQueryRequest) GetUserPseudoId() stringfunc (*AnswerQueryRequest) ProtoMessage
func (*AnswerQueryRequest) ProtoMessage()func (*AnswerQueryRequest) ProtoReflect
func (x *AnswerQueryRequest) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest) Reset
func (x *AnswerQueryRequest) Reset()func (*AnswerQueryRequest) String
func (x *AnswerQueryRequest) String() stringAnswerQueryRequest_AnswerGenerationSpec
type AnswerQueryRequest_AnswerGenerationSpec struct {
// Answer generation model specification.
ModelSpec *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec `protobuf:"bytes,1,opt,name=model_spec,json=modelSpec,proto3" json:"model_spec,omitempty"`
// Answer generation prompt specification.
PromptSpec *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec `protobuf:"bytes,2,opt,name=prompt_spec,json=promptSpec,proto3" json:"prompt_spec,omitempty"`
// Specifies whether to include citation metadata in the answer. The default
// value is `false`.
IncludeCitations bool `protobuf:"varint,3,opt,name=include_citations,json=includeCitations,proto3" json:"include_citations,omitempty"`
// Language code for Answer. Use language tags defined by
// [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
// Note: This is an experimental feature.
AnswerLanguageCode string `protobuf:"bytes,4,opt,name=answer_language_code,json=answerLanguageCode,proto3" json:"answer_language_code,omitempty"`
// Specifies whether to filter out adversarial queries. The default value
// is `false`.
//
// Google employs search-query classification to detect adversarial
// queries. No answer is returned if the search query is classified as an
// adversarial query. For example, a user might ask a question regarding
// negative comments about the company or submit a query designed to
// generate unsafe, policy-violating output. If this field is set to
// `true`, we skip generating answers for adversarial queries and return
// fallback messages instead.
IgnoreAdversarialQuery bool `protobuf:"varint,5,opt,name=ignore_adversarial_query,json=ignoreAdversarialQuery,proto3" json:"ignore_adversarial_query,omitempty"`
// Specifies whether to filter out queries that are not answer-seeking.
// The default value is `false`.
//
// Google employs search-query classification to detect answer-seeking
// queries. No answer is returned if the search query is classified as a
// non-answer seeking query. If this field is set to `true`, we skip
// generating answers for non-answer seeking queries and return
// fallback messages instead.
IgnoreNonAnswerSeekingQuery bool `protobuf:"varint,6,opt,name=ignore_non_answer_seeking_query,json=ignoreNonAnswerSeekingQuery,proto3" json:"ignore_non_answer_seeking_query,omitempty"`
// Specifies whether to filter out queries that have low relevance.
//
// If this field is set to `false`, all search results are used regardless
// of relevance to generate answers. If set to `true` or unset, the behavior
// will be determined automatically by the service.
IgnoreLowRelevantContent *bool `protobuf:"varint,7,opt,name=ignore_low_relevant_content,json=ignoreLowRelevantContent,proto3,oneof" json:"ignore_low_relevant_content,omitempty"`
// Optional. Specifies whether to filter out jail-breaking queries. The
// default value is `false`.
//
// Google employs search-query classification to detect jail-breaking
// queries. No summary is returned if the search query is classified as a
// jail-breaking query. A user might add instructions to the query to
// change the tone, style, language, content of the answer, or ask the
// model to act as a different entity, e.g. "Reply in the tone of a
// competing company's CEO". If this field is set to `true`, we skip
// generating summaries for jail-breaking queries and return fallback
// messages instead.
IgnoreJailBreakingQuery bool `protobuf:"varint,8,opt,name=ignore_jail_breaking_query,json=ignoreJailBreakingQuery,proto3" json:"ignore_jail_breaking_query,omitempty"`
// Optional. Multimodal specification.
MultimodalSpec *AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec `protobuf:"bytes,9,opt,name=multimodal_spec,json=multimodalSpec,proto3" json:"multimodal_spec,omitempty"`
// contains filtered or unexported fields
}Answer generation specification.
func (*AnswerQueryRequest_AnswerGenerationSpec) Descriptor
func (*AnswerQueryRequest_AnswerGenerationSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_AnswerGenerationSpec) GetAnswerLanguageCode
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetAnswerLanguageCode() stringfunc (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreAdversarialQuery
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreAdversarialQuery() boolfunc (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreJailBreakingQuery
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreJailBreakingQuery() boolfunc (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreLowRelevantContent
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreLowRelevantContent() boolfunc (*AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreNonAnswerSeekingQuery
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIgnoreNonAnswerSeekingQuery() boolfunc (*AnswerQueryRequest_AnswerGenerationSpec) GetIncludeCitations
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetIncludeCitations() boolfunc (*AnswerQueryRequest_AnswerGenerationSpec) GetModelSpec
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetModelSpec() *AnswerQueryRequest_AnswerGenerationSpec_ModelSpecfunc (*AnswerQueryRequest_AnswerGenerationSpec) GetMultimodalSpec
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetMultimodalSpec() *AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpecfunc (*AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec
func (x *AnswerQueryRequest_AnswerGenerationSpec) GetPromptSpec() *AnswerQueryRequest_AnswerGenerationSpec_PromptSpecfunc (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage
func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoMessage()func (*AnswerQueryRequest_AnswerGenerationSpec) ProtoReflect
func (x *AnswerQueryRequest_AnswerGenerationSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_AnswerGenerationSpec) Reset
func (x *AnswerQueryRequest_AnswerGenerationSpec) Reset()func (*AnswerQueryRequest_AnswerGenerationSpec) String
func (x *AnswerQueryRequest_AnswerGenerationSpec) String() stringAnswerQueryRequest_AnswerGenerationSpec_ModelSpec
type AnswerQueryRequest_AnswerGenerationSpec_ModelSpec struct {
// Model version. If not set, it will use the default stable model.
// Allowed values are: stable, preview.
ModelVersion string `protobuf:"bytes,1,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
// contains filtered or unexported fields
}Answer Generation Model specification.
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Descriptor
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_ModelSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion
func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) GetModelVersion() stringfunc (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage
func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoMessage()func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoReflect
func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset
func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) Reset()func (*AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) String
func (x *AnswerQueryRequest_AnswerGenerationSpec_ModelSpec) String() stringAnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec
type AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec struct {
// Optional. Source of image returned in the answer.
ImageSource AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource `protobuf:"varint,3,opt,name=image_source,json=imageSource,proto3,enum=google.cloud.discoveryengine.v1beta.AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource" json:"image_source,omitempty"`
// contains filtered or unexported fields
}Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.
func (*AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) Descriptor
func (*AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) GetImageSource
func (x *AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) GetImageSource() AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSourcefunc (*AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) ProtoMessage
func (*AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) ProtoMessage()func (*AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) ProtoReflect
func (x *AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) Reset
func (x *AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) Reset()func (*AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) String
func (x *AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec) String() stringAnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource
type AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource int32Specifies the image source.
AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_IMAGE_SOURCE_UNSPECIFIED, AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ALL_AVAILABLE_SOURCES, AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_CORPUS_IMAGE_ONLY, AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_FIGURE_GENERATION_ONLY
const (
// Unspecified image source (multimodal feature is disabled by default).
AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_IMAGE_SOURCE_UNSPECIFIED AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource = 0
// Behavior when service determines the pick from all available sources.
AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ALL_AVAILABLE_SOURCES AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource = 1
// Includes image from corpus in the answer.
AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_CORPUS_IMAGE_ONLY AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource = 2
// Triggers figure generation in the answer.
AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_FIGURE_GENERATION_ONLY AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource = 3
)func (AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) Descriptor
func (AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) Descriptor() protoreflect.EnumDescriptorfunc (AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) Enum
func (x AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) Enum() *AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSourcefunc (AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) EnumDescriptor
func (AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) EnumDescriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource.Descriptor instead.
func (AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) Number
func (x AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) Number() protoreflect.EnumNumberfunc (AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) String
func (x AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) String() stringfunc (AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) Type
func (AnswerQueryRequest_AnswerGenerationSpec_MultimodalSpec_ImageSource) Type() protoreflect.EnumTypeAnswerQueryRequest_AnswerGenerationSpec_PromptSpec
type AnswerQueryRequest_AnswerGenerationSpec_PromptSpec struct {
// Customized preamble.
Preamble string `protobuf:"bytes,1,opt,name=preamble,proto3" json:"preamble,omitempty"`
// contains filtered or unexported fields
}Answer generation prompt specification.
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Descriptor
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_AnswerGenerationSpec_PromptSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble
func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) GetPreamble() stringfunc (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage
func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoMessage()func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoReflect
func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset
func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) Reset()func (*AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String
func (x *AnswerQueryRequest_AnswerGenerationSpec_PromptSpec) String() stringAnswerQueryRequest_EndUserSpec
type AnswerQueryRequest_EndUserSpec struct {
// Optional. End user metadata.
EndUserMetadata []*AnswerQueryRequest_EndUserSpec_EndUserMetaData `protobuf:"bytes,1,rep,name=end_user_metadata,json=endUserMetadata,proto3" json:"end_user_metadata,omitempty"`
// contains filtered or unexported fields
}End user specification.
func (*AnswerQueryRequest_EndUserSpec) Descriptor
func (*AnswerQueryRequest_EndUserSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_EndUserSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_EndUserSpec) GetEndUserMetadata
func (x *AnswerQueryRequest_EndUserSpec) GetEndUserMetadata() []*AnswerQueryRequest_EndUserSpec_EndUserMetaDatafunc (*AnswerQueryRequest_EndUserSpec) ProtoMessage
func (*AnswerQueryRequest_EndUserSpec) ProtoMessage()func (*AnswerQueryRequest_EndUserSpec) ProtoReflect
func (x *AnswerQueryRequest_EndUserSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_EndUserSpec) Reset
func (x *AnswerQueryRequest_EndUserSpec) Reset()func (*AnswerQueryRequest_EndUserSpec) String
func (x *AnswerQueryRequest_EndUserSpec) String() stringAnswerQueryRequest_EndUserSpec_EndUserMetaData
type AnswerQueryRequest_EndUserSpec_EndUserMetaData struct {
// Search result content.
//
// Types that are valid to be assigned to Content:
//
// *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_
Content isAnswerQueryRequest_EndUserSpec_EndUserMetaData_Content `protobuf_oneof:"content"`
// contains filtered or unexported fields
}End user metadata.
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) Descriptor
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_EndUserSpec_EndUserMetaData.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetChunkInfo
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetChunkInfo() *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfofunc (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetContent
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData) GetContent() isAnswerQueryRequest_EndUserSpec_EndUserMetaData_Contentfunc (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) ProtoMessage
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) ProtoMessage()func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) ProtoReflect
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) Reset
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData) Reset()func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData) String
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData) String() stringAnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo
type AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo struct {
// Chunk textual content. It is limited to 8000 characters.
Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// Metadata of the document from the current chunk.
DocumentMetadata *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata `protobuf:"bytes,2,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
// contains filtered or unexported fields
}Chunk information.
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) Descriptor
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) GetContent
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) GetContent() stringfunc (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) GetDocumentMetadata
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) GetDocumentMetadata() *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadatafunc (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) ProtoMessage
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) ProtoMessage()func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) ProtoReflect
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) Reset
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) Reset()func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) String
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo) String() stringAnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_
type AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_ struct {
// Chunk information.
ChunkInfo *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo `protobuf:"bytes,1,opt,name=chunk_info,json=chunkInfo,proto3,oneof"`
}AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata
type AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata struct {
// Title of the document.
Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
// contains filtered or unexported fields
}Document metadata contains the information of the document of the current chunk.
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) Descriptor
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) GetTitle
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) GetTitle() stringfunc (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) ProtoMessage
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) ProtoMessage()func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) ProtoReflect
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) Reset
func (*AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) String
func (x *AnswerQueryRequest_EndUserSpec_EndUserMetaData_ChunkInfo_DocumentMetadata) String() stringAnswerQueryRequest_GroundingSpec
type AnswerQueryRequest_GroundingSpec struct {
// Optional. Specifies whether to include grounding_supports in the answer.
// The default value is `false`.
//
// When this field is set to `true`, returned answer will have
// `grounding_score` and will contain GroundingSupports for each claim.
IncludeGroundingSupports bool `protobuf:"varint,2,opt,name=include_grounding_supports,json=includeGroundingSupports,proto3" json:"include_grounding_supports,omitempty"`
// Optional. Specifies whether to enable the filtering based on grounding
// score and at what level.
FilteringLevel AnswerQueryRequest_GroundingSpec_FilteringLevel `protobuf:"varint,3,opt,name=filtering_level,json=filteringLevel,proto3,enum=google.cloud.discoveryengine.v1beta.AnswerQueryRequest_GroundingSpec_FilteringLevel" json:"filtering_level,omitempty"`
// contains filtered or unexported fields
}Grounding specification.
func (*AnswerQueryRequest_GroundingSpec) Descriptor
func (*AnswerQueryRequest_GroundingSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_GroundingSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_GroundingSpec) GetFilteringLevel
func (x *AnswerQueryRequest_GroundingSpec) GetFilteringLevel() AnswerQueryRequest_GroundingSpec_FilteringLevelfunc (*AnswerQueryRequest_GroundingSpec) GetIncludeGroundingSupports
func (x *AnswerQueryRequest_GroundingSpec) GetIncludeGroundingSupports() boolfunc (*AnswerQueryRequest_GroundingSpec) ProtoMessage
func (*AnswerQueryRequest_GroundingSpec) ProtoMessage()func (*AnswerQueryRequest_GroundingSpec) ProtoReflect
func (x *AnswerQueryRequest_GroundingSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_GroundingSpec) Reset
func (x *AnswerQueryRequest_GroundingSpec) Reset()func (*AnswerQueryRequest_GroundingSpec) String
func (x *AnswerQueryRequest_GroundingSpec) String() stringAnswerQueryRequest_GroundingSpec_FilteringLevel
type AnswerQueryRequest_GroundingSpec_FilteringLevel int32Level to filter based on answer grounding.
AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_UNSPECIFIED, AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_LOW, AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_HIGH
const (
// Default is no filter
AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_UNSPECIFIED AnswerQueryRequest_GroundingSpec_FilteringLevel = 0
// Filter answers based on a low threshold.
AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_LOW AnswerQueryRequest_GroundingSpec_FilteringLevel = 1
// Filter answers based on a high threshold.
AnswerQueryRequest_GroundingSpec_FILTERING_LEVEL_HIGH AnswerQueryRequest_GroundingSpec_FilteringLevel = 2
)func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Descriptor
func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Descriptor() protoreflect.EnumDescriptorfunc (AnswerQueryRequest_GroundingSpec_FilteringLevel) Enum
func (x AnswerQueryRequest_GroundingSpec_FilteringLevel) Enum() *AnswerQueryRequest_GroundingSpec_FilteringLevelfunc (AnswerQueryRequest_GroundingSpec_FilteringLevel) EnumDescriptor
func (AnswerQueryRequest_GroundingSpec_FilteringLevel) EnumDescriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_GroundingSpec_FilteringLevel.Descriptor instead.
func (AnswerQueryRequest_GroundingSpec_FilteringLevel) Number
func (x AnswerQueryRequest_GroundingSpec_FilteringLevel) Number() protoreflect.EnumNumberfunc (AnswerQueryRequest_GroundingSpec_FilteringLevel) String
func (x AnswerQueryRequest_GroundingSpec_FilteringLevel) String() stringfunc (AnswerQueryRequest_GroundingSpec_FilteringLevel) Type
AnswerQueryRequest_QueryUnderstandingSpec
type AnswerQueryRequest_QueryUnderstandingSpec struct {
// Query classification specification.
QueryClassificationSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec `protobuf:"bytes,1,opt,name=query_classification_spec,json=queryClassificationSpec,proto3" json:"query_classification_spec,omitempty"`
// Query rephraser specification.
QueryRephraserSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec `protobuf:"bytes,2,opt,name=query_rephraser_spec,json=queryRephraserSpec,proto3" json:"query_rephraser_spec,omitempty"`
// Optional. Whether to disable spell correction.
// The default value is `false`.
DisableSpellCorrection bool `protobuf:"varint,3,opt,name=disable_spell_correction,json=disableSpellCorrection,proto3" json:"disable_spell_correction,omitempty"`
// contains filtered or unexported fields
}Query understanding specification.
func (*AnswerQueryRequest_QueryUnderstandingSpec) Descriptor
func (*AnswerQueryRequest_QueryUnderstandingSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_QueryUnderstandingSpec) GetDisableSpellCorrection
func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetDisableSpellCorrection() boolfunc (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec
func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetQueryClassificationSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpecfunc (*AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec
func (x *AnswerQueryRequest_QueryUnderstandingSpec) GetQueryRephraserSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpecfunc (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage
func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoMessage()func (*AnswerQueryRequest_QueryUnderstandingSpec) ProtoReflect
func (x *AnswerQueryRequest_QueryUnderstandingSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_QueryUnderstandingSpec) Reset
func (x *AnswerQueryRequest_QueryUnderstandingSpec) Reset()func (*AnswerQueryRequest_QueryUnderstandingSpec) String
func (x *AnswerQueryRequest_QueryUnderstandingSpec) String() stringAnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec
type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec struct {
// Enabled query classification types.
Types []AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type `protobuf:"varint,1,rep,packed,name=types,proto3,enum=google.cloud.discoveryengine.v1beta.AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type" json:"types,omitempty"`
// contains filtered or unexported fields
}Query classification specification.
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Descriptor
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) GetTypes
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) GetTypes() []AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Typefunc (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoMessage()func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoReflect
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) Reset()func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) String
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec) String() stringAnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type
type AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type int32Query classification types.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_TYPE_UNSPECIFIED, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_ADVERSARIAL_QUERY, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_NON_ANSWER_SEEKING_QUERY, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_JAIL_BREAKING_QUERY, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_NON_ANSWER_SEEKING_QUERY_V2, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_USER_DEFINED_CLASSIFICATION_QUERY
const (
// Unspecified query classification type.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_TYPE_UNSPECIFIED AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 0
// Adversarial query classification type.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_ADVERSARIAL_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 1
// Non-answer-seeking query classification type, for chit chat.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_NON_ANSWER_SEEKING_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 2
// Jail-breaking query classification type.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_JAIL_BREAKING_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 3
// Non-answer-seeking query classification type, for no clear intent.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_NON_ANSWER_SEEKING_QUERY_V2 AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 4
// User defined query classification type.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_USER_DEFINED_CLASSIFICATION_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 5
)func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor() protoreflect.EnumDescriptorfunc (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum
func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Enum() *AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Typefunc (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) EnumDescriptor
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.Descriptor instead.
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number
func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Number() protoreflect.EnumNumberfunc (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String
func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) String() stringfunc (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Type() protoreflect.EnumTypeAnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec
type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec struct {
// Disable query rephraser.
Disable bool `protobuf:"varint,1,opt,name=disable,proto3" json:"disable,omitempty"`
// Max rephrase steps.
// The max number is 5 steps.
// If not set or set to < 1,="" it="" will="" be="" set="" to="" 1="" by="" default.="" maxrephrasesteps="">int32 `protobuf:"varint,2,opt,name=max_rephrase_steps,json=maxRephraseSteps,proto3" json:"max_rephrase_steps,omitempty"`
// Optional. Query Rephraser Model specification.
ModelSpec *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec `protobuf:"bytes,3,opt,name=model_spec,json=modelSpec,proto3" json:"model_spec,omitempty"`
// contains filtered or unexported fields
}Query rephraser specification.
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Descriptor
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetDisable() boolfunc (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetMaxRephraseSteps() int32func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetModelSpec
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) GetModelSpec() *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpecfunc (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoMessage()func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoReflect
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) Reset()func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec) String() stringAnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec
type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec struct {
// Optional. Enabled query rephraser model type. If not set, it will use
// LARGE by default.
ModelType AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType `protobuf:"varint,1,opt,name=model_type,json=modelType,proto3,enum=google.cloud.discoveryengine.v1beta.AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType" json:"model_type,omitempty"`
// contains filtered or unexported fields
}Query Rephraser Model specification.
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) Descriptor
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) GetModelType
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) GetModelType() AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelTypefunc (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) ProtoMessage
func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) ProtoMessage()func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) ProtoReflect
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) Reset
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) Reset()func (*AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) String
func (x *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec) String() stringAnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType
type AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType int32Query rephraser types. Currently only supports single-hop (max_rephrase_steps = 1) model selections. For multi-hop (max_rephrase_steps > 1), there is only one default model.
AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_MODEL_TYPE_UNSPECIFIED, AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_SMALL, AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_LARGE
const (
// Unspecified model type.
AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_MODEL_TYPE_UNSPECIFIED AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType = 0
// Small query rephraser model. Gemini 1.0 XS model.
AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_SMALL AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType = 1
// Large query rephraser model. Gemini 1.0 Pro model.
AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_LARGE AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType = 2
)func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Descriptor
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Descriptor() protoreflect.EnumDescriptorfunc (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Enum
func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Enum() *AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelTypefunc (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) EnumDescriptor
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) EnumDescriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType.Descriptor instead.
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Number
func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Number() protoreflect.EnumNumberfunc (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) String
func (x AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) String() stringfunc (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Type
func (AnswerQueryRequest_QueryUnderstandingSpec_QueryRephraserSpec_ModelSpec_ModelType) Type() protoreflect.EnumTypeAnswerQueryRequest_RelatedQuestionsSpec
type AnswerQueryRequest_RelatedQuestionsSpec struct {
// Enable related questions feature if true.
Enable bool `protobuf:"varint,1,opt,name=enable,proto3" json:"enable,omitempty"`
// contains filtered or unexported fields
}Related questions specification.
func (*AnswerQueryRequest_RelatedQuestionsSpec) Descriptor
func (*AnswerQueryRequest_RelatedQuestionsSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_RelatedQuestionsSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_RelatedQuestionsSpec) GetEnable
func (x *AnswerQueryRequest_RelatedQuestionsSpec) GetEnable() boolfunc (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoMessage
func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoMessage()func (*AnswerQueryRequest_RelatedQuestionsSpec) ProtoReflect
func (x *AnswerQueryRequest_RelatedQuestionsSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_RelatedQuestionsSpec) Reset
func (x *AnswerQueryRequest_RelatedQuestionsSpec) Reset()func (*AnswerQueryRequest_RelatedQuestionsSpec) String
func (x *AnswerQueryRequest_RelatedQuestionsSpec) String() stringAnswerQueryRequest_SafetySpec
type AnswerQueryRequest_SafetySpec struct {
// Enable the safety filtering on the answer response. It is false by
// default.
Enable bool `protobuf:"varint,1,opt,name=enable,proto3" json:"enable,omitempty"`
// Optional. Safety settings.
// This settings are effective only when the safety_spec.enable is true.
SafetySettings []*AnswerQueryRequest_SafetySpec_SafetySetting `protobuf:"bytes,2,rep,name=safety_settings,json=safetySettings,proto3" json:"safety_settings,omitempty"`
// contains filtered or unexported fields
}Safety specification. There are two use cases:
- when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories.
- when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.
func (*AnswerQueryRequest_SafetySpec) Descriptor
func (*AnswerQueryRequest_SafetySpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SafetySpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SafetySpec) GetEnable
func (x *AnswerQueryRequest_SafetySpec) GetEnable() boolfunc (*AnswerQueryRequest_SafetySpec) GetSafetySettings
func (x *AnswerQueryRequest_SafetySpec) GetSafetySettings() []*AnswerQueryRequest_SafetySpec_SafetySettingfunc (*AnswerQueryRequest_SafetySpec) ProtoMessage
func (*AnswerQueryRequest_SafetySpec) ProtoMessage()func (*AnswerQueryRequest_SafetySpec) ProtoReflect
func (x *AnswerQueryRequest_SafetySpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SafetySpec) Reset
func (x *AnswerQueryRequest_SafetySpec) Reset()func (*AnswerQueryRequest_SafetySpec) String
func (x *AnswerQueryRequest_SafetySpec) String() stringAnswerQueryRequest_SafetySpec_SafetySetting
type AnswerQueryRequest_SafetySpec_SafetySetting struct {
// Required. Harm category.
Category HarmCategory `protobuf:"varint,1,opt,name=category,proto3,enum=google.cloud.discoveryengine.v1beta.HarmCategory" json:"category,omitempty"`
// Required. The harm block threshold.
Threshold AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold `protobuf:"varint,2,opt,name=threshold,proto3,enum=google.cloud.discoveryengine.v1beta.AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold" json:"threshold,omitempty"`
// contains filtered or unexported fields
}Safety settings.
func (*AnswerQueryRequest_SafetySpec_SafetySetting) Descriptor
func (*AnswerQueryRequest_SafetySpec_SafetySetting) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SafetySpec_SafetySetting.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SafetySpec_SafetySetting) GetCategory
func (x *AnswerQueryRequest_SafetySpec_SafetySetting) GetCategory() HarmCategoryfunc (*AnswerQueryRequest_SafetySpec_SafetySetting) GetThreshold
func (x *AnswerQueryRequest_SafetySpec_SafetySetting) GetThreshold() AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThresholdfunc (*AnswerQueryRequest_SafetySpec_SafetySetting) ProtoMessage
func (*AnswerQueryRequest_SafetySpec_SafetySetting) ProtoMessage()func (*AnswerQueryRequest_SafetySpec_SafetySetting) ProtoReflect
func (x *AnswerQueryRequest_SafetySpec_SafetySetting) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SafetySpec_SafetySetting) Reset
func (x *AnswerQueryRequest_SafetySpec_SafetySetting) Reset()func (*AnswerQueryRequest_SafetySpec_SafetySetting) String
func (x *AnswerQueryRequest_SafetySpec_SafetySetting) String() stringAnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold
type AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold int32Probability based thresholds levels for blocking.
AnswerQueryRequest_SafetySpec_SafetySetting_HARM_BLOCK_THRESHOLD_UNSPECIFIED, AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_LOW_AND_ABOVE, AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_MEDIUM_AND_ABOVE, AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_ONLY_HIGH, AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_NONE, AnswerQueryRequest_SafetySpec_SafetySetting_OFF
const (
// Unspecified harm block threshold.
AnswerQueryRequest_SafetySpec_SafetySetting_HARM_BLOCK_THRESHOLD_UNSPECIFIED AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 0
// Block low threshold and above (i.e. block more).
AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_LOW_AND_ABOVE AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 1
// Block medium threshold and above.
AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_MEDIUM_AND_ABOVE AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 2
// Block only high threshold (i.e. block less).
AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_ONLY_HIGH AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 3
// Block none.
AnswerQueryRequest_SafetySpec_SafetySetting_BLOCK_NONE AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 4
// Turn off the safety filter.
AnswerQueryRequest_SafetySpec_SafetySetting_OFF AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold = 5
)func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Descriptor
func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Descriptor() protoreflect.EnumDescriptorfunc (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Enum
func (x AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Enum() *AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThresholdfunc (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) EnumDescriptor
func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) EnumDescriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold.Descriptor instead.
func (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Number
func (x AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Number() protoreflect.EnumNumberfunc (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) String
func (x AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) String() stringfunc (AnswerQueryRequest_SafetySpec_SafetySetting_HarmBlockThreshold) Type
AnswerQueryRequest_SearchSpec
type AnswerQueryRequest_SearchSpec struct {
// Search parameters to control the search behavior.
// Or provide search result list to generate answer.
//
// Types that are valid to be assigned to Input:
//
// *AnswerQueryRequest_SearchSpec_SearchParams_
// *AnswerQueryRequest_SearchSpec_SearchResultList_
Input isAnswerQueryRequest_SearchSpec_Input `protobuf_oneof:"input"`
// contains filtered or unexported fields
}Search specification.
func (*AnswerQueryRequest_SearchSpec) Descriptor
func (*AnswerQueryRequest_SearchSpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec) GetInput
func (x *AnswerQueryRequest_SearchSpec) GetInput() isAnswerQueryRequest_SearchSpec_Inputfunc (*AnswerQueryRequest_SearchSpec) GetSearchParams
func (x *AnswerQueryRequest_SearchSpec) GetSearchParams() *AnswerQueryRequest_SearchSpec_SearchParamsfunc (*AnswerQueryRequest_SearchSpec) GetSearchResultList
func (x *AnswerQueryRequest_SearchSpec) GetSearchResultList() *AnswerQueryRequest_SearchSpec_SearchResultListfunc (*AnswerQueryRequest_SearchSpec) ProtoMessage
func (*AnswerQueryRequest_SearchSpec) ProtoMessage()func (*AnswerQueryRequest_SearchSpec) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SearchSpec) Reset
func (x *AnswerQueryRequest_SearchSpec) Reset()func (*AnswerQueryRequest_SearchSpec) String
func (x *AnswerQueryRequest_SearchSpec) String() stringAnswerQueryRequest_SearchSpec_SearchParams
type AnswerQueryRequest_SearchSpec_SearchParams struct {
// Number of search results to return.
// The default value is 10.
MaxReturnResults int32 `protobuf:"varint,1,opt,name=max_return_results,json=maxReturnResults,proto3" json:"max_return_results,omitempty"`
// The filter syntax consists of an expression language for constructing
// a predicate from one or more fields of the documents being filtered.
// Filter expression is case-sensitive. This will be used to filter
// search results which may affect the Answer response.
//
// If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
//
// Filtering in Vertex AI Search is done by mapping the LHS filter key
// to a key property defined in the Vertex AI Search backend -- this
// mapping is defined by the customer in their schema. For example a
// media customers might have a field 'name' in their schema. In this
// case the filter would look like this: filter --> name:'ANY("king
// kong")'
//
// For more information about filtering including syntax and filter
// operators, see
// [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Boost specification to boost certain documents in search results which
// may affect the answer query response. For more information on boosting,
// see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,3,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
// The order in which documents are returned. Documents can be ordered
// by a field in an
// [Document][google.cloud.discoveryengine.v1beta.Document] object. Leave
// it unset if ordered by relevance. `order_by` expression is
// case-sensitive. For more information on ordering, see
// [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
//
// If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// Specifies the search result mode. If unspecified, the
// search result mode defaults to `DOCUMENTS`.
// See [parse and chunk
// documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
SearchResultMode SearchRequest_ContentSearchSpec_SearchResultMode `protobuf:"varint,5,opt,name=search_result_mode,json=searchResultMode,proto3,enum=google.cloud.discoveryengine.v1beta.SearchRequest_ContentSearchSpec_SearchResultMode" json:"search_result_mode,omitempty"`
// Specs defining dataStores to filter on in a search call and
// configurations for those dataStores. This is only considered for
// engines with multiple dataStores use case. For single dataStore within
// an engine, they should use the specs at the top level.
DataStoreSpecs []*SearchRequest_DataStoreSpec `protobuf:"bytes,7,rep,name=data_store_specs,json=dataStoreSpecs,proto3" json:"data_store_specs,omitempty"`
// Optional. Specification to enable natural language understanding
// capabilities for search requests.
NaturalLanguageQueryUnderstandingSpec *SearchRequest_NaturalLanguageQueryUnderstandingSpec `protobuf:"bytes,8,opt,name=natural_language_query_understanding_spec,json=naturalLanguageQueryUnderstandingSpec,proto3" json:"natural_language_query_understanding_spec,omitempty"`
// contains filtered or unexported fields
}Search parameters.
func (*AnswerQueryRequest_SearchSpec_SearchParams) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchParams) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec_SearchParams.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetBoostSpec() *SearchRequest_BoostSpecfunc (*AnswerQueryRequest_SearchSpec_SearchParams) GetDataStoreSpecs
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetDataStoreSpecs() []*SearchRequest_DataStoreSpecfunc (*AnswerQueryRequest_SearchSpec_SearchParams) GetFilter
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetFilter() stringfunc (*AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetMaxReturnResults() int32func (*AnswerQueryRequest_SearchSpec_SearchParams) GetNaturalLanguageQueryUnderstandingSpec
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetNaturalLanguageQueryUnderstandingSpec() *SearchRequest_NaturalLanguageQueryUnderstandingSpecfunc (*AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetOrderBy() stringfunc (*AnswerQueryRequest_SearchSpec_SearchParams) GetSearchResultMode
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetSearchResultMode() SearchRequest_ContentSearchSpec_SearchResultModefunc (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoMessage()func (*AnswerQueryRequest_SearchSpec_SearchParams) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchParams) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SearchSpec_SearchParams) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchParams) Reset()func (*AnswerQueryRequest_SearchSpec_SearchParams) String
func (x *AnswerQueryRequest_SearchSpec_SearchParams) String() stringAnswerQueryRequest_SearchSpec_SearchParams_
type AnswerQueryRequest_SearchSpec_SearchParams_ struct {
// Search parameters.
SearchParams *AnswerQueryRequest_SearchSpec_SearchParams `protobuf:"bytes,1,opt,name=search_params,json=searchParams,proto3,oneof"`
}AnswerQueryRequest_SearchSpec_SearchResultList
type AnswerQueryRequest_SearchSpec_SearchResultList struct {
// Search results.
SearchResults []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult `protobuf:"bytes,1,rep,name=search_results,json=searchResults,proto3" json:"search_results,omitempty"`
// contains filtered or unexported fields
}Search result list.
func (*AnswerQueryRequest_SearchSpec_SearchResultList) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchResultList) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList) GetSearchResults
func (x *AnswerQueryRequest_SearchSpec_SearchResultList) GetSearchResults() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResultfunc (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoMessage()func (*AnswerQueryRequest_SearchSpec_SearchResultList) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SearchSpec_SearchResultList) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList) Reset()func (*AnswerQueryRequest_SearchSpec_SearchResultList) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList) String() stringAnswerQueryRequest_SearchSpec_SearchResultList_
type AnswerQueryRequest_SearchSpec_SearchResultList_ struct {
// Search result list.
SearchResultList *AnswerQueryRequest_SearchSpec_SearchResultList `protobuf:"bytes,2,opt,name=search_result_list,json=searchResultList,proto3,oneof"`
}AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult
type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult struct {
// Search result content.
//
// Types that are valid to be assigned to Content:
//
// *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_
// *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_
Content isAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_Content `protobuf_oneof:"content"`
// contains filtered or unexported fields
}Search result.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetChunkInfo() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfofunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetContent
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetContent() isAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_Contentfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetUnstructuredDocumentInfo
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) GetUnstructuredDocumentInfo() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfofunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoMessage()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) Reset()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult) String() stringAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo
type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo struct {
// Chunk resource name.
Chunk string `protobuf:"bytes,1,opt,name=chunk,proto3" json:"chunk,omitempty"`
// Chunk textual content.
Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
// Metadata of the document from the current chunk.
DocumentMetadata *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata `protobuf:"bytes,4,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
// contains filtered or unexported fields
}Chunk information.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetChunk
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetChunk() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetContent() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetDocumentMetadata
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) GetDocumentMetadata() *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadatafunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoMessage()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) Reset()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo) String() stringAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_
type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_ struct {
// Chunk information.
ChunkInfo *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo `protobuf:"bytes,2,opt,name=chunk_info,json=chunkInfo,proto3,oneof"`
}AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata
type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata struct {
// Uri of the document.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// Title of the document.
Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
// contains filtered or unexported fields
}Document metadata contains the information of the document of the current chunk.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) GetTitle
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) GetTitle() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) GetUri
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) GetUri() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) ProtoMessage()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) Reset()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_ChunkInfo_DocumentMetadata) String() stringAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo
type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo struct {
// Document resource name.
Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// URI for the document.
Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
// Title.
Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
// List of document contexts. The content will be used for Answer
// Generation. This is supposed to be the main content of the document
// that can be long and comprehensive.
DocumentContexts []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext `protobuf:"bytes,4,rep,name=document_contexts,json=documentContexts,proto3" json:"document_contexts,omitempty"`
// List of extractive segments.
ExtractiveSegments []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment `protobuf:"bytes,5,rep,name=extractive_segments,json=extractiveSegments,proto3" json:"extractive_segments,omitempty"`
// Deprecated: This field is deprecated and will have no effect on
// the Answer generation.
// Please use document_contexts and extractive_segments fields.
// List of extractive answers.
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/conversational_search_service.proto.
ExtractiveAnswers []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer `protobuf:"bytes,6,rep,name=extractive_answers,json=extractiveAnswers,proto3" json:"extractive_answers,omitempty"`
// contains filtered or unexported fields
}Unstructured document information.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocumentContexts
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocumentContexts() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContextfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveAnswers
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveAnswers() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswerDeprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/conversational_search_service.proto.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveSegments
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetExtractiveSegments() []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegmentfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetTitle() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetUri() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoMessage()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Reset()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) String() stringAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_
type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ struct {
// Unstructured document information.
UnstructuredDocumentInfo *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo `protobuf:"bytes,1,opt,name=unstructured_document_info,json=unstructuredDocumentInfo,proto3,oneof"`
}AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext
type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext struct {
// Page identifier.
PageIdentifier string `protobuf:"bytes,1,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
// Document content to be used for answer generation.
Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
// contains filtered or unexported fields
}Document context.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetContent
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetContent() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) GetPageIdentifier() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoMessage()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) Reset()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext) String() stringAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer
type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer struct {
// Page identifier.
PageIdentifier string `protobuf:"bytes,1,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
// Extractive answer content.
Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
// contains filtered or unexported fields
}Extractive answer. Guide
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetContent
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetContent() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) GetPageIdentifier() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoMessage()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) Reset()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer) String() stringAnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment
type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment struct {
// Page identifier.
PageIdentifier string `protobuf:"bytes,1,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
// Extractive segment content.
Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
// contains filtered or unexported fields
}Extractive segment. Guide Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetContent
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetContent() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) GetPageIdentifier() stringfunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoMessage()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoReflect
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) Reset()func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment) String() stringAnswerQueryResponse
type AnswerQueryResponse struct {
// Answer resource object.
// If
// [AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps][google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps]
// is greater than 1, use
// [Answer.name][google.cloud.discoveryengine.v1beta.Answer.name] to fetch
// answer information using
// [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetAnswer]
// API.
Answer *Answer `protobuf:"bytes,1,opt,name=answer,proto3" json:"answer,omitempty"`
// Session resource object.
// It will be only available when session field is set and valid in the
// [AnswerQueryRequest][google.cloud.discoveryengine.v1beta.AnswerQueryRequest]
// request.
Session *Session `protobuf:"bytes,2,opt,name=session,proto3" json:"session,omitempty"`
// A global unique ID used for logging.
AnswerQueryToken string `protobuf:"bytes,3,opt,name=answer_query_token,json=answerQueryToken,proto3" json:"answer_query_token,omitempty"`
// contains filtered or unexported fields
}Response message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] method.
func (*AnswerQueryResponse) Descriptor
func (*AnswerQueryResponse) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryResponse.ProtoReflect.Descriptor instead.
func (*AnswerQueryResponse) GetAnswer
func (x *AnswerQueryResponse) GetAnswer() *Answerfunc (*AnswerQueryResponse) GetAnswerQueryToken
func (x *AnswerQueryResponse) GetAnswerQueryToken() stringfunc (*AnswerQueryResponse) GetSession
func (x *AnswerQueryResponse) GetSession() *Sessionfunc (*AnswerQueryResponse) ProtoMessage
func (*AnswerQueryResponse) ProtoMessage()func (*AnswerQueryResponse) ProtoReflect
func (x *AnswerQueryResponse) ProtoReflect() protoreflect.Messagefunc (*AnswerQueryResponse) Reset
func (x *AnswerQueryResponse) Reset()func (*AnswerQueryResponse) String
func (x *AnswerQueryResponse) String() stringAnswer_AnswerSkippedReason
type Answer_AnswerSkippedReason int32An enum for answer skipped reasons.
Answer_ANSWER_SKIPPED_REASON_UNSPECIFIED, Answer_ADVERSARIAL_QUERY_IGNORED, Answer_NON_ANSWER_SEEKING_QUERY_IGNORED, Answer_OUT_OF_DOMAIN_QUERY_IGNORED, Answer_POTENTIAL_POLICY_VIOLATION, Answer_NO_RELEVANT_CONTENT, Answer_JAIL_BREAKING_QUERY_IGNORED, Answer_CUSTOMER_POLICY_VIOLATION, Answer_NON_ANSWER_SEEKING_QUERY_IGNORED_V2, Answer_LOW_GROUNDED_ANSWER, Answer_USER_DEFINED_CLASSIFICATION_QUERY_IGNORED, Answer_UNHELPFUL_ANSWER
const (
// Default value. The answer skipped reason is not specified.
Answer_ANSWER_SKIPPED_REASON_UNSPECIFIED Answer_AnswerSkippedReason = 0
// The adversarial query ignored case.
Answer_ADVERSARIAL_QUERY_IGNORED Answer_AnswerSkippedReason = 1
// The non-answer seeking query ignored case
//
// Google skips the answer if the query is chit chat.
Answer_NON_ANSWER_SEEKING_QUERY_IGNORED Answer_AnswerSkippedReason = 2
// The out-of-domain query ignored case.
//
// Google skips the answer if there are no high-relevance search results.
Answer_OUT_OF_DOMAIN_QUERY_IGNORED Answer_AnswerSkippedReason = 3
// The potential policy violation case.
//
// Google skips the answer if there is a potential policy violation
// detected. This includes content that may be violent or toxic.
Answer_POTENTIAL_POLICY_VIOLATION Answer_AnswerSkippedReason = 4
// The no relevant content case.
//
// Google skips the answer if there is no relevant content in the
// retrieved search results.
Answer_NO_RELEVANT_CONTENT Answer_AnswerSkippedReason = 5
// The jail-breaking query ignored case.
//
// For example, "Reply in the tone of a competing company's CEO".
// Google skips the answer if the query is classified as a jail-breaking
// query.
Answer_JAIL_BREAKING_QUERY_IGNORED Answer_AnswerSkippedReason = 6
// The customer policy violation case.
//
// Google skips the summary if there is a customer policy violation
// detected. The policy is defined by the customer.
Answer_CUSTOMER_POLICY_VIOLATION Answer_AnswerSkippedReason = 7
// The non-answer seeking query ignored case.
//
// Google skips the answer if the query doesn't have clear intent.
Answer_NON_ANSWER_SEEKING_QUERY_IGNORED_V2 Answer_AnswerSkippedReason = 8
// The low-grounded answer case.
//
// Google skips the answer if a well grounded answer was unable to be
// generated.
Answer_LOW_GROUNDED_ANSWER Answer_AnswerSkippedReason = 9
// The user defined query classification ignored case.
//
// Google skips the answer if the query is classified as a user defined
// query classification.
Answer_USER_DEFINED_CLASSIFICATION_QUERY_IGNORED Answer_AnswerSkippedReason = 10
// The unhelpful answer case.
//
// Google skips the answer if the answer is not helpful. This can be due to
// a variety of factors, including but not limited to: the query is not
// answerable, the answer is not relevant to the query, or the answer is
// not well-formatted.
Answer_UNHELPFUL_ANSWER Answer_AnswerSkippedReason = 11
)func (Answer_AnswerSkippedReason) Descriptor
func (Answer_AnswerSkippedReason) Descriptor() protoreflect.EnumDescriptorfunc (Answer_AnswerSkippedReason) Enum
func (x Answer_AnswerSkippedReason) Enum() *Answer_AnswerSkippedReasonfunc (Answer_AnswerSkippedReason) EnumDescriptor
func (Answer_AnswerSkippedReason) EnumDescriptor() ([]byte, []int)Deprecated: Use Answer_AnswerSkippedReason.Descriptor instead.
func (Answer_AnswerSkippedReason) Number
func (x Answer_AnswerSkippedReason) Number() protoreflect.EnumNumberfunc (Answer_AnswerSkippedReason) String
func (x Answer_AnswerSkippedReason) String() stringfunc (Answer_AnswerSkippedReason) Type
func (Answer_AnswerSkippedReason) Type() protoreflect.EnumTypeAnswer_BlobAttachment
type Answer_BlobAttachment struct {
// Output only. The mime type and data of the blob.
Data *Answer_BlobAttachment_Blob `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// Output only. The attribution type of the blob.
AttributionType Answer_BlobAttachment_AttributionType `protobuf:"varint,2,opt,name=attribution_type,json=attributionType,proto3,enum=google.cloud.discoveryengine.v1beta.Answer_BlobAttachment_AttributionType" json:"attribution_type,omitempty"`
// contains filtered or unexported fields
}Stores binarydata attached to text answer, e.g. image, video, audio, etc.
func (*Answer_BlobAttachment) Descriptor
func (*Answer_BlobAttachment) Descriptor() ([]byte, []int)Deprecated: Use Answer_BlobAttachment.ProtoReflect.Descriptor instead.
func (*Answer_BlobAttachment) GetAttributionType
func (x *Answer_BlobAttachment) GetAttributionType() Answer_BlobAttachment_AttributionTypefunc (*Answer_BlobAttachment) GetData
func (x *Answer_BlobAttachment) GetData() *Answer_BlobAttachment_Blobfunc (*Answer_BlobAttachment) ProtoMessage
func (*Answer_BlobAttachment) ProtoMessage()func (*Answer_BlobAttachment) ProtoReflect
func (x *Answer_BlobAttachment) ProtoReflect() protoreflect.Messagefunc (*Answer_BlobAttachment) Reset
func (x *Answer_BlobAttachment) Reset()func (*Answer_BlobAttachment) String
func (x *Answer_BlobAttachment) String() stringAnswer_BlobAttachment_AttributionType
type Answer_BlobAttachment_AttributionType int32The source of the blob.
Answer_BlobAttachment_ATTRIBUTION_TYPE_UNSPECIFIED, Answer_BlobAttachment_CORPUS, Answer_BlobAttachment_GENERATED
const (
// Unspecified attribution type.
Answer_BlobAttachment_ATTRIBUTION_TYPE_UNSPECIFIED Answer_BlobAttachment_AttributionType = 0
// The attachment data is from the corpus.
Answer_BlobAttachment_CORPUS Answer_BlobAttachment_AttributionType = 1
// The attachment data is generated by the model through code
// generation.
Answer_BlobAttachment_GENERATED Answer_BlobAttachment_AttributionType = 2
)func (Answer_BlobAttachment_AttributionType) Descriptor
func (Answer_BlobAttachment_AttributionType) Descriptor() protoreflect.EnumDescriptorfunc (Answer_BlobAttachment_AttributionType) Enum
func (Answer_BlobAttachment_AttributionType) EnumDescriptor
func (Answer_BlobAttachment_AttributionType) EnumDescriptor() ([]byte, []int)Deprecated: Use Answer_BlobAttachment_AttributionType.Descriptor instead.
func (Answer_BlobAttachment_AttributionType) Number
func (x Answer_BlobAttachment_AttributionType) Number() protoreflect.EnumNumberfunc (Answer_BlobAttachment_AttributionType) String
func (x Answer_BlobAttachment_AttributionType) String() stringfunc (Answer_BlobAttachment_AttributionType) Type
func (Answer_BlobAttachment_AttributionType) Type() protoreflect.EnumTypeAnswer_BlobAttachment_Blob
type Answer_BlobAttachment_Blob struct {
// Output only. The media type (MIME type) of the generated or retrieved
// data.
MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// Output only. Raw bytes.
Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}The media type and data of the blob.
func (*Answer_BlobAttachment_Blob) Descriptor
func (*Answer_BlobAttachment_Blob) Descriptor() ([]byte, []int)Deprecated: Use Answer_BlobAttachment_Blob.ProtoReflect.Descriptor instead.
func (*Answer_BlobAttachment_Blob) GetData
func (x *Answer_BlobAttachment_Blob) GetData() []bytefunc (*Answer_BlobAttachment_Blob) GetMimeType
func (x *Answer_BlobAttachment_Blob) GetMimeType() stringfunc (*Answer_BlobAttachment_Blob) ProtoMessage
func (*Answer_BlobAttachment_Blob) ProtoMessage()func (*Answer_BlobAttachment_Blob) ProtoReflect
func (x *Answer_BlobAttachment_Blob) ProtoReflect() protoreflect.Messagefunc (*Answer_BlobAttachment_Blob) Reset
func (x *Answer_BlobAttachment_Blob) Reset()func (*Answer_BlobAttachment_Blob) String
func (x *Answer_BlobAttachment_Blob) String() stringAnswer_Citation
type Answer_Citation struct {
// Index indicates the start of the segment, measured in bytes (UTF-8
// unicode). If there are multi-byte characters,such as non-ASCII
// characters, the index measurement is longer than the string length.
StartIndex int64 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
// End of the attributed segment, exclusive. Measured in bytes (UTF-8
// unicode). If there are multi-byte characters,such as non-ASCII
// characters, the index measurement is longer than the string length.
EndIndex int64 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
// Citation sources for the attributed segment.
Sources []*Answer_CitationSource `protobuf:"bytes,3,rep,name=sources,proto3" json:"sources,omitempty"`
// contains filtered or unexported fields
}Citation info for a segment.
func (*Answer_Citation) Descriptor
func (*Answer_Citation) Descriptor() ([]byte, []int)Deprecated: Use Answer_Citation.ProtoReflect.Descriptor instead.
func (*Answer_Citation) GetEndIndex
func (x *Answer_Citation) GetEndIndex() int64func (*Answer_Citation) GetSources
func (x *Answer_Citation) GetSources() []*Answer_CitationSourcefunc (*Answer_Citation) GetStartIndex
func (x *Answer_Citation) GetStartIndex() int64func (*Answer_Citation) ProtoMessage
func (*Answer_Citation) ProtoMessage()func (*Answer_Citation) ProtoReflect
func (x *Answer_Citation) ProtoReflect() protoreflect.Messagefunc (*Answer_Citation) Reset
func (x *Answer_Citation) Reset()func (*Answer_Citation) String
func (x *Answer_Citation) String() stringAnswer_CitationSource
type Answer_CitationSource struct {
// ID of the citation source.
ReferenceId string `protobuf:"bytes,1,opt,name=reference_id,json=referenceId,proto3" json:"reference_id,omitempty"`
// contains filtered or unexported fields
}Citation source.
func (*Answer_CitationSource) Descriptor
func (*Answer_CitationSource) Descriptor() ([]byte, []int)Deprecated: Use Answer_CitationSource.ProtoReflect.Descriptor instead.
func (*Answer_CitationSource) GetReferenceId
func (x *Answer_CitationSource) GetReferenceId() stringfunc (*Answer_CitationSource) ProtoMessage
func (*Answer_CitationSource) ProtoMessage()func (*Answer_CitationSource) ProtoReflect
func (x *Answer_CitationSource) ProtoReflect() protoreflect.Messagefunc (*Answer_CitationSource) Reset
func (x *Answer_CitationSource) Reset()func (*Answer_CitationSource) String
func (x *Answer_CitationSource) String() stringAnswer_GroundingSupport
type Answer_GroundingSupport struct {
// Required. Index indicates the start of the claim, measured in bytes
// (UTF-8 unicode).
StartIndex int64 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
// Required. End of the claim, exclusive.
EndIndex int64 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
// A score in the range of [0, 1] describing how grounded is a specific
// claim by the references.
// Higher value means that the claim is better supported by the reference
// chunks.
GroundingScore *float64 `protobuf:"fixed64,3,opt,name=grounding_score,json=groundingScore,proto3,oneof" json:"grounding_score,omitempty"`
// Indicates that this claim required grounding check. When the
// system decided this claim didn't require attribution/grounding check,
// this field is set to false. In that case, no grounding check was
// done for the claim and therefore `grounding_score`, `sources` is not
// returned.
GroundingCheckRequired *bool `protobuf:"varint,4,opt,name=grounding_check_required,json=groundingCheckRequired,proto3,oneof" json:"grounding_check_required,omitempty"`
// Optional. Citation sources for the claim.
Sources []*Answer_CitationSource `protobuf:"bytes,5,rep,name=sources,proto3" json:"sources,omitempty"`
// contains filtered or unexported fields
}Grounding support for a claim in answer_text.
func (*Answer_GroundingSupport) Descriptor
func (*Answer_GroundingSupport) Descriptor() ([]byte, []int)Deprecated: Use Answer_GroundingSupport.ProtoReflect.Descriptor instead.
func (*Answer_GroundingSupport) GetEndIndex
func (x *Answer_GroundingSupport) GetEndIndex() int64func (*Answer_GroundingSupport) GetGroundingCheckRequired
func (x *Answer_GroundingSupport) GetGroundingCheckRequired() boolfunc (*Answer_GroundingSupport) GetGroundingScore
func (x *Answer_GroundingSupport) GetGroundingScore() float64func (*Answer_GroundingSupport) GetSources
func (x *Answer_GroundingSupport) GetSources() []*Answer_CitationSourcefunc (*Answer_GroundingSupport) GetStartIndex
func (x *Answer_GroundingSupport) GetStartIndex() int64func (*Answer_GroundingSupport) ProtoMessage
func (*Answer_GroundingSupport) ProtoMessage()func (*Answer_GroundingSupport) ProtoReflect
func (x *Answer_GroundingSupport) ProtoReflect() protoreflect.Messagefunc (*Answer_GroundingSupport) Reset
func (x *Answer_GroundingSupport) Reset()func (*Answer_GroundingSupport) String
func (x *Answer_GroundingSupport) String() stringAnswer_QueryUnderstandingInfo
type Answer_QueryUnderstandingInfo struct {
// Query classification information.
QueryClassificationInfo []*Answer_QueryUnderstandingInfo_QueryClassificationInfo `protobuf:"bytes,1,rep,name=query_classification_info,json=queryClassificationInfo,proto3" json:"query_classification_info,omitempty"`
// contains filtered or unexported fields
}Query understanding information.
func (*Answer_QueryUnderstandingInfo) Descriptor
func (*Answer_QueryUnderstandingInfo) Descriptor() ([]byte, []int)Deprecated: Use Answer_QueryUnderstandingInfo.ProtoReflect.Descriptor instead.
func (*Answer_QueryUnderstandingInfo) GetQueryClassificationInfo
func (x *Answer_QueryUnderstandingInfo) GetQueryClassificationInfo() []*Answer_QueryUnderstandingInfo_QueryClassificationInfofunc (*Answer_QueryUnderstandingInfo) ProtoMessage
func (*Answer_QueryUnderstandingInfo) ProtoMessage()func (*Answer_QueryUnderstandingInfo) ProtoReflect
func (x *Answer_QueryUnderstandingInfo) ProtoReflect() protoreflect.Messagefunc (*Answer_QueryUnderstandingInfo) Reset
func (x *Answer_QueryUnderstandingInfo) Reset()func (*Answer_QueryUnderstandingInfo) String
func (x *Answer_QueryUnderstandingInfo) String() stringAnswer_QueryUnderstandingInfo_QueryClassificationInfo
type Answer_QueryUnderstandingInfo_QueryClassificationInfo struct {
// Query classification type.
Type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1beta.Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type" json:"type,omitempty"`
// Classification output.
Positive bool `protobuf:"varint,2,opt,name=positive,proto3" json:"positive,omitempty"`
// contains filtered or unexported fields
}Query classification information.
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Descriptor
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Descriptor() ([]byte, []int)Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo.ProtoReflect.Descriptor instead.
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive
func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetPositive() boolfunc (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType
func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) GetType() Answer_QueryUnderstandingInfo_QueryClassificationInfo_Typefunc (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage
func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoMessage()func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoReflect
func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) ProtoReflect() protoreflect.Messagefunc (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset
func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) Reset()func (*Answer_QueryUnderstandingInfo_QueryClassificationInfo) String
func (x *Answer_QueryUnderstandingInfo_QueryClassificationInfo) String() stringAnswer_QueryUnderstandingInfo_QueryClassificationInfo_Type
type Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type int32Query classification types.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_TYPE_UNSPECIFIED, Answer_QueryUnderstandingInfo_QueryClassificationInfo_ADVERSARIAL_QUERY, Answer_QueryUnderstandingInfo_QueryClassificationInfo_NON_ANSWER_SEEKING_QUERY, Answer_QueryUnderstandingInfo_QueryClassificationInfo_JAIL_BREAKING_QUERY, Answer_QueryUnderstandingInfo_QueryClassificationInfo_NON_ANSWER_SEEKING_QUERY_V2, Answer_QueryUnderstandingInfo_QueryClassificationInfo_USER_DEFINED_CLASSIFICATION_QUERY
const (
// Unspecified query classification type.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_TYPE_UNSPECIFIED Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 0
// Adversarial query classification type.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_ADVERSARIAL_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 1
// Non-answer-seeking query classification type, for chit chat.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_NON_ANSWER_SEEKING_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 2
// Jail-breaking query classification type.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_JAIL_BREAKING_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 3
// Non-answer-seeking query classification type, for no clear intent.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_NON_ANSWER_SEEKING_QUERY_V2 Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 4
// User defined query classification type.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_USER_DEFINED_CLASSIFICATION_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 5
)func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor() protoreflect.EnumDescriptorfunc (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum
func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Enum() *Answer_QueryUnderstandingInfo_QueryClassificationInfo_Typefunc (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) EnumDescriptor
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.Descriptor instead.
func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number
func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Number() protoreflect.EnumNumberfunc (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) String
func (x Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) String() stringfunc (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Type
Answer_Reference
type Answer_Reference struct {
// Search result content.
//
// Types that are valid to be assigned to Content:
//
// *Answer_Reference_UnstructuredDocumentInfo_
// *Answer_Reference_ChunkInfo_
// *Answer_Reference_StructuredDocumentInfo_
Content isAnswer_Reference_Content `protobuf_oneof:"content"`
// contains filtered or unexported fields
}Reference.
func (*Answer_Reference) Descriptor
func (*Answer_Reference) Descriptor() ([]byte, []int)Deprecated: Use Answer_Reference.ProtoReflect.Descriptor instead.
func (*Answer_Reference) GetChunkInfo
func (x *Answer_Reference) GetChunkInfo() *Answer_Reference_ChunkInfofunc (*Answer_Reference) GetContent
func (x *Answer_Reference) GetContent() isAnswer_Reference_Contentfunc (*Answer_Reference) GetStructuredDocumentInfo
func (x *Answer_Reference) GetStructuredDocumentInfo() *Answer_Reference_StructuredDocumentInfofunc (*Answer_Reference) GetUnstructuredDocumentInfo
func (x *Answer_Reference) GetUnstructuredDocumentInfo() *Answer_Reference_UnstructuredDocumentInfofunc (*Answer_Reference) ProtoMessage
func (*Answer_Reference) ProtoMessage()func (*Answer_Reference) ProtoReflect
func (x *Answer_Reference) ProtoReflect() protoreflect.Messagefunc (*Answer_Reference) Reset
func (x *Answer_Reference) Reset()func (*Answer_Reference) String
func (x *Answer_Reference) String() stringAnswer_Reference_ChunkInfo
type Answer_Reference_ChunkInfo struct {
// Chunk resource name.
Chunk string `protobuf:"bytes,1,opt,name=chunk,proto3" json:"chunk,omitempty"`
// Chunk textual content.
Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
// The relevance of the chunk for a given query. Values range from 0.0
// (completely irrelevant) to 1.0 (completely relevant).
// This value is for informational purpose only. It may change for
// the same query and chunk at any time due to a model retraining or
// change in implementation.
RelevanceScore *float32 `protobuf:"fixed32,3,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
// Document metadata.
DocumentMetadata *Answer_Reference_ChunkInfo_DocumentMetadata `protobuf:"bytes,4,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
// Output only. Stores indexes of blobattachments linked to this chunk.
BlobAttachmentIndexes []int64 `protobuf:"varint,5,rep,packed,name=blob_attachment_indexes,json=blobAttachmentIndexes,proto3" json:"blob_attachment_indexes,omitempty"`
// contains filtered or unexported fields
}Chunk information.
func (*Answer_Reference_ChunkInfo) Descriptor
func (*Answer_Reference_ChunkInfo) Descriptor() ([]byte, []int)Deprecated: Use Answer_Reference_ChunkInfo.ProtoReflect.Descriptor instead.
func (*Answer_Reference_ChunkInfo) GetBlobAttachmentIndexes
func (x *Answer_Reference_ChunkInfo) GetBlobAttachmentIndexes() []int64func (*Answer_Reference_ChunkInfo) GetChunk
func (x *Answer_Reference_ChunkInfo) GetChunk() stringfunc (*Answer_Reference_ChunkInfo) GetContent
func (x *Answer_Reference_ChunkInfo) GetContent() stringfunc (*Answer_Reference_ChunkInfo) GetDocumentMetadata
func (x *Answer_Reference_ChunkInfo) GetDocumentMetadata() *Answer_Reference_ChunkInfo_DocumentMetadatafunc (*Answer_Reference_ChunkInfo) GetRelevanceScore
func (x *Answer_Reference_ChunkInfo) GetRelevanceScore() float32func (*Answer_Reference_ChunkInfo) ProtoMessage
func (*Answer_Reference_ChunkInfo) ProtoMessage()func (*Answer_Reference_ChunkInfo) ProtoReflect
func (x *Answer_Reference_ChunkInfo) ProtoReflect() protoreflect.Messagefunc (*Answer_Reference_ChunkInfo) Reset
func (x *Answer_Reference_ChunkInfo) Reset()func (*Answer_Reference_ChunkInfo) String
func (x *Answer_Reference_ChunkInfo) String() stringAnswer_Reference_ChunkInfo_
type Answer_Reference_ChunkInfo_ struct {
// Chunk information.
ChunkInfo *Answer_Reference_ChunkInfo `protobuf:"bytes,2,opt,name=chunk_info,json=chunkInfo,proto3,oneof"`
}Answer_Reference_ChunkInfo_DocumentMetadata
type Answer_Reference_ChunkInfo_DocumentMetadata struct {
// Document resource name.
Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// URI for the document.
Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
// Title.
Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
// Page identifier.
PageIdentifier string `protobuf:"bytes,4,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
// The structured JSON metadata for the document.
// It is populated from the struct data from the Chunk in search result.
StructData *structpb.Struct `protobuf:"bytes,5,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
// contains filtered or unexported fields
}Document metadata.
func (*Answer_Reference_ChunkInfo_DocumentMetadata) Descriptor
func (*Answer_Reference_ChunkInfo_DocumentMetadata) Descriptor() ([]byte, []int)Deprecated: Use Answer_Reference_ChunkInfo_DocumentMetadata.ProtoReflect.Descriptor instead.
func (*Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetDocument() stringfunc (*Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetPageIdentifier() stringfunc (*Answer_Reference_ChunkInfo_DocumentMetadata) GetStructData
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetStructData() *structpb.Structfunc (*Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetTitle() stringfunc (*Answer_Reference_ChunkInfo_DocumentMetadata) GetUri
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) GetUri() stringfunc (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage
func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoMessage()func (*Answer_Reference_ChunkInfo_DocumentMetadata) ProtoReflect
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) ProtoReflect() protoreflect.Messagefunc (*Answer_Reference_ChunkInfo_DocumentMetadata) Reset
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) Reset()func (*Answer_Reference_ChunkInfo_DocumentMetadata) String
func (x *Answer_Reference_ChunkInfo_DocumentMetadata) String() stringAnswer_Reference_StructuredDocumentInfo
type Answer_Reference_StructuredDocumentInfo struct {
// Document resource name.
Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// Structured search data.
StructData *structpb.Struct `protobuf:"bytes,2,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
// Output only. The title of the document.
Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
// Output only. The URI of the document.
Uri string `protobuf:"bytes,4,opt,name=uri,proto3" json:"uri,omitempty"`
// contains filtered or unexported fields
}Structured search information.
func (*Answer_Reference_StructuredDocumentInfo) Descriptor
func (*Answer_Reference_StructuredDocumentInfo) Descriptor() ([]byte, []int)Deprecated: Use Answer_Reference_StructuredDocumentInfo.ProtoReflect.Descriptor instead.
func (*Answer_Reference_StructuredDocumentInfo) GetDocument
func (x *Answer_Reference_StructuredDocumentInfo) GetDocument() stringfunc (*Answer_Reference_StructuredDocumentInfo) GetStructData
func (x *Answer_Reference_StructuredDocumentInfo) GetStructData() *structpb.Structfunc (*Answer_Reference_StructuredDocumentInfo) GetTitle
func (x *Answer_Reference_StructuredDocumentInfo) GetTitle() stringfunc (*Answer_Reference_StructuredDocumentInfo) GetUri
func (x *Answer_Reference_StructuredDocumentInfo) GetUri() stringfunc (*Answer_Reference_StructuredDocumentInfo) ProtoMessage
func (*Answer_Reference_StructuredDocumentInfo) ProtoMessage()func (*Answer_Reference_StructuredDocumentInfo) ProtoReflect
func (x *Answer_Reference_StructuredDocumentInfo) ProtoReflect() protoreflect.Messagefunc (*Answer_Reference_StructuredDocumentInfo) Reset
func (x *Answer_Reference_StructuredDocumentInfo) Reset()func (*Answer_Reference_StructuredDocumentInfo) String
func (x *Answer_Reference_StructuredDocumentInfo) String() stringAnswer_Reference_StructuredDocumentInfo_
type Answer_Reference_StructuredDocumentInfo_ struct {
// Structured document information.
StructuredDocumentInfo *Answer_Reference_StructuredDocumentInfo `protobuf:"bytes,3,opt,name=structured_document_info,json=structuredDocumentInfo,proto3,oneof"`
}Answer_Reference_UnstructuredDocumentInfo
type Answer_Reference_UnstructuredDocumentInfo struct {
// Document resource name.
Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// URI for the document.
Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
// Title.
Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
// List of cited chunk contents derived from document content.
ChunkContents []*Answer_Reference_UnstructuredDocumentInfo_ChunkContent `protobuf:"bytes,4,rep,name=chunk_contents,json=chunkContents,proto3" json:"chunk_contents,omitempty"`
// The structured JSON metadata for the document.
// It is populated from the struct data from the Chunk in search result.
StructData *structpb.Struct `protobuf:"bytes,5,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
// contains filtered or unexported fields
}Unstructured document information.
func (*Answer_Reference_UnstructuredDocumentInfo) Descriptor
func (*Answer_Reference_UnstructuredDocumentInfo) Descriptor() ([]byte, []int)Deprecated: Use Answer_Reference_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.
func (*Answer_Reference_UnstructuredDocumentInfo) GetChunkContents
func (x *Answer_Reference_UnstructuredDocumentInfo) GetChunkContents() []*Answer_Reference_UnstructuredDocumentInfo_ChunkContentfunc (*Answer_Reference_UnstructuredDocumentInfo) GetDocument
func (x *Answer_Reference_UnstructuredDocumentInfo) GetDocument() stringfunc (*Answer_Reference_UnstructuredDocumentInfo) GetStructData
func (x *Answer_Reference_UnstructuredDocumentInfo) GetStructData() *structpb.Structfunc (*Answer_Reference_UnstructuredDocumentInfo) GetTitle
func (x *Answer_Reference_UnstructuredDocumentInfo) GetTitle() stringfunc (*Answer_Reference_UnstructuredDocumentInfo) GetUri
func (x *Answer_Reference_UnstructuredDocumentInfo) GetUri() stringfunc (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage
func (*Answer_Reference_UnstructuredDocumentInfo) ProtoMessage()func (*Answer_Reference_UnstructuredDocumentInfo) ProtoReflect
func (x *Answer_Reference_UnstructuredDocumentInfo) ProtoReflect() protoreflect.Messagefunc (*Answer_Reference_UnstructuredDocumentInfo) Reset
func (x *Answer_Reference_UnstructuredDocumentInfo) Reset()func (*Answer_Reference_UnstructuredDocumentInfo) String
func (x *Answer_Reference_UnstructuredDocumentInfo) String() stringAnswer_Reference_UnstructuredDocumentInfo_
type Answer_Reference_UnstructuredDocumentInfo_ struct {
// Unstructured document information.
UnstructuredDocumentInfo *Answer_Reference_UnstructuredDocumentInfo `protobuf:"bytes,1,opt,name=unstructured_document_info,json=unstructuredDocumentInfo,proto3,oneof"`
}Answer_Reference_UnstructuredDocumentInfo_ChunkContent
type Answer_Reference_UnstructuredDocumentInfo_ChunkContent struct {
// Chunk textual content.
Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// Page identifier.
PageIdentifier string `protobuf:"bytes,2,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
// The relevance of the chunk for a given query. Values range from 0.0
// (completely irrelevant) to 1.0 (completely relevant).
// This value is for informational purpose only. It may change for
// the same query and chunk at any time due to a model retraining or
// change in implementation.
RelevanceScore *float32 `protobuf:"fixed32,3,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
// Output only. Stores indexes of blobattachments linked to this chunk.
BlobAttachmentIndexes []int64 `protobuf:"varint,4,rep,packed,name=blob_attachment_indexes,json=blobAttachmentIndexes,proto3" json:"blob_attachment_indexes,omitempty"`
// contains filtered or unexported fields
}Chunk content.
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Descriptor
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Descriptor() ([]byte, []int)Deprecated: Use Answer_Reference_UnstructuredDocumentInfo_ChunkContent.ProtoReflect.Descriptor instead.
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetBlobAttachmentIndexes
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetBlobAttachmentIndexes() []int64func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent() stringfunc (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetPageIdentifier() stringfunc (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetRelevanceScore
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetRelevanceScore() float32func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoMessage()func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoReflect
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) ProtoReflect() protoreflect.Messagefunc (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Reset()func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) String
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) String() stringAnswer_State
type Answer_State int32Enumeration of the state of the answer generation.
Answer_STATE_UNSPECIFIED, Answer_IN_PROGRESS, Answer_FAILED, Answer_SUCCEEDED, Answer_STREAMING
const (
// Unknown.
Answer_STATE_UNSPECIFIED Answer_State = 0
// Answer generation is currently in progress.
Answer_IN_PROGRESS Answer_State = 1
// Answer generation currently failed.
Answer_FAILED Answer_State = 2
// Answer generation has succeeded.
Answer_SUCCEEDED Answer_State = 3
// Answer generation is currently in progress.
Answer_STREAMING Answer_State = 4
)func (Answer_State) Descriptor
func (Answer_State) Descriptor() protoreflect.EnumDescriptorfunc (Answer_State) Enum
func (x Answer_State) Enum() *Answer_Statefunc (Answer_State) EnumDescriptor
func (Answer_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Answer_State.Descriptor instead.
func (Answer_State) Number
func (x Answer_State) Number() protoreflect.EnumNumberfunc (Answer_State) String
func (x Answer_State) String() stringfunc (Answer_State) Type
func (Answer_State) Type() protoreflect.EnumTypeAnswer_Step
type Answer_Step struct {
// The state of the step.
State Answer_Step_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1beta.Answer_Step_State" json:"state,omitempty"`
// The description of the step.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// The thought of the step.
Thought string `protobuf:"bytes,3,opt,name=thought,proto3" json:"thought,omitempty"`
// Actions.
Actions []*Answer_Step_Action `protobuf:"bytes,4,rep,name=actions,proto3" json:"actions,omitempty"`
// contains filtered or unexported fields
}Step information.
func (*Answer_Step) Descriptor
func (*Answer_Step) Descriptor() ([]byte, []int)Deprecated: Use Answer_Step.ProtoReflect.Descriptor instead.
func (*Answer_Step) GetActions
func (x *Answer_Step) GetActions() []*Answer_Step_Actionfunc (*Answer_Step) GetDescription
func (x *Answer_Step) GetDescription() stringfunc (*Answer_Step) GetState
func (x *Answer_Step) GetState() Answer_Step_Statefunc (*Answer_Step) GetThought
func (x *Answer_Step) GetThought() stringfunc (*Answer_Step) ProtoMessage
func (*Answer_Step) ProtoMessage()func (*Answer_Step) ProtoReflect
func (x *Answer_Step) ProtoReflect() protoreflect.Messagefunc (*Answer_Step) Reset
func (x *Answer_Step) Reset()func (*Answer_Step) String
func (x *Answer_Step) String() stringAnswer_Step_Action
type Answer_Step_Action struct {
// The action.
//
// Types that are valid to be assigned to Action:
//
// *Answer_Step_Action_SearchAction_
Action isAnswer_Step_Action_Action `protobuf_oneof:"action"`
// Observation.
Observation *Answer_Step_Action_Observation `protobuf:"bytes,3,opt,name=observation,proto3" json:"observation,omitempty"`
// contains filtered or unexported fields
}Action.
func (*Answer_Step_Action) Descriptor
func (*Answer_Step_Action) Descriptor() ([]byte, []int)Deprecated: Use Answer_Step_Action.ProtoReflect.Descriptor instead.
func (*Answer_Step_Action) GetAction
func (x *Answer_Step_Action) GetAction() isAnswer_Step_Action_Actionfunc (*Answer_Step_Action) GetObservation
func (x *Answer_Step_Action) GetObservation() *Answer_Step_Action_Observationfunc (*Answer_Step_Action) GetSearchAction
func (x *Answer_Step_Action) GetSearchAction() *Answer_Step_Action_SearchActionfunc (*Answer_Step_Action) ProtoMessage
func (*Answer_Step_Action) ProtoMessage()func (*Answer_Step_Action) ProtoReflect
func (x *Answer_Step_Action) ProtoReflect() protoreflect.Messagefunc (*Answer_Step_Action) Reset
func (x *Answer_Step_Action) Reset()func (*Answer_Step_Action) String
func (x *Answer_Step_Action) String() stringAnswer_Step_Action_Observation
type Answer_Step_Action_Observation struct {
// Search results observed by the search action, it can be snippets info
// or chunk info, depending on the citation type set by the user.
SearchResults []*Answer_Step_Action_Observation_SearchResult `protobuf:"bytes,2,rep,name=search_results,json=searchResults,proto3" json:"search_results,omitempty"`
// contains filtered or unexported fields
}Observation.
func (*Answer_Step_Action_Observation) Descriptor
func (*Answer_Step_Action_Observation) Descriptor() ([]byte, []int)Deprecated: Use Answer_Step_Action_Observation.ProtoReflect.Descriptor instead.
func (*Answer_Step_Action_Observation) GetSearchResults
func (x *Answer_Step_Action_Observation) GetSearchResults() []*Answer_Step_Action_Observation_SearchResultfunc (*Answer_Step_Action_Observation) ProtoMessage
func (*Answer_Step_Action_Observation) ProtoMessage()func (*Answer_Step_Action_Observation) ProtoReflect
func (x *Answer_Step_Action_Observation) ProtoReflect() protoreflect.Messagefunc (*Answer_Step_Action_Observation) Reset
func (x *Answer_Step_Action_Observation) Reset()func (*Answer_Step_Action_Observation) String
func (x *Answer_Step_Action_Observation) String() stringAnswer_Step_Action_Observation_SearchResult
type Answer_Step_Action_Observation_SearchResult struct {
// Document resource name.
Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// URI for the document.
Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
// Title.
Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
// If citation_type is DOCUMENT_LEVEL_CITATION, populate document
// level snippets.
SnippetInfo []*Answer_Step_Action_Observation_SearchResult_SnippetInfo `protobuf:"bytes,4,rep,name=snippet_info,json=snippetInfo,proto3" json:"snippet_info,omitempty"`
// If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on,
// populate chunk info.
ChunkInfo []*Answer_Step_Action_Observation_SearchResult_ChunkInfo `protobuf:"bytes,5,rep,name=chunk_info,json=chunkInfo,proto3" json:"chunk_info,omitempty"`
// Data representation.
// The structured JSON data for the document.
// It's populated from the struct data from the Document, or the
// Chunk in search result.
StructData *structpb.Struct `protobuf:"bytes,6,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
// contains filtered or unexported fields
}func (*Answer_Step_Action_Observation_SearchResult) Descriptor
func (*Answer_Step_Action_Observation_SearchResult) Descriptor() ([]byte, []int)Deprecated: Use Answer_Step_Action_Observation_SearchResult.ProtoReflect.Descriptor instead.
func (*Answer_Step_Action_Observation_SearchResult) GetChunkInfo
func (x *Answer_Step_Action_Observation_SearchResult) GetChunkInfo() []*Answer_Step_Action_Observation_SearchResult_ChunkInfofunc (*Answer_Step_Action_Observation_SearchResult) GetDocument
func (x *Answer_Step_Action_Observation_SearchResult) GetDocument() stringfunc (*Answer_Step_Action_Observation_SearchResult) GetSnippetInfo
func (x *Answer_Step_Action_Observation_SearchResult) GetSnippetInfo() []*Answer_Step_Action_Observation_SearchResult_SnippetInfofunc (*Answer_Step_Action_Observation_SearchResult) GetStructData
func (x *Answer_Step_Action_Observation_SearchResult) GetStructData() *structpb.Structfunc (*Answer_Step_Action_Observation_SearchResult) GetTitle
func (x *Answer_Step_Action_Observation_SearchResult) GetTitle() stringfunc (*Answer_Step_Action_Observation_SearchResult) GetUri
func (x *Answer_Step_Action_Observation_SearchResult) GetUri() stringfunc (*Answer_Step_Action_Observation_SearchResult) ProtoMessage
func (*Answer_Step_Action_Observation_SearchResult) ProtoMessage()func (*Answer_Step_Action_Observation_SearchResult) ProtoReflect
func (x *Answer_Step_Action_Observation_SearchResult) ProtoReflect() protoreflect.Messagefunc (*Answer_Step_Action_Observation_SearchResult) Reset
func (x *Answer_Step_Action_Observation_SearchResult) Reset()func (*Answer_Step_Action_Observation_SearchResult) String
func (x *Answer_Step_Action_Observation_SearchResult) String() stringAnswer_Step_Action_Observation_SearchResult_ChunkInfo
type Answer_Step_Action_Observation_SearchResult_ChunkInfo struct {
// Chunk resource name.
Chunk string `protobuf:"bytes,1,opt,name=chunk,proto3" json:"chunk,omitempty"`
// Chunk textual content.
Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
// The relevance of the chunk for a given query. Values range from
// 0.0 (completely irrelevant) to 1.0 (completely relevant).
// This value is for informational purpose only. It may change for
// the same query and chunk at any time due to a model retraining or
// change in implementation.
RelevanceScore *float32 `protobuf:"fixed32,3,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
// contains filtered or unexported fields
}Chunk information.
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) Descriptor
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) Descriptor() ([]byte, []int)Deprecated: Use Answer_Step_Action_Observation_SearchResult_ChunkInfo.ProtoReflect.Descriptor instead.
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetChunk
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetChunk() stringfunc (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetContent() stringfunc (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) GetRelevanceScore() float32func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage
func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoMessage()func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoReflect
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) ProtoReflect() protoreflect.Messagefunc (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) Reset()func (*Answer_Step_Action_Observation_SearchResult_ChunkInfo) String
func (x *Answer_Step_Action_Observation_SearchResult_ChunkInfo) String() stringAnswer_Step_Action_Observation_SearchResult_SnippetInfo
type Answer_Step_Action_Observation_SearchResult_SnippetInfo struct {
// Snippet content.
Snippet string `protobuf:"bytes,1,opt,name=snippet,proto3" json:"snippet,omitempty"`
// Status of the snippet defined by the search team.
SnippetStatus string `protobuf:"bytes,2,opt,name=snippet_status,json=snippetStatus,proto3" json:"snippet_status,omitempty"`
// contains filtered or unexported fields
}Snippet information.
func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) Descriptor
func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) Descriptor() ([]byte, []int)Deprecated: Use Answer_Step_Action_Observation_SearchResult_SnippetInfo.ProtoReflect.Descriptor instead.
func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippet
func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippet() stringfunc (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus
func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) GetSnippetStatus() stringfunc (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage
func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoMessage()func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoReflect
func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) ProtoReflect() protoreflect.Messagefunc (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset
func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) Reset()func (*Answer_Step_Action_Observation_SearchResult_SnippetInfo) String
func (x *Answer_Step_Action_Observation_SearchResult_SnippetInfo) String() stringAnswer_Step_Action_SearchAction
type Answer_Step_Action_SearchAction struct {
// The query to search.
Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
// contains filtered or unexported fields
}Search action.
func (*Answer_Step_Action_SearchAction) Descriptor
func (*Answer_Step_Action_SearchAction) Descriptor() ([]byte, []int)Deprecated: Use Answer_Step_Action_SearchAction.ProtoReflect.Descriptor instead.
func (*Answer_Step_Action_SearchAction) GetQuery
func (x *Answer_Step_Action_SearchAction) GetQuery() stringfunc (*Answer_Step_Action_SearchAction) ProtoMessage
func (*Answer_Step_Action_SearchAction) ProtoMessage()func (*Answer_Step_Action_SearchAction) ProtoReflect
func (x *Answer_Step_Action_SearchAction) ProtoReflect() protoreflect.Messagefunc (*Answer_Step_Action_SearchAction) Reset
func (x *Answer_Step_Action_SearchAction) Reset()func (*Answer_Step_Action_SearchAction) String
func (x *Answer_Step_Action_SearchAction) String() stringAnswer_Step_Action_SearchAction_
type Answer_Step_Action_SearchAction_ struct {
// Search action.
SearchAction *Answer_Step_Action_SearchAction `protobuf:"bytes,2,opt,name=search_action,json=searchAction,proto3,oneof"`
}Answer_Step_State
type Answer_Step_State int32Enumeration of the state of the step.
Answer_Step_STATE_UNSPECIFIED, Answer_Step_IN_PROGRESS, Answer_Step_FAILED, Answer_Step_SUCCEEDED
const (
// Unknown.
Answer_Step_STATE_UNSPECIFIED Answer_Step_State = 0
// Step is currently in progress.
Answer_Step_IN_PROGRESS Answer_Step_State = 1
// Step currently failed.
Answer_Step_FAILED Answer_Step_State = 2
// Step has succeeded.
Answer_Step_SUCCEEDED Answer_Step_State = 3
)func (Answer_Step_State) Descriptor
func (Answer_Step_State) Descriptor() protoreflect.EnumDescriptorfunc (Answer_Step_State) Enum
func (x Answer_Step_State) Enum() *Answer_Step_Statefunc (Answer_Step_State) EnumDescriptor
func (Answer_Step_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Answer_Step_State.Descriptor instead.
func (Answer_Step_State) Number
func (x Answer_Step_State) Number() protoreflect.EnumNumberfunc (Answer_Step_State) String
func (x Answer_Step_State) String() stringfunc (Answer_Step_State) Type
func (Answer_Step_State) Type() protoreflect.EnumTypeAssistAnswer
type AssistAnswer struct {
// Immutable. Identifier. Resource name of the `AssistAnswer`.
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// State of the answer generation.
State AssistAnswer_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1beta.AssistAnswer_State" json:"state,omitempty"`
// Replies of the assistant.
Replies []*AssistAnswer_Reply `protobuf:"bytes,3,rep,name=replies,proto3" json:"replies,omitempty"`
// Reasons for not answering the assist call.
AssistSkippedReasons []AssistAnswer_AssistSkippedReason `protobuf:"varint,5,rep,packed,name=assist_skipped_reasons,json=assistSkippedReasons,proto3,enum=google.cloud.discoveryengine.v1beta.AssistAnswer_AssistSkippedReason" json:"assist_skipped_reasons,omitempty"`
// Optional. The field contains information about the various policy checks'
// results like the banned phrases or the Model Armor checks. This field is
// populated only if the assist call was skipped due to a policy violation.
CustomerPolicyEnforcementResult *AssistAnswer_CustomerPolicyEnforcementResult `protobuf:"bytes,8,opt,name=customer_policy_enforcement_result,json=customerPolicyEnforcementResult,proto3" json:"customer_policy_enforcement_result,omitempty"`
// contains filtered or unexported fields
}AssistAnswer resource, main part of [AssistResponse][google.cloud.discoveryengine.v1beta.AssistResponse].
func (*AssistAnswer) Descriptor
func (*AssistAnswer) Descriptor() ([]byte, []int)Deprecated: Use AssistAnswer.ProtoReflect.Descriptor instead.
func (*AssistAnswer) GetAssistSkippedReasons
func (x *AssistAnswer) GetAssistSkippedReasons() []AssistAnswer_AssistSkippedReasonfunc (*AssistAnswer) GetCustomerPolicyEnforcementResult
func (x *AssistAnswer) GetCustomerPolicyEnforcementResult() *AssistAnswer_CustomerPolicyEnforcementResultfunc (*AssistAnswer) GetName
func (x *AssistAnswer) GetName() stringfunc (*AssistAnswer) GetReplies
func (x *AssistAnswer) GetReplies() []*AssistAnswer_Replyfunc (*AssistAnswer) GetState
func (x *AssistAnswer) GetState() AssistAnswer_Statefunc (*AssistAnswer) ProtoMessage
func (*AssistAnswer) ProtoMessage()func (*AssistAnswer) ProtoReflect
func (x *AssistAnswer) ProtoReflect() protoreflect.Messagefunc (*AssistAnswer) Reset
func (x *AssistAnswer) Reset()func (*AssistAnswer) String
func (x *AssistAnswer) String() stringAssistAnswer_AssistSkippedReason
type AssistAnswer_AssistSkippedReason int32Possible reasons for not answering an assist call.
AssistAnswer_ASSIST_SKIPPED_REASON_UNSPECIFIED, AssistAnswer_NON_ASSIST_SEEKING_QUERY_IGNORED, AssistAnswer_CUSTOMER_POLICY_VIOLATION
const (
// Default value. Skip reason is not specified.
AssistAnswer_ASSIST_SKIPPED_REASON_UNSPECIFIED AssistAnswer_AssistSkippedReason = 0
// The assistant ignored the query, because it did not appear to be
// answer-seeking.
AssistAnswer_NON_ASSIST_SEEKING_QUERY_IGNORED AssistAnswer_AssistSkippedReason = 1
// The assistant ignored the query or refused to answer because of a
// customer policy violation (e.g., the query or the answer contained a
// banned phrase).
AssistAnswer_CUSTOMER_POLICY_VIOLATION AssistAnswer_AssistSkippedReason = 2
)func (AssistAnswer_AssistSkippedReason) Descriptor
func (AssistAnswer_AssistSkippedReason) Descriptor() protoreflect.EnumDescriptorfunc (AssistAnswer_AssistSkippedReason) Enum
func (x AssistAnswer_AssistSkippedReason) Enum() *AssistAnswer_AssistSkippedReasonfunc (AssistAnswer_AssistSkippedReason) EnumDescriptor
func (AssistAnswer_AssistSkippedReason) EnumDescriptor() ([]byte, []int)Deprecated: Use AssistAnswer_AssistSkippedReason.Descriptor instead.
func (AssistAnswer_AssistSkippedReason) Number
func (x AssistAnswer_AssistSkippedReason) Number() protoreflect.EnumNumberfunc (AssistAnswer_AssistSkippedReason) String
func (x AssistAnswer_AssistSkippedReason) String() stringfunc (AssistAnswer_AssistSkippedReason) Type
func (AssistAnswer_AssistSkippedReason) Type() protoreflect.EnumTypeAssistAnswer_CustomerPolicyEnforcementResult
type AssistAnswer_CustomerPolicyEnforcementResult struct {
// Final verdict of the customer policy enforcement. If only one policy
// blocked the processing, the verdict is BLOCK.
Verdict AssistAnswer_CustomerPolicyEnforcementResult_Verdict `protobuf:"varint,1,opt,name=verdict,proto3,enum=google.cloud.discoveryengine.v1beta.AssistAnswer_CustomerPolicyEnforcementResult_Verdict" json:"verdict,omitempty"`
// Customer policy enforcement results.
// Populated only if the assist call was skipped due to a policy
// violation. It contains results from those filters that blocked the
// processing of the query.
PolicyResults []*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult `protobuf:"bytes,3,rep,name=policy_results,json=policyResults,proto3" json:"policy_results,omitempty"`
// contains filtered or unexported fields
}Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.
func (*AssistAnswer_CustomerPolicyEnforcementResult) Descriptor
func (*AssistAnswer_CustomerPolicyEnforcementResult) Descriptor() ([]byte, []int)Deprecated: Use AssistAnswer_CustomerPolicyEnforcementResult.ProtoReflect.Descriptor instead.
func (*AssistAnswer_CustomerPolicyEnforcementResult) GetPolicyResults
func (x *AssistAnswer_CustomerPolicyEnforcementResult) GetPolicyResults() []*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResultfunc (*AssistAnswer_CustomerPolicyEnforcementResult) GetVerdict
func (x *AssistAnswer_CustomerPolicyEnforcementResult) GetVerdict() AssistAnswer_CustomerPolicyEnforcementResult_Verdictfunc (*AssistAnswer_CustomerPolicyEnforcementResult) ProtoMessage
func (*AssistAnswer_CustomerPolicyEnforcementResult) ProtoMessage()func (*AssistAnswer_CustomerPolicyEnforcementResult) ProtoReflect
func (x *AssistAnswer_CustomerPolicyEnforcementResult) ProtoReflect() protoreflect.Messagefunc (*AssistAnswer_CustomerPolicyEnforcementResult) Reset
func (x *AssistAnswer_CustomerPolicyEnforcementResult) Reset()func (*AssistAnswer_CustomerPolicyEnforcementResult) String
func (x *AssistAnswer_CustomerPolicyEnforcementResult) String() stringAssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult
type AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult struct {
// The banned phrases that were found in the query or the answer.
BannedPhrases []string `protobuf:"bytes,1,rep,name=banned_phrases,json=bannedPhrases,proto3" json:"banned_phrases,omitempty"`
// contains filtered or unexported fields
}Customer policy enforcement result for the banned phrase policy.
func (*AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) Descriptor
func (*AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) Descriptor() ([]byte, []int)Deprecated: Use AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult.ProtoReflect.Descriptor instead.
func (*AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) GetBannedPhrases
func (x *AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) GetBannedPhrases() []stringfunc (*AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) ProtoMessage
func (*AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) ProtoMessage()func (*AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) ProtoReflect
func (x *AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) ProtoReflect() protoreflect.Messagefunc (*AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) Reset
func (*AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) String
func (x *AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult) String() stringAssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult
type AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult struct {
// The Model Armor policy result.
//
// Types that are valid to be assigned to Result:
//
// *AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult_ModelArmorViolation
// *AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult_Error
Result isAssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult_Result `protobuf_oneof:"result"`
// contains filtered or unexported fields
}Customer policy enforcement result for the Model Armor policy.
func (*AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) Descriptor
func (*AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) Descriptor() ([]byte, []int)Deprecated: Use AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult.ProtoReflect.Descriptor instead.
func (*AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) GetError
func (x *AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) GetError() *status.Statusfunc (*AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) GetModelArmorViolation
func (x *AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) GetModelArmorViolation() stringfunc (*AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) GetResult
func (x *AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) GetResult() isAssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult_Resultfunc (*AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) ProtoMessage
func (*AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) ProtoMessage()func (*AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) ProtoReflect
func (x *AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) ProtoReflect() protoreflect.Messagefunc (*AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) Reset
func (x *AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) Reset()func (*AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) String
func (x *AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult) String() stringAssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult_Error
type AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult_Error struct {
// The error returned by Model Armor if the policy enforcement failed
// for some reason.
Error *status.Status `protobuf:"bytes,2,opt,name=error,proto3,oneof"`
}AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult_ModelArmorViolation
type AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult_ModelArmorViolation struct {
// The Model Armor violation that was found.
ModelArmorViolation string `protobuf:"bytes,1,opt,name=model_armor_violation,json=modelArmorViolation,proto3,oneof"`
}AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult
type AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult struct {
// The policy type specific result. It can be either an error or a
// detailed information about the policy enforcement result.
//
// Types that are valid to be assigned to EnforcementResult:
//
// *AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult_BannedPhraseEnforcementResult
// *AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult_ModelArmorEnforcementResult
EnforcementResult isAssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult_EnforcementResult `protobuf_oneof:"enforcement_result"`
// contains filtered or unexported fields
}Customer policy enforcement result for a single policy type.
func (*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) Descriptor
func (*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) Descriptor() ([]byte, []int)Deprecated: Use AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult.ProtoReflect.Descriptor instead.
func (*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) GetBannedPhraseEnforcementResult
func (x *AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) GetBannedPhraseEnforcementResult() *AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResultfunc (*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) GetEnforcementResult
func (x *AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) GetEnforcementResult() isAssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult_EnforcementResultfunc (*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) GetModelArmorEnforcementResult
func (x *AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) GetModelArmorEnforcementResult() *AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResultfunc (*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) ProtoMessage
func (*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) ProtoMessage()func (*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) ProtoReflect
func (x *AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) ProtoReflect() protoreflect.Messagefunc (*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) Reset
func (x *AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) Reset()func (*AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) String
func (x *AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult) String() stringAssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult_BannedPhraseEnforcementResult
type AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult_BannedPhraseEnforcementResult struct {
// The policy enforcement result for the banned phrase policy.
BannedPhraseEnforcementResult *AssistAnswer_CustomerPolicyEnforcementResult_BannedPhraseEnforcementResult `protobuf:"bytes,3,opt,name=banned_phrase_enforcement_result,json=bannedPhraseEnforcementResult,proto3,oneof"`
}AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult_ModelArmorEnforcementResult
type AssistAnswer_CustomerPolicyEnforcementResult_PolicyEnforcementResult_ModelArmorEnforcementResult struct {
// The policy enforcement result for the Model Armor policy.
ModelArmorEnforcementResult *AssistAnswer_CustomerPolicyEnforcementResult_ModelArmorEnforcementResult `protobuf:"bytes,4,opt,name=model_armor_enforcement_result,json=modelArmorEnforcementResult,proto3,oneof"`
}AssistAnswer_CustomerPolicyEnforcementResult_Verdict
type AssistAnswer_CustomerPolicyEnforcementResult_Verdict int32The verdict of the customer policy enforcement.
AssistAnswer_CustomerPolicyEnforcementResult_UNSPECIFIED, AssistAnswer_CustomerPolicyEnforcementResult_ALLOW, AssistAnswer_CustomerPolicyEnforcementResult_BLOCK
const (
// Unknown value.
AssistAnswer_CustomerPolicyEnforcementResult_UNSPECIFIED AssistAnswer_CustomerPolicyEnforcementResult_Verdict = 0
// There was no policy violation.
AssistAnswer_CustomerPolicyEnforcementResult_ALLOW AssistAnswer_CustomerPolicyEnforcementResult_Verdict = 1
// Processing was blocked by the customer policy.
AssistAnswer_CustomerPolicyEnforcementResult_BLOCK AssistAnswer_CustomerPolicyEnforcementResult_Verdict = 2
)func (AssistAnswer_CustomerPolicyEnforcementResult_Verdict) Descriptor
func (AssistAnswer_CustomerPolicyEnforcementResult_Verdict) Descriptor() protoreflect.EnumDescriptorfunc (AssistAnswer_CustomerPolicyEnforcementResult_Verdict) Enum
func (x AssistAnswer_CustomerPolicyEnforcementResult_Verdict) Enum() *AssistAnswer_CustomerPolicyEnforcementResult_Verdictfunc (AssistAnswer_CustomerPolicyEnforcementResult_Verdict) EnumDescriptor
func (AssistAnswer_CustomerPolicyEnforcementResult_Verdict) EnumDescriptor() ([]byte, []int)Deprecated: Use AssistAnswer_CustomerPolicyEnforcementResult_Verdict.Descriptor instead.
func (AssistAnswer_CustomerPolicyEnforcementResult_Verdict) Number
func (x AssistAnswer_CustomerPolicyEnforcementResult_Verdict) Number() protoreflect.EnumNumberfunc (AssistAnswer_CustomerPolicyEnforcementResult_Verdict) String
func (x AssistAnswer_CustomerPolicyEnforcementResult_Verdict) String() stringfunc (AssistAnswer_CustomerPolicyEnforcementResult_Verdict) Type
AssistAnswer_Reply
type AssistAnswer_Reply struct {
// Alternatives for the assistant reply.
//
// Types that are valid to be assigned to Reply:
//
// *AssistAnswer_Reply_GroundedContent
Reply isAssistAnswer_Reply_Reply `protobuf_oneof:"reply"`
// The time when the reply was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}One part of the multi-part response of the assist call.
func (*AssistAnswer_Reply) Descriptor
func (*AssistAnswer_Reply) Descriptor() ([]byte, []int)Deprecated: Use AssistAnswer_Reply.ProtoReflect.Descriptor instead.
func (*AssistAnswer_Reply) GetCreateTime
func (x *AssistAnswer_Reply) GetCreateTime() *timestamppb.Timestampfunc (*AssistAnswer_Reply) GetGroundedContent
func (x *AssistAnswer_Reply) GetGroundedContent() *AssistantGroundedContentfunc (*AssistAnswer_Reply) GetReply
func (x *AssistAnswer_Reply) GetReply() isAssistAnswer_Reply_Replyfunc (*AssistAnswer_Reply) ProtoMessage
func (*AssistAnswer_Reply) ProtoMessage()func (*AssistAnswer_Reply) ProtoReflect
func (x *AssistAnswer_Reply) ProtoReflect() protoreflect.Messagefunc (*AssistAnswer_Reply) Reset
func (x *AssistAnswer_Reply) Reset()func (*AssistAnswer_Reply) String
func (x *AssistAnswer_Reply) String() stringAssistAnswer_Reply_GroundedContent
type AssistAnswer_Reply_GroundedContent struct {
// Possibly grounded response text or media from the assistant.
GroundedContent *AssistantGroundedContent `protobuf:"bytes,1,opt,name=grounded_content,json=groundedContent,proto3,oneof"`
}AssistAnswer_State
type AssistAnswer_State int32State of the answer generation.
AssistAnswer_STATE_UNSPECIFIED, AssistAnswer_IN_PROGRESS, AssistAnswer_FAILED, AssistAnswer_SUCCEEDED, AssistAnswer_SKIPPED, AssistAnswer_CANCELLED
const (
// Unknown.
AssistAnswer_STATE_UNSPECIFIED AssistAnswer_State = 0
// Assist operation is currently in progress.
AssistAnswer_IN_PROGRESS AssistAnswer_State = 1
// Assist operation has failed.
AssistAnswer_FAILED AssistAnswer_State = 2
// Assist operation has succeeded.
AssistAnswer_SUCCEEDED AssistAnswer_State = 3
// Assist operation has been skipped.
AssistAnswer_SKIPPED AssistAnswer_State = 4
// Assist operation has been cancelled (e.g. client closed the stream).
// May contain a partial response.
AssistAnswer_CANCELLED AssistAnswer_State = 5
)func (AssistAnswer_State) Descriptor
func (AssistAnswer_State) Descriptor() protoreflect.EnumDescriptorfunc (AssistAnswer_State) Enum
func (x AssistAnswer_State) Enum() *AssistAnswer_Statefunc (AssistAnswer_State) EnumDescriptor
func (AssistAnswer_State) EnumDescriptor() ([]byte, []int)Deprecated: Use AssistAnswer_State.Descriptor instead.
func (AssistAnswer_State) Number
func (x AssistAnswer_State) Number() protoreflect.EnumNumberfunc (AssistAnswer_State) String
func (x AssistAnswer_State) String() stringfunc (AssistAnswer_State) Type
func (AssistAnswer_State) Type() protoreflect.EnumTypeAssistUserMetadata
type AssistUserMetadata struct {
// Optional. IANA time zone, e.g. Europe/Budapest.
TimeZone string `protobuf:"bytes,1,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
// Optional. Preferred language to be used for answering if language detection
// fails. Also used as the language of error messages created by actions,
// regardless of language detection results.
PreferredLanguageCode string `protobuf:"bytes,2,opt,name=preferred_language_code,json=preferredLanguageCode,proto3" json:"preferred_language_code,omitempty"`
// contains filtered or unexported fields
}User metadata of the request.
func (*AssistUserMetadata) Descriptor
func (*AssistUserMetadata) Descriptor() ([]byte, []int)Deprecated: Use AssistUserMetadata.ProtoReflect.Descriptor instead.
func (*AssistUserMetadata) GetPreferredLanguageCode
func (x *AssistUserMetadata) GetPreferredLanguageCode() stringfunc (*AssistUserMetadata) GetTimeZone
func (x *AssistUserMetadata) GetTimeZone() stringfunc (*AssistUserMetadata) ProtoMessage
func (*AssistUserMetadata) ProtoMessage()func (*AssistUserMetadata) ProtoReflect
func (x *AssistUserMetadata) ProtoReflect() protoreflect.Messagefunc (*AssistUserMetadata) Reset
func (x *AssistUserMetadata) Reset()func (*AssistUserMetadata) String
func (x *AssistUserMetadata) String() stringAssistant
type Assistant struct {
// Immutable. Resource name of the assistant.
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
//
// It must be a UTF-8 encoded string with a length limit of 1024 characters.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The assistant display name.
//
// It must be a UTF-8 encoded string with a length limit of 128 characters.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. Description for additional information. Expected to be shown on
// the configuration UI, not to the users of the assistant.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Configuration for the generation of the assistant response.
GenerationConfig *Assistant_GenerationConfig `protobuf:"bytes,19,opt,name=generation_config,json=generationConfig,proto3" json:"generation_config,omitempty"`
// Optional. The type of web grounding to use.
WebGroundingType Assistant_WebGroundingType `protobuf:"varint,4,opt,name=web_grounding_type,json=webGroundingType,proto3,enum=google.cloud.discoveryengine.v1beta.Assistant_WebGroundingType" json:"web_grounding_type,omitempty"`
// Optional. This field controls the default web grounding toggle for end
// users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH`
// or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is
// set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH`
// or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web
// grounding enabled by default on UI. If true, grounding toggle will be
// disabled by default on UI. End users can still enable web grounding in
// the UI if web grounding is enabled.
DefaultWebGroundingToggleOff bool `protobuf:"varint,22,opt,name=default_web_grounding_toggle_off,json=defaultWebGroundingToggleOff,proto3" json:"default_web_grounding_toggle_off,omitempty"`
// Optional. Note: not implemented yet. Use
// [enabled_actions][google.cloud.discoveryengine.v1beta.Assistant.enabled_actions]
// instead. The enabled tools on this assistant. The keys are connector name,
// for example
// "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector
// The values consist of admin enabled tools towards the connector
// instance. Admin can selectively enable multiple tools on any of the
// connector instances that they created in the project. For example
// {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2,
// "transferTicket")],
//
// "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
EnabledTools map[string]*Assistant_ToolList `protobuf:"bytes,18,rep,name=enabled_tools,json=enabledTools,proto3" json:"enabled_tools,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. Customer policy for the assistant.
CustomerPolicy *Assistant_CustomerPolicy `protobuf:"bytes,12,opt,name=customer_policy,json=customerPolicy,proto3" json:"customer_policy,omitempty"`
// Output only. Represents the time when this Assistant was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,24,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Represents the time when this Assistant was most recently
// updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,25,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Discovery Engine Assistant resource.
func (*Assistant) Descriptor
Deprecated: Use Assistant.ProtoReflect.Descriptor instead.
func (*Assistant) GetCreateTime
func (x *Assistant) GetCreateTime() *timestamppb.Timestampfunc (*Assistant) GetCustomerPolicy
func (x *Assistant) GetCustomerPolicy() *Assistant_CustomerPolicyfunc (*Assistant) GetDefaultWebGroundingToggleOff
func (*Assistant) GetDescription
func (*Assistant) GetDisplayName
func (*Assistant) GetEnabledTools
func (x *Assistant) GetEnabledTools() map[string]*Assistant_ToolListfunc (*Assistant) GetGenerationConfig
func (x *Assistant) GetGenerationConfig() *Assistant_GenerationConfigfunc (*Assistant) GetName
func (*Assistant) GetUpdateTime
func (x *Assistant) GetUpdateTime() *timestamppb.Timestampfunc (*Assistant) GetWebGroundingType
func (x *Assistant) GetWebGroundingType() Assistant_WebGroundingTypefunc (*Assistant) ProtoMessage
func (*Assistant) ProtoMessage()func (*Assistant) ProtoReflect
func (x *Assistant) ProtoReflect() protoreflect.Messagefunc (*Assistant) Reset
func (x *Assistant) Reset()func (*Assistant) String
AssistantContent
type AssistantContent struct {
// Contained data.
//
// Types that are valid to be assigned to Data:
//
// *AssistantContent_Text
// *AssistantContent_InlineData
// *AssistantContent_File_
// *AssistantContent_ExecutableCode_
// *AssistantContent_CodeExecutionResult_
Data isAssistantContent_Data `protobuf_oneof:"data"`
// The producer of the content. Can be "model" or "user".
Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
// Optional. Indicates if the part is thought from the model.
Thought bool `protobuf:"varint,6,opt,name=thought,proto3" json:"thought,omitempty"`
// contains filtered or unexported fields
}Multi-modal content.
func (*AssistantContent) Descriptor
func (*AssistantContent) Descriptor() ([]byte, []int)Deprecated: Use AssistantContent.ProtoReflect.Descriptor instead.
func (*AssistantContent) GetCodeExecutionResult
func (x *AssistantContent) GetCodeExecutionResult() *AssistantContent_CodeExecutionResultfunc (*AssistantContent) GetData
func (x *AssistantContent) GetData() isAssistantContent_Datafunc (*AssistantContent) GetExecutableCode
func (x *AssistantContent) GetExecutableCode() *AssistantContent_ExecutableCodefunc (*AssistantContent) GetFile
func (x *AssistantContent) GetFile() *AssistantContent_Filefunc (*AssistantContent) GetInlineData
func (x *AssistantContent) GetInlineData() *AssistantContent_Blobfunc (*AssistantContent) GetRole
func (x *AssistantContent) GetRole() stringfunc (*AssistantContent) GetText
func (x *AssistantContent) GetText() stringfunc (*AssistantContent) GetThought
func (x *AssistantContent) GetThought() boolfunc (*AssistantContent) ProtoMessage
func (*AssistantContent) ProtoMessage()func (*AssistantContent) ProtoReflect
func (x *AssistantContent) ProtoReflect() protoreflect.Messagefunc (*AssistantContent) Reset
func (x *AssistantContent) Reset()func (*AssistantContent) String
func (x *AssistantContent) String() stringAssistantContent_Blob
type AssistantContent_Blob struct {
// Required. The media type (MIME type) of the generated data.
MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// Required. Raw bytes.
Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}Inline blob.
func (*AssistantContent_Blob) Descriptor
func (*AssistantContent_Blob) Descriptor() ([]byte, []int)Deprecated: Use AssistantContent_Blob.ProtoReflect.Descriptor instead.
func (*AssistantContent_Blob) GetData
func (x *AssistantContent_Blob) GetData() []bytefunc (*AssistantContent_Blob) GetMimeType
func (x *AssistantContent_Blob) GetMimeType() stringfunc (*AssistantContent_Blob) ProtoMessage
func (*AssistantContent_Blob) ProtoMessage()func (*AssistantContent_Blob) ProtoReflect
func (x *AssistantContent_Blob) ProtoReflect() protoreflect.Messagefunc (*AssistantContent_Blob) Reset
func (x *AssistantContent_Blob) Reset()func (*AssistantContent_Blob) String
func (x *AssistantContent_Blob) String() stringAssistantContent_CodeExecutionResult
type AssistantContent_CodeExecutionResult struct {
// Required. Outcome of the code execution.
Outcome AssistantContent_CodeExecutionResult_Outcome `protobuf:"varint,1,opt,name=outcome,proto3,enum=google.cloud.discoveryengine.v1beta.AssistantContent_CodeExecutionResult_Outcome" json:"outcome,omitempty"`
// Optional. Contains stdout when code execution is successful, stderr or
// other description otherwise.
Output string `protobuf:"bytes,2,opt,name=output,proto3" json:"output,omitempty"`
// contains filtered or unexported fields
}Result of executing ExecutableCode.
func (*AssistantContent_CodeExecutionResult) Descriptor
func (*AssistantContent_CodeExecutionResult) Descriptor() ([]byte, []int)Deprecated: Use AssistantContent_CodeExecutionResult.ProtoReflect.Descriptor instead.
func (*AssistantContent_CodeExecutionResult) GetOutcome
func (x *AssistantContent_CodeExecutionResult) GetOutcome() AssistantContent_CodeExecutionResult_Outcomefunc (*AssistantContent_CodeExecutionResult) GetOutput
func (x *AssistantContent_CodeExecutionResult) GetOutput() stringfunc (*AssistantContent_CodeExecutionResult) ProtoMessage
func (*AssistantContent_CodeExecutionResult) ProtoMessage()func (*AssistantContent_CodeExecutionResult) ProtoReflect
func (x *AssistantContent_CodeExecutionResult) ProtoReflect() protoreflect.Messagefunc (*AssistantContent_CodeExecutionResult) Reset
func (x *AssistantContent_CodeExecutionResult) Reset()func (*AssistantContent_CodeExecutionResult) String
func (x *AssistantContent_CodeExecutionResult) String() stringAssistantContent_CodeExecutionResult_
type AssistantContent_CodeExecutionResult_ struct {
// Result of executing an ExecutableCode.
CodeExecutionResult *AssistantContent_CodeExecutionResult `protobuf:"bytes,8,opt,name=code_execution_result,json=codeExecutionResult,proto3,oneof"`
}AssistantContent_CodeExecutionResult_Outcome
type AssistantContent_CodeExecutionResult_Outcome int32Enumeration of possible outcomes of the code execution.
AssistantContent_CodeExecutionResult_OUTCOME_UNSPECIFIED, AssistantContent_CodeExecutionResult_OUTCOME_OK, AssistantContent_CodeExecutionResult_OUTCOME_FAILED, AssistantContent_CodeExecutionResult_OUTCOME_DEADLINE_EXCEEDED
const (
// Unspecified status. This value should not be used.
AssistantContent_CodeExecutionResult_OUTCOME_UNSPECIFIED AssistantContent_CodeExecutionResult_Outcome = 0
// Code execution completed successfully.
AssistantContent_CodeExecutionResult_OUTCOME_OK AssistantContent_CodeExecutionResult_Outcome = 1
// Code execution finished but with a failure. `stderr` should contain the
// reason.
AssistantContent_CodeExecutionResult_OUTCOME_FAILED AssistantContent_CodeExecutionResult_Outcome = 2
// Code execution ran for too long, and was cancelled. There may or may
// not be a partial output present.
AssistantContent_CodeExecutionResult_OUTCOME_DEADLINE_EXCEEDED AssistantContent_CodeExecutionResult_Outcome = 3
)func (AssistantContent_CodeExecutionResult_Outcome) Descriptor
func (AssistantContent_CodeExecutionResult_Outcome) Descriptor() protoreflect.EnumDescriptorfunc (AssistantContent_CodeExecutionResult_Outcome) Enum
func (x AssistantContent_CodeExecutionResult_Outcome) Enum() *AssistantContent_CodeExecutionResult_Outcomefunc (AssistantContent_CodeExecutionResult_Outcome) EnumDescriptor
func (AssistantContent_CodeExecutionResult_Outcome) EnumDescriptor() ([]byte, []int)Deprecated: Use AssistantContent_CodeExecutionResult_Outcome.Descriptor instead.
func (AssistantContent_CodeExecutionResult_Outcome) Number
func (x AssistantContent_CodeExecutionResult_Outcome) Number() protoreflect.EnumNumberfunc (AssistantContent_CodeExecutionResult_Outcome) String
func (x AssistantContent_CodeExecutionResult_Outcome) String() stringfunc (AssistantContent_CodeExecutionResult_Outcome) Type
func (AssistantContent_CodeExecutionResult_Outcome) Type() protoreflect.EnumTypeAssistantContent_ExecutableCode
type AssistantContent_ExecutableCode struct {
// Required. The code content. Currently only supports Python.
Code string `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"`
// contains filtered or unexported fields
}Code generated by the model that is meant to be executed by the model.
func (*AssistantContent_ExecutableCode) Descriptor
func (*AssistantContent_ExecutableCode) Descriptor() ([]byte, []int)Deprecated: Use AssistantContent_ExecutableCode.ProtoReflect.Descriptor instead.
func (*AssistantContent_ExecutableCode) GetCode
func (x *AssistantContent_ExecutableCode) GetCode() stringfunc (*AssistantContent_ExecutableCode) ProtoMessage
func (*AssistantContent_ExecutableCode) ProtoMessage()func (*AssistantContent_ExecutableCode) ProtoReflect
func (x *AssistantContent_ExecutableCode) ProtoReflect() protoreflect.Messagefunc (*AssistantContent_ExecutableCode) Reset
func (x *AssistantContent_ExecutableCode) Reset()func (*AssistantContent_ExecutableCode) String
func (x *AssistantContent_ExecutableCode) String() stringAssistantContent_ExecutableCode_
type AssistantContent_ExecutableCode_ struct {
// Code generated by the model that is meant to be executed.
ExecutableCode *AssistantContent_ExecutableCode `protobuf:"bytes,7,opt,name=executable_code,json=executableCode,proto3,oneof"`
}AssistantContent_File
type AssistantContent_File struct {
// Required. The media type (MIME type) of the file.
MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// Required. The file ID.
FileId string `protobuf:"bytes,2,opt,name=file_id,json=fileId,proto3" json:"file_id,omitempty"`
// contains filtered or unexported fields
}A file, e.g., an audio summary.
func (*AssistantContent_File) Descriptor
func (*AssistantContent_File) Descriptor() ([]byte, []int)Deprecated: Use AssistantContent_File.ProtoReflect.Descriptor instead.
func (*AssistantContent_File) GetFileId
func (x *AssistantContent_File) GetFileId() stringfunc (*AssistantContent_File) GetMimeType
func (x *AssistantContent_File) GetMimeType() stringfunc (*AssistantContent_File) ProtoMessage
func (*AssistantContent_File) ProtoMessage()func (*AssistantContent_File) ProtoReflect
func (x *AssistantContent_File) ProtoReflect() protoreflect.Messagefunc (*AssistantContent_File) Reset
func (x *AssistantContent_File) Reset()func (*AssistantContent_File) String
func (x *AssistantContent_File) String() stringAssistantContent_File_
type AssistantContent_File_ struct {
// A file, e.g., an audio summary.
File *AssistantContent_File `protobuf:"bytes,4,opt,name=file,proto3,oneof"`
}AssistantContent_InlineData
type AssistantContent_InlineData struct {
// Inline binary data.
InlineData *AssistantContent_Blob `protobuf:"bytes,3,opt,name=inline_data,json=inlineData,proto3,oneof"`
}AssistantContent_Text
type AssistantContent_Text struct {
// Inline text.
Text string `protobuf:"bytes,2,opt,name=text,proto3,oneof"`
}AssistantGroundedContent
type AssistantGroundedContent struct {
// Grounding metadata for various modals. It only supports text for now.
//
// Types that are valid to be assigned to Metadata:
//
// *AssistantGroundedContent_TextGroundingMetadata_
Metadata isAssistantGroundedContent_Metadata `protobuf_oneof:"metadata"`
// The content.
Content *AssistantContent `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// Source attribution of the generated content. See also
// https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
CitationMetadata *CitationMetadata `protobuf:"bytes,5,opt,name=citation_metadata,json=citationMetadata,proto3" json:"citation_metadata,omitempty"`
// contains filtered or unexported fields
}A piece of content and possibly its grounding information.
Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding.
func (*AssistantGroundedContent) Descriptor
func (*AssistantGroundedContent) Descriptor() ([]byte, []int)Deprecated: Use AssistantGroundedContent.ProtoReflect.Descriptor instead.
func (*AssistantGroundedContent) GetCitationMetadata
func (x *AssistantGroundedContent) GetCitationMetadata() *CitationMetadatafunc (*AssistantGroundedContent) GetContent
func (x *AssistantGroundedContent) GetContent() *AssistantContentfunc (*AssistantGroundedContent) GetMetadata
func (x *AssistantGroundedContent) GetMetadata() isAssistantGroundedContent_Metadatafunc (*AssistantGroundedContent) GetTextGroundingMetadata
func (x *AssistantGroundedContent) GetTextGroundingMetadata() *AssistantGroundedContent_TextGroundingMetadatafunc (*AssistantGroundedContent) ProtoMessage
func (*AssistantGroundedContent) ProtoMessage()func (*AssistantGroundedContent) ProtoReflect
func (x *AssistantGroundedContent) ProtoReflect() protoreflect.Messagefunc (*AssistantGroundedContent) Reset
func (x *AssistantGroundedContent) Reset()func (*AssistantGroundedContent) String
func (x *AssistantGroundedContent) String() stringAssistantGroundedContent_TextGroundingMetadata
type AssistantGroundedContent_TextGroundingMetadata struct {
// Grounding information for parts of the text.
Segments []*AssistantGroundedContent_TextGroundingMetadata_Segment `protobuf:"bytes,4,rep,name=segments,proto3" json:"segments,omitempty"`
// Grounding information for parts of the visual content.
VisualSegments []*AssistantGroundedContent_TextGroundingMetadata_VisualSegment `protobuf:"bytes,6,rep,name=visual_segments,json=visualSegments,proto3" json:"visual_segments,omitempty"`
// References for the grounded text.
References []*AssistantGroundedContent_TextGroundingMetadata_Reference `protobuf:"bytes,2,rep,name=references,proto3" json:"references,omitempty"`
// contains filtered or unexported fields
}Grounding details for text sources.
func (*AssistantGroundedContent_TextGroundingMetadata) Descriptor
func (*AssistantGroundedContent_TextGroundingMetadata) Descriptor() ([]byte, []int)Deprecated: Use AssistantGroundedContent_TextGroundingMetadata.ProtoReflect.Descriptor instead.
func (*AssistantGroundedContent_TextGroundingMetadata) GetReferences
func (x *AssistantGroundedContent_TextGroundingMetadata) GetReferences() []*AssistantGroundedContent_TextGroundingMetadata_Referencefunc (*AssistantGroundedContent_TextGroundingMetadata) GetSegments
func (x *AssistantGroundedContent_TextGroundingMetadata) GetSegments() []*AssistantGroundedContent_TextGroundingMetadata_Segmentfunc (*AssistantGroundedContent_TextGroundingMetadata) GetVisualSegments
func (x *AssistantGroundedContent_TextGroundingMetadata) GetVisualSegments() []*AssistantGroundedContent_TextGroundingMetadata_VisualSegmentfunc (*AssistantGroundedContent_TextGroundingMetadata) ProtoMessage
func (*AssistantGroundedContent_TextGroundingMetadata) ProtoMessage()func (*AssistantGroundedContent_TextGroundingMetadata) ProtoReflect
func (x *AssistantGroundedContent_TextGroundingMetadata) ProtoReflect() protoreflect.Messagefunc (*AssistantGroundedContent_TextGroundingMetadata) Reset
func (x *AssistantGroundedContent_TextGroundingMetadata) Reset()func (*AssistantGroundedContent_TextGroundingMetadata) String
func (x *AssistantGroundedContent_TextGroundingMetadata) String() stringAssistantGroundedContent_TextGroundingMetadata_
type AssistantGroundedContent_TextGroundingMetadata_ struct {
// Metadata for grounding based on text sources.
TextGroundingMetadata *AssistantGroundedContent_TextGroundingMetadata `protobuf:"bytes,3,opt,name=text_grounding_metadata,json=textGroundingMetadata,proto3,oneof"`
}AssistantGroundedContent_TextGroundingMetadata_Reference
type AssistantGroundedContent_TextGroundingMetadata_Reference struct {
// Referenced text content.
Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// Chunk of code snippet from the referenced document.
CodeSnippet string `protobuf:"bytes,4,opt,name=code_snippet,json=codeSnippet,proto3" json:"code_snippet,omitempty"`
// Document metadata.
DocumentMetadata *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata `protobuf:"bytes,2,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
// contains filtered or unexported fields
}Referenced content and related document metadata.
func (*AssistantGroundedContent_TextGroundingMetadata_Reference) Descriptor
func (*AssistantGroundedContent_TextGroundingMetadata_Reference) Descriptor() ([]byte, []int)Deprecated: Use AssistantGroundedContent_TextGroundingMetadata_Reference.ProtoReflect.Descriptor instead.
func (*AssistantGroundedContent_TextGroundingMetadata_Reference) GetCodeSnippet
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference) GetCodeSnippet() stringfunc (*AssistantGroundedContent_TextGroundingMetadata_Reference) GetContent
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference) GetContent() stringfunc (*AssistantGroundedContent_TextGroundingMetadata_Reference) GetDocumentMetadata
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference) GetDocumentMetadata() *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadatafunc (*AssistantGroundedContent_TextGroundingMetadata_Reference) ProtoMessage
func (*AssistantGroundedContent_TextGroundingMetadata_Reference) ProtoMessage()func (*AssistantGroundedContent_TextGroundingMetadata_Reference) ProtoReflect
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference) ProtoReflect() protoreflect.Messagefunc (*AssistantGroundedContent_TextGroundingMetadata_Reference) Reset
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference) Reset()func (*AssistantGroundedContent_TextGroundingMetadata_Reference) String
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference) String() stringAssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata
type AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata struct {
Language AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language `protobuf:"varint,8,opt,name=language,proto3,enum=google.cloud.discoveryengine.v1beta.AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language" json:"language,omitempty"`
// Document resource name.
Document *string `protobuf:"bytes,1,opt,name=document,proto3,oneof" json:"document,omitempty"`
// URI for the document. It may contain a URL that redirects to the
// actual website.
Uri *string `protobuf:"bytes,2,opt,name=uri,proto3,oneof" json:"uri,omitempty"`
// Title.
Title *string `protobuf:"bytes,3,opt,name=title,proto3,oneof" json:"title,omitempty"`
// Page identifier.
PageIdentifier *string `protobuf:"bytes,4,opt,name=page_identifier,json=pageIdentifier,proto3,oneof" json:"page_identifier,omitempty"`
// Domain name from the document URI. Note that the `uri` field may
// contain a URL that redirects to the actual website, in which case
// this will contain the domain name of the target site.
Domain *string `protobuf:"bytes,5,opt,name=domain,proto3,oneof" json:"domain,omitempty"`
// The mime type of the document.
// https://www.iana.org/assignments/media-types/media-types.xhtml.
MimeType *string `protobuf:"bytes,7,opt,name=mime_type,json=mimeType,proto3,oneof" json:"mime_type,omitempty"`
// contains filtered or unexported fields
}Document metadata.
func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) Descriptor
func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) Descriptor() ([]byte, []int)Deprecated: Use AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata.ProtoReflect.Descriptor instead.
func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetDocument
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetDocument() stringfunc (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetDomain
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetDomain() stringfunc (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetLanguage
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetLanguage() AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Languagefunc (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetMimeType
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetMimeType() stringfunc (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetPageIdentifier
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetPageIdentifier() stringfunc (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetTitle
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetTitle() stringfunc (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetUri
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) GetUri() stringfunc (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) ProtoMessage
func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) ProtoMessage()func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) ProtoReflect
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) ProtoReflect() protoreflect.Messagefunc (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) Reset
func (*AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) String
func (x *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata) String() stringAssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language
type AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language int32Language of the referenced content. For now, it is only used for code.
AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_LANGUAGE_UNSPECIFIED, AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_PYTHON, AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_SQL
const (
AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_LANGUAGE_UNSPECIFIED AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language = 0
AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_PYTHON AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language = 1
AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_SQL AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language = 2
)func (AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) Descriptor
func (AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) Descriptor() protoreflect.EnumDescriptorfunc (AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) Enum
func (x AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) Enum() *AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Languagefunc (AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) EnumDescriptor
func (AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) EnumDescriptor() ([]byte, []int)Deprecated: Use AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language.Descriptor instead.
func (AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) Number
func (x AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) Number() protoreflect.EnumNumberfunc (AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) String
func (x AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) String() stringfunc (AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) Type
func (AssistantGroundedContent_TextGroundingMetadata_Reference_DocumentMetadata_Language) Type() protoreflect.EnumTypeAssistantGroundedContent_TextGroundingMetadata_Segment
type AssistantGroundedContent_TextGroundingMetadata_Segment struct {
// Zero-based index indicating the start of the segment, measured in bytes
// of a UTF-8 string (i.e. characters encoded on multiple bytes have a
// length of more than one).
StartIndex int64 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
// End of the segment, exclusive.
EndIndex int64 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
// References for the segment.
ReferenceIndices []int32 `protobuf:"varint,4,rep,packed,name=reference_indices,json=referenceIndices,proto3" json:"reference_indices,omitempty"`
// Score for the segment.
GroundingScore float32 `protobuf:"fixed32,5,opt,name=grounding_score,json=groundingScore,proto3" json:"grounding_score,omitempty"`
// The text segment itself.
Text string `protobuf:"bytes,6,opt,name=text,proto3" json:"text,omitempty"`
// contains filtered or unexported fields
}Grounding information for a segment of the text.
func (*AssistantGroundedContent_TextGroundingMetadata_Segment) Descriptor
func (*AssistantGroundedContent_TextGroundingMetadata_Segment) Descriptor() ([]byte, []int)Deprecated: Use AssistantGroundedContent_TextGroundingMetadata_Segment.ProtoReflect.Descriptor instead.
func (*AssistantGroundedContent_TextGroundingMetadata_Segment) GetEndIndex
func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) GetEndIndex() int64func (*AssistantGroundedContent_TextGroundingMetadata_Segment) GetGroundingScore
func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) GetGroundingScore() float32func (*AssistantGroundedContent_TextGroundingMetadata_Segment) GetReferenceIndices
func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) GetReferenceIndices() []int32func (*AssistantGroundedContent_TextGroundingMetadata_Segment) GetStartIndex
func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) GetStartIndex() int64func (*AssistantGroundedContent_TextGroundingMetadata_Segment) GetText
func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) GetText() stringfunc (*AssistantGroundedContent_TextGroundingMetadata_Segment) ProtoMessage
func (*AssistantGroundedContent_TextGroundingMetadata_Segment) ProtoMessage()func (*AssistantGroundedContent_TextGroundingMetadata_Segment) ProtoReflect
func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) ProtoReflect() protoreflect.Messagefunc (*AssistantGroundedContent_TextGroundingMetadata_Segment) Reset
func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) Reset()func (*AssistantGroundedContent_TextGroundingMetadata_Segment) String
func (x *AssistantGroundedContent_TextGroundingMetadata_Segment) String() stringAssistantGroundedContent_TextGroundingMetadata_VisualSegment
type AssistantGroundedContent_TextGroundingMetadata_VisualSegment struct {
// References for the visual segment.
ReferenceIndices []int32 `protobuf:"varint,1,rep,packed,name=reference_indices,json=referenceIndices,proto3" json:"reference_indices,omitempty"`
// The content id of the visual segment. In order to display the citation
// of the visual element, this content_id needs to match with the
// `grounded_content.content_metadata.content_id` field.
ContentId string `protobuf:"bytes,2,opt,name=content_id,json=contentId,proto3" json:"content_id,omitempty"`
// contains filtered or unexported fields
}Grounding information for a visual segment.
func (*AssistantGroundedContent_TextGroundingMetadata_VisualSegment) Descriptor
func (*AssistantGroundedContent_TextGroundingMetadata_VisualSegment) Descriptor() ([]byte, []int)Deprecated: Use AssistantGroundedContent_TextGroundingMetadata_VisualSegment.ProtoReflect.Descriptor instead.
func (*AssistantGroundedContent_TextGroundingMetadata_VisualSegment) GetContentId
func (x *AssistantGroundedContent_TextGroundingMetadata_VisualSegment) GetContentId() stringfunc (*AssistantGroundedContent_TextGroundingMetadata_VisualSegment) GetReferenceIndices
func (x *AssistantGroundedContent_TextGroundingMetadata_VisualSegment) GetReferenceIndices() []int32func (*AssistantGroundedContent_TextGroundingMetadata_VisualSegment) ProtoMessage
func (*AssistantGroundedContent_TextGroundingMetadata_VisualSegment) ProtoMessage()func (*AssistantGroundedContent_TextGroundingMetadata_VisualSegment) ProtoReflect
func (x *AssistantGroundedContent_TextGroundingMetadata_VisualSegment) ProtoReflect() protoreflect.Messagefunc (*AssistantGroundedContent_TextGroundingMetadata_VisualSegment) Reset
func (x *AssistantGroundedContent_TextGroundingMetadata_VisualSegment) Reset()func (*AssistantGroundedContent_TextGroundingMetadata_VisualSegment) String
func (x *AssistantGroundedContent_TextGroundingMetadata_VisualSegment) String() stringAssistantServiceClient
type AssistantServiceClient interface {
// Assists the user with a query in a streaming fashion.
StreamAssist(ctx context.Context, in *StreamAssistRequest, opts ...grpc.CallOption) (AssistantService_StreamAssistClient, error)
// Creates an [Assistant][google.cloud.discoveryengine.v1beta.Assistant].
CreateAssistant(ctx context.Context, in *CreateAssistantRequest, opts ...grpc.CallOption) (*Assistant, error)
// Deletes an [Assistant][google.cloud.discoveryengine.v1beta.Assistant].
DeleteAssistant(ctx context.Context, in *DeleteAssistantRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates an [Assistant][google.cloud.discoveryengine.v1beta.Assistant]
UpdateAssistant(ctx context.Context, in *UpdateAssistantRequest, opts ...grpc.CallOption) (*Assistant, error)
// Gets an [Assistant][google.cloud.discoveryengine.v1beta.Assistant].
GetAssistant(ctx context.Context, in *GetAssistantRequest, opts ...grpc.CallOption) (*Assistant, error)
// Lists all [Assistant][google.cloud.discoveryengine.v1beta.Assistant]s under
// an [Engine][google.cloud.discoveryengine.v1beta.Engine].
ListAssistants(ctx context.Context, in *ListAssistantsRequest, opts ...grpc.CallOption) (*ListAssistantsResponse, error)
}AssistantServiceClient is the client API for AssistantService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewAssistantServiceClient
func NewAssistantServiceClient(cc grpc.ClientConnInterface) AssistantServiceClientAssistantServiceServer
type AssistantServiceServer interface {
// Assists the user with a query in a streaming fashion.
StreamAssist(*StreamAssistRequest, AssistantService_StreamAssistServer) error
// Creates an [Assistant][google.cloud.discoveryengine.v1beta.Assistant].
CreateAssistant(context.Context, *CreateAssistantRequest) (*Assistant, error)
// Deletes an [Assistant][google.cloud.discoveryengine.v1beta.Assistant].
DeleteAssistant(context.Context, *DeleteAssistantRequest) (*emptypb.Empty, error)
// Updates an [Assistant][google.cloud.discoveryengine.v1beta.Assistant]
UpdateAssistant(context.Context, *UpdateAssistantRequest) (*Assistant, error)
// Gets an [Assistant][google.cloud.discoveryengine.v1beta.Assistant].
GetAssistant(context.Context, *GetAssistantRequest) (*Assistant, error)
// Lists all [Assistant][google.cloud.discoveryengine.v1beta.Assistant]s under
// an [Engine][google.cloud.discoveryengine.v1beta.Engine].
ListAssistants(context.Context, *ListAssistantsRequest) (*ListAssistantsResponse, error)
}AssistantServiceServer is the server API for AssistantService service. All implementations should embed UnimplementedAssistantServiceServer for forward compatibility
AssistantService_StreamAssistClient
type AssistantService_StreamAssistClient interface {
Recv() (*StreamAssistResponse, error)
grpc.ClientStream
}AssistantService_StreamAssistServer
type AssistantService_StreamAssistServer interface {
Send(*StreamAssistResponse) error
grpc.ServerStream
}Assistant_CustomerPolicy
type Assistant_CustomerPolicy struct {
// Optional. List of banned phrases.
BannedPhrases []*Assistant_CustomerPolicy_BannedPhrase `protobuf:"bytes,1,rep,name=banned_phrases,json=bannedPhrases,proto3" json:"banned_phrases,omitempty"`
// Optional. Model Armor configuration to be used for sanitizing user
// prompts and assistant responses.
ModelArmorConfig *Assistant_CustomerPolicy_ModelArmorConfig `protobuf:"bytes,2,opt,name=model_armor_config,json=modelArmorConfig,proto3" json:"model_armor_config,omitempty"`
// contains filtered or unexported fields
}Customer-defined policy for the assistant.
func (*Assistant_CustomerPolicy) Descriptor
func (*Assistant_CustomerPolicy) Descriptor() ([]byte, []int)Deprecated: Use Assistant_CustomerPolicy.ProtoReflect.Descriptor instead.
func (*Assistant_CustomerPolicy) GetBannedPhrases
func (x *Assistant_CustomerPolicy) GetBannedPhrases() []*Assistant_CustomerPolicy_BannedPhrasefunc (*Assistant_CustomerPolicy) GetModelArmorConfig
func (x *Assistant_CustomerPolicy) GetModelArmorConfig() *Assistant_CustomerPolicy_ModelArmorConfigfunc (*Assistant_CustomerPolicy) ProtoMessage
func (*Assistant_CustomerPolicy) ProtoMessage()func (*Assistant_CustomerPolicy) ProtoReflect
func (x *Assistant_CustomerPolicy) ProtoReflect() protoreflect.Messagefunc (*Assistant_CustomerPolicy) Reset
func (x *Assistant_CustomerPolicy) Reset()func (*Assistant_CustomerPolicy) String
func (x *Assistant_CustomerPolicy) String() stringAssistant_CustomerPolicy_BannedPhrase
type Assistant_CustomerPolicy_BannedPhrase struct {
// Required. The raw string content to be banned.
Phrase string `protobuf:"bytes,1,opt,name=phrase,proto3" json:"phrase,omitempty"`
// Optional. Match type for the banned phrase.
MatchType Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType `protobuf:"varint,2,opt,name=match_type,json=matchType,proto3,enum=google.cloud.discoveryengine.v1beta.Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType" json:"match_type,omitempty"`
// Optional. If true, diacritical marks (e.g., accents, umlauts) are
// ignored when matching banned phrases. For example, "cafe" would match
// "café".
IgnoreDiacritics bool `protobuf:"varint,3,opt,name=ignore_diacritics,json=ignoreDiacritics,proto3" json:"ignore_diacritics,omitempty"`
// contains filtered or unexported fields
}Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.
func (*Assistant_CustomerPolicy_BannedPhrase) Descriptor
func (*Assistant_CustomerPolicy_BannedPhrase) Descriptor() ([]byte, []int)Deprecated: Use Assistant_CustomerPolicy_BannedPhrase.ProtoReflect.Descriptor instead.
func (*Assistant_CustomerPolicy_BannedPhrase) GetIgnoreDiacritics
func (x *Assistant_CustomerPolicy_BannedPhrase) GetIgnoreDiacritics() boolfunc (*Assistant_CustomerPolicy_BannedPhrase) GetMatchType
func (x *Assistant_CustomerPolicy_BannedPhrase) GetMatchType() Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchTypefunc (*Assistant_CustomerPolicy_BannedPhrase) GetPhrase
func (x *Assistant_CustomerPolicy_BannedPhrase) GetPhrase() stringfunc (*Assistant_CustomerPolicy_BannedPhrase) ProtoMessage
func (*Assistant_CustomerPolicy_BannedPhrase) ProtoMessage()func (*Assistant_CustomerPolicy_BannedPhrase) ProtoReflect
func (x *Assistant_CustomerPolicy_BannedPhrase) ProtoReflect() protoreflect.Messagefunc (*Assistant_CustomerPolicy_BannedPhrase) Reset
func (x *Assistant_CustomerPolicy_BannedPhrase) Reset()func (*Assistant_CustomerPolicy_BannedPhrase) String
func (x *Assistant_CustomerPolicy_BannedPhrase) String() stringAssistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType
type Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType int32The matching method for the banned phrase.
Assistant_CustomerPolicy_BannedPhrase_BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED, Assistant_CustomerPolicy_BannedPhrase_SIMPLE_STRING_MATCH, Assistant_CustomerPolicy_BannedPhrase_WORD_BOUNDARY_STRING_MATCH
const (
// Defaults to SIMPLE_STRING_MATCH.
Assistant_CustomerPolicy_BannedPhrase_BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType = 0
// The banned phrase matches if it is found anywhere in the text as an
// exact substring.
Assistant_CustomerPolicy_BannedPhrase_SIMPLE_STRING_MATCH Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType = 1
// Banned phrase only matches if the pattern found in the text is
// surrounded by word delimiters. The phrase itself may still contain
// word delimiters.
Assistant_CustomerPolicy_BannedPhrase_WORD_BOUNDARY_STRING_MATCH Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType = 2
)func (Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) Descriptor
func (Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) Descriptor() protoreflect.EnumDescriptorfunc (Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) Enum
func (x Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) Enum() *Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchTypefunc (Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) EnumDescriptor
func (Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) EnumDescriptor() ([]byte, []int)Deprecated: Use Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType.Descriptor instead.
func (Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) Number
func (x Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) Number() protoreflect.EnumNumberfunc (Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) String
func (x Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) String() stringfunc (Assistant_CustomerPolicy_BannedPhrase_BannedPhraseMatchType) Type
Assistant_CustomerPolicy_ModelArmorConfig
type Assistant_CustomerPolicy_ModelArmorConfig struct {
// Optional. The resource name of the Model Armor template for sanitizing
// user prompts. Format:
// `projects/{project}/locations/{location}/templates/{template_id}`
//
// If not specified, no sanitization will be applied to the user prompt.
UserPromptTemplate string `protobuf:"bytes,1,opt,name=user_prompt_template,json=userPromptTemplate,proto3" json:"user_prompt_template,omitempty"`
// Optional. The resource name of the Model Armor template for sanitizing
// assistant responses. Format:
// `projects/{project}/locations/{location}/templates/{template_id}`
//
// If not specified, no sanitization will be applied to the assistant
// response.
ResponseTemplate string `protobuf:"bytes,2,opt,name=response_template,json=responseTemplate,proto3" json:"response_template,omitempty"`
// Optional. Defines the failure mode for Model Armor sanitization.
FailureMode Assistant_CustomerPolicy_ModelArmorConfig_FailureMode `protobuf:"varint,3,opt,name=failure_mode,json=failureMode,proto3,enum=google.cloud.discoveryengine.v1beta.Assistant_CustomerPolicy_ModelArmorConfig_FailureMode" json:"failure_mode,omitempty"`
// contains filtered or unexported fields
}Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.
func (*Assistant_CustomerPolicy_ModelArmorConfig) Descriptor
func (*Assistant_CustomerPolicy_ModelArmorConfig) Descriptor() ([]byte, []int)Deprecated: Use Assistant_CustomerPolicy_ModelArmorConfig.ProtoReflect.Descriptor instead.
func (*Assistant_CustomerPolicy_ModelArmorConfig) GetFailureMode
func (x *Assistant_CustomerPolicy_ModelArmorConfig) GetFailureMode() Assistant_CustomerPolicy_ModelArmorConfig_FailureModefunc (*Assistant_CustomerPolicy_ModelArmorConfig) GetResponseTemplate
func (x *Assistant_CustomerPolicy_ModelArmorConfig) GetResponseTemplate() stringfunc (*Assistant_CustomerPolicy_ModelArmorConfig) GetUserPromptTemplate
func (x *Assistant_CustomerPolicy_ModelArmorConfig) GetUserPromptTemplate() stringfunc (*Assistant_CustomerPolicy_ModelArmorConfig) ProtoMessage
func (*Assistant_CustomerPolicy_ModelArmorConfig) ProtoMessage()func (*Assistant_CustomerPolicy_ModelArmorConfig) ProtoReflect
func (x *Assistant_CustomerPolicy_ModelArmorConfig) ProtoReflect() protoreflect.Messagefunc (*Assistant_CustomerPolicy_ModelArmorConfig) Reset
func (x *Assistant_CustomerPolicy_ModelArmorConfig) Reset()func (*Assistant_CustomerPolicy_ModelArmorConfig) String
func (x *Assistant_CustomerPolicy_ModelArmorConfig) String() stringAssistant_CustomerPolicy_ModelArmorConfig_FailureMode
type Assistant_CustomerPolicy_ModelArmorConfig_FailureMode int32Determines the behavior when Model Armor fails to process a request.
Assistant_CustomerPolicy_ModelArmorConfig_FAILURE_MODE_UNSPECIFIED, Assistant_CustomerPolicy_ModelArmorConfig_FAIL_OPEN, Assistant_CustomerPolicy_ModelArmorConfig_FAIL_CLOSED
const (
// Unspecified failure mode, default behavior is `FAIL_CLOSED`.
Assistant_CustomerPolicy_ModelArmorConfig_FAILURE_MODE_UNSPECIFIED Assistant_CustomerPolicy_ModelArmorConfig_FailureMode = 0
// In case of a Model Armor processing failure, the request is allowed
// to proceed without any changes.
Assistant_CustomerPolicy_ModelArmorConfig_FAIL_OPEN Assistant_CustomerPolicy_ModelArmorConfig_FailureMode = 1
// In case of a Model Armor processing failure, the request is rejected.
Assistant_CustomerPolicy_ModelArmorConfig_FAIL_CLOSED Assistant_CustomerPolicy_ModelArmorConfig_FailureMode = 2
)func (Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) Descriptor
func (Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) Descriptor() protoreflect.EnumDescriptorfunc (Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) Enum
func (x Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) Enum() *Assistant_CustomerPolicy_ModelArmorConfig_FailureModefunc (Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) EnumDescriptor
func (Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) EnumDescriptor() ([]byte, []int)Deprecated: Use Assistant_CustomerPolicy_ModelArmorConfig_FailureMode.Descriptor instead.
func (Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) Number
func (x Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) Number() protoreflect.EnumNumberfunc (Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) String
func (x Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) String() stringfunc (Assistant_CustomerPolicy_ModelArmorConfig_FailureMode) Type
Assistant_GenerationConfig
type Assistant_GenerationConfig struct {
// Optional. The default model to use for assistant.
DefaultModelId string `protobuf:"bytes,1,opt,name=default_model_id,json=defaultModelId,proto3" json:"default_model_id,omitempty"`
// Optional. The list of models that are allowed to be used for assistant.
AllowedModelIds []string `protobuf:"bytes,2,rep,name=allowed_model_ids,json=allowedModelIds,proto3" json:"allowed_model_ids,omitempty"`
// System instruction, also known as the prompt preamble for LLM calls.
// See also
// https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
SystemInstruction *Assistant_GenerationConfig_SystemInstruction `protobuf:"bytes,3,opt,name=system_instruction,json=systemInstruction,proto3" json:"system_instruction,omitempty"`
// The default language to use for the generation of the assistant
// response.
// Use an ISO 639-1 language code such as `en`.
// If not specified, the language will be automatically detected.
DefaultLanguage string `protobuf:"bytes,4,opt,name=default_language,json=defaultLanguage,proto3" json:"default_language,omitempty"`
// contains filtered or unexported fields
}Configuration for the generation of the assistant response.
func (*Assistant_GenerationConfig) Descriptor
func (*Assistant_GenerationConfig) Descriptor() ([]byte, []int)Deprecated: Use Assistant_GenerationConfig.ProtoReflect.Descriptor instead.
func (*Assistant_GenerationConfig) GetAllowedModelIds
func (x *Assistant_GenerationConfig) GetAllowedModelIds() []stringfunc (*Assistant_GenerationConfig) GetDefaultLanguage
func (x *Assistant_GenerationConfig) GetDefaultLanguage() stringfunc (*Assistant_GenerationConfig) GetDefaultModelId
func (x *Assistant_GenerationConfig) GetDefaultModelId() stringfunc (*Assistant_GenerationConfig) GetSystemInstruction
func (x *Assistant_GenerationConfig) GetSystemInstruction() *Assistant_GenerationConfig_SystemInstructionfunc (*Assistant_GenerationConfig) ProtoMessage
func (*Assistant_GenerationConfig) ProtoMessage()func (*Assistant_GenerationConfig) ProtoReflect
func (x *Assistant_GenerationConfig) ProtoReflect() protoreflect.Messagefunc (*Assistant_GenerationConfig) Reset
func (x *Assistant_GenerationConfig) Reset()func (*Assistant_GenerationConfig) String
func (x *Assistant_GenerationConfig) String() stringAssistant_GenerationConfig_SystemInstruction
type Assistant_GenerationConfig_SystemInstruction struct {
// Optional. Additional system instruction that will be added to the
// default system instruction.
AdditionalSystemInstruction string `protobuf:"bytes,2,opt,name=additional_system_instruction,json=additionalSystemInstruction,proto3" json:"additional_system_instruction,omitempty"`
// contains filtered or unexported fields
}System instruction, also known as the prompt preamble for LLM calls.
func (*Assistant_GenerationConfig_SystemInstruction) Descriptor
func (*Assistant_GenerationConfig_SystemInstruction) Descriptor() ([]byte, []int)Deprecated: Use Assistant_GenerationConfig_SystemInstruction.ProtoReflect.Descriptor instead.
func (*Assistant_GenerationConfig_SystemInstruction) GetAdditionalSystemInstruction
func (x *Assistant_GenerationConfig_SystemInstruction) GetAdditionalSystemInstruction() stringfunc (*Assistant_GenerationConfig_SystemInstruction) ProtoMessage
func (*Assistant_GenerationConfig_SystemInstruction) ProtoMessage()func (*Assistant_GenerationConfig_SystemInstruction) ProtoReflect
func (x *Assistant_GenerationConfig_SystemInstruction) ProtoReflect() protoreflect.Messagefunc (*Assistant_GenerationConfig_SystemInstruction) Reset
func (x *Assistant_GenerationConfig_SystemInstruction) Reset()func (*Assistant_GenerationConfig_SystemInstruction) String
func (x *Assistant_GenerationConfig_SystemInstruction) String() stringAssistant_ToolInfo
type Assistant_ToolInfo struct {
// The name of the tool as defined by
// DataConnectorService.QueryAvailableActions.
// Note: it's using `action` in the DataConnectorService apis, but they are
// the same as the `tool` here.
ToolName string `protobuf:"bytes,1,opt,name=tool_name,json=toolName,proto3" json:"tool_name,omitempty"`
// The display name of the tool.
ToolDisplayName string `protobuf:"bytes,2,opt,name=tool_display_name,json=toolDisplayName,proto3" json:"tool_display_name,omitempty"`
// contains filtered or unexported fields
}Information to identify a tool.
func (*Assistant_ToolInfo) Descriptor
func (*Assistant_ToolInfo) Descriptor() ([]byte, []int)Deprecated: Use Assistant_ToolInfo.ProtoReflect.Descriptor instead.
func (*Assistant_ToolInfo) GetToolDisplayName
func (x *Assistant_ToolInfo) GetToolDisplayName() stringfunc (*Assistant_ToolInfo) GetToolName
func (x *Assistant_ToolInfo) GetToolName() stringfunc (*Assistant_ToolInfo) ProtoMessage
func (*Assistant_ToolInfo) ProtoMessage()func (*Assistant_ToolInfo) ProtoReflect
func (x *Assistant_ToolInfo) ProtoReflect() protoreflect.Messagefunc (*Assistant_ToolInfo) Reset
func (x *Assistant_ToolInfo) Reset()func (*Assistant_ToolInfo) String
func (x *Assistant_ToolInfo) String() stringAssistant_ToolList
type Assistant_ToolList struct {
// The list of tools with corresponding tool information.
ToolInfo []*Assistant_ToolInfo `protobuf:"bytes,1,rep,name=tool_info,json=toolInfo,proto3" json:"tool_info,omitempty"`
// contains filtered or unexported fields
}The enabled tools on a connector
func (*Assistant_ToolList) Descriptor
func (*Assistant_ToolList) Descriptor() ([]byte, []int)Deprecated: Use Assistant_ToolList.ProtoReflect.Descriptor instead.
func (*Assistant_ToolList) GetToolInfo
func (x *Assistant_ToolList) GetToolInfo() []*Assistant_ToolInfofunc (*Assistant_ToolList) ProtoMessage
func (*Assistant_ToolList) ProtoMessage()func (*Assistant_ToolList) ProtoReflect
func (x *Assistant_ToolList) ProtoReflect() protoreflect.Messagefunc (*Assistant_ToolList) Reset
func (x *Assistant_ToolList) Reset()func (*Assistant_ToolList) String
func (x *Assistant_ToolList) String() stringAssistant_WebGroundingType
type Assistant_WebGroundingType int32The type of web grounding to use.
Assistant_WEB_GROUNDING_TYPE_UNSPECIFIED, Assistant_WEB_GROUNDING_TYPE_DISABLED, Assistant_WEB_GROUNDING_TYPE_GOOGLE_SEARCH, Assistant_WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH
const (
// Default, unspecified setting. This is the same as disabled.
Assistant_WEB_GROUNDING_TYPE_UNSPECIFIED Assistant_WebGroundingType = 0
// Web grounding is disabled.
Assistant_WEB_GROUNDING_TYPE_DISABLED Assistant_WebGroundingType = 1
// Grounding with Google Search is enabled.
Assistant_WEB_GROUNDING_TYPE_GOOGLE_SEARCH Assistant_WebGroundingType = 2
// Grounding with Enterprise Web Search is enabled.
Assistant_WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH Assistant_WebGroundingType = 3
)func (Assistant_WebGroundingType) Descriptor
func (Assistant_WebGroundingType) Descriptor() protoreflect.EnumDescriptorfunc (Assistant_WebGroundingType) Enum
func (x Assistant_WebGroundingType) Enum() *Assistant_WebGroundingTypefunc (Assistant_WebGroundingType) EnumDescriptor
func (Assistant_WebGroundingType) EnumDescriptor() ([]byte, []int)Deprecated: Use Assistant_WebGroundingType.Descriptor instead.
func (Assistant_WebGroundingType) Number
func (x Assistant_WebGroundingType) Number() protoreflect.EnumNumberfunc (Assistant_WebGroundingType) String
func (x Assistant_WebGroundingType) String() stringfunc (Assistant_WebGroundingType) Type
func (Assistant_WebGroundingType) Type() protoreflect.EnumTypeBatchCreateTargetSiteMetadata
type BatchCreateTargetSiteMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*BatchCreateTargetSiteMetadata) Descriptor
func (*BatchCreateTargetSiteMetadata) Descriptor() ([]byte, []int)Deprecated: Use BatchCreateTargetSiteMetadata.ProtoReflect.Descriptor instead.
func (*BatchCreateTargetSiteMetadata) GetCreateTime
func (x *BatchCreateTargetSiteMetadata) GetCreateTime() *timestamppb.Timestampfunc (*BatchCreateTargetSiteMetadata) GetUpdateTime
func (x *BatchCreateTargetSiteMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*BatchCreateTargetSiteMetadata) ProtoMessage
func (*BatchCreateTargetSiteMetadata) ProtoMessage()func (*BatchCreateTargetSiteMetadata) ProtoReflect
func (x *BatchCreateTargetSiteMetadata) ProtoReflect() protoreflect.Messagefunc (*BatchCreateTargetSiteMetadata) Reset
func (x *BatchCreateTargetSiteMetadata) Reset()func (*BatchCreateTargetSiteMetadata) String
func (x *BatchCreateTargetSiteMetadata) String() stringBatchCreateTargetSitesRequest
type BatchCreateTargetSitesRequest struct {
// Required. The parent resource shared by all TargetSites being created.
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
// The parent field in the CreateBookRequest messages must either be empty or
// match this field.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The request message specifying the resources to create.
// A maximum of 20 TargetSites can be created in a batch.
Requests []*CreateTargetSiteRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] method.
func (*BatchCreateTargetSitesRequest) Descriptor
func (*BatchCreateTargetSitesRequest) Descriptor() ([]byte, []int)Deprecated: Use BatchCreateTargetSitesRequest.ProtoReflect.Descriptor instead.
func (*BatchCreateTargetSitesRequest) GetParent
func (x *BatchCreateTargetSitesRequest) GetParent() stringfunc (*BatchCreateTargetSitesRequest) GetRequests
func (x *BatchCreateTargetSitesRequest) GetRequests() []*CreateTargetSiteRequestfunc (*BatchCreateTargetSitesRequest) ProtoMessage
func (*BatchCreateTargetSitesRequest) ProtoMessage()func (*BatchCreateTargetSitesRequest) ProtoReflect
func (x *BatchCreateTargetSitesRequest) ProtoReflect() protoreflect.Messagefunc (*BatchCreateTargetSitesRequest) Reset
func (x *BatchCreateTargetSitesRequest) Reset()func (*BatchCreateTargetSitesRequest) String
func (x *BatchCreateTargetSitesRequest) String() stringBatchCreateTargetSitesResponse
type BatchCreateTargetSitesResponse struct {
// TargetSites created.
TargetSites []*TargetSite `protobuf:"bytes,1,rep,name=target_sites,json=targetSites,proto3" json:"target_sites,omitempty"`
// contains filtered or unexported fields
}Response message for [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] method.
func (*BatchCreateTargetSitesResponse) Descriptor
func (*BatchCreateTargetSitesResponse) Descriptor() ([]byte, []int)Deprecated: Use BatchCreateTargetSitesResponse.ProtoReflect.Descriptor instead.
func (*BatchCreateTargetSitesResponse) GetTargetSites
func (x *BatchCreateTargetSitesResponse) GetTargetSites() []*TargetSitefunc (*BatchCreateTargetSitesResponse) ProtoMessage
func (*BatchCreateTargetSitesResponse) ProtoMessage()func (*BatchCreateTargetSitesResponse) ProtoReflect
func (x *BatchCreateTargetSitesResponse) ProtoReflect() protoreflect.Messagefunc (*BatchCreateTargetSitesResponse) Reset
func (x *BatchCreateTargetSitesResponse) Reset()func (*BatchCreateTargetSitesResponse) String
func (x *BatchCreateTargetSitesResponse) String() stringBatchGetDocumentsMetadataRequest
type BatchGetDocumentsMetadataRequest struct {
// Required. The parent branch resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Matcher for the
// [Document][google.cloud.discoveryengine.v1beta.Document]s.
Matcher *BatchGetDocumentsMetadataRequest_Matcher `protobuf:"bytes,2,opt,name=matcher,proto3" json:"matcher,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] method.
func (*BatchGetDocumentsMetadataRequest) Descriptor
func (*BatchGetDocumentsMetadataRequest) Descriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataRequest.ProtoReflect.Descriptor instead.
func (*BatchGetDocumentsMetadataRequest) GetMatcher
func (x *BatchGetDocumentsMetadataRequest) GetMatcher() *BatchGetDocumentsMetadataRequest_Matcherfunc (*BatchGetDocumentsMetadataRequest) GetParent
func (x *BatchGetDocumentsMetadataRequest) GetParent() stringfunc (*BatchGetDocumentsMetadataRequest) ProtoMessage
func (*BatchGetDocumentsMetadataRequest) ProtoMessage()func (*BatchGetDocumentsMetadataRequest) ProtoReflect
func (x *BatchGetDocumentsMetadataRequest) ProtoReflect() protoreflect.Messagefunc (*BatchGetDocumentsMetadataRequest) Reset
func (x *BatchGetDocumentsMetadataRequest) Reset()func (*BatchGetDocumentsMetadataRequest) String
func (x *BatchGetDocumentsMetadataRequest) String() stringBatchGetDocumentsMetadataRequest_FhirMatcher
type BatchGetDocumentsMetadataRequest_FhirMatcher struct {
// Required. The FHIR resources to match by.
// Format:
// projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}
FhirResources []string `protobuf:"bytes,1,rep,name=fhir_resources,json=fhirResources,proto3" json:"fhir_resources,omitempty"`
// contains filtered or unexported fields
}Matcher for the [Document][google.cloud.discoveryengine.v1beta.Document]s by FHIR resource names.
func (*BatchGetDocumentsMetadataRequest_FhirMatcher) Descriptor
func (*BatchGetDocumentsMetadataRequest_FhirMatcher) Descriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataRequest_FhirMatcher.ProtoReflect.Descriptor instead.
func (*BatchGetDocumentsMetadataRequest_FhirMatcher) GetFhirResources
func (x *BatchGetDocumentsMetadataRequest_FhirMatcher) GetFhirResources() []stringfunc (*BatchGetDocumentsMetadataRequest_FhirMatcher) ProtoMessage
func (*BatchGetDocumentsMetadataRequest_FhirMatcher) ProtoMessage()func (*BatchGetDocumentsMetadataRequest_FhirMatcher) ProtoReflect
func (x *BatchGetDocumentsMetadataRequest_FhirMatcher) ProtoReflect() protoreflect.Messagefunc (*BatchGetDocumentsMetadataRequest_FhirMatcher) Reset
func (x *BatchGetDocumentsMetadataRequest_FhirMatcher) Reset()func (*BatchGetDocumentsMetadataRequest_FhirMatcher) String
func (x *BatchGetDocumentsMetadataRequest_FhirMatcher) String() stringBatchGetDocumentsMetadataRequest_Matcher
type BatchGetDocumentsMetadataRequest_Matcher struct {
// Matcher for the
// [Document][google.cloud.discoveryengine.v1beta.Document]s.
//
// Types that are valid to be assigned to Matcher:
//
// *BatchGetDocumentsMetadataRequest_Matcher_UrisMatcher
// *BatchGetDocumentsMetadataRequest_Matcher_FhirMatcher
Matcher isBatchGetDocumentsMetadataRequest_Matcher_Matcher `protobuf_oneof:"matcher"`
// contains filtered or unexported fields
}Matcher for the [Document][google.cloud.discoveryengine.v1beta.Document]s. Currently supports matching by exact URIs.
func (*BatchGetDocumentsMetadataRequest_Matcher) Descriptor
func (*BatchGetDocumentsMetadataRequest_Matcher) Descriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataRequest_Matcher.ProtoReflect.Descriptor instead.
func (*BatchGetDocumentsMetadataRequest_Matcher) GetFhirMatcher
func (x *BatchGetDocumentsMetadataRequest_Matcher) GetFhirMatcher() *BatchGetDocumentsMetadataRequest_FhirMatcherfunc (*BatchGetDocumentsMetadataRequest_Matcher) GetMatcher
func (x *BatchGetDocumentsMetadataRequest_Matcher) GetMatcher() isBatchGetDocumentsMetadataRequest_Matcher_Matcherfunc (*BatchGetDocumentsMetadataRequest_Matcher) GetUrisMatcher
func (x *BatchGetDocumentsMetadataRequest_Matcher) GetUrisMatcher() *BatchGetDocumentsMetadataRequest_UrisMatcherfunc (*BatchGetDocumentsMetadataRequest_Matcher) ProtoMessage
func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoMessage()func (*BatchGetDocumentsMetadataRequest_Matcher) ProtoReflect
func (x *BatchGetDocumentsMetadataRequest_Matcher) ProtoReflect() protoreflect.Messagefunc (*BatchGetDocumentsMetadataRequest_Matcher) Reset
func (x *BatchGetDocumentsMetadataRequest_Matcher) Reset()func (*BatchGetDocumentsMetadataRequest_Matcher) String
func (x *BatchGetDocumentsMetadataRequest_Matcher) String() stringBatchGetDocumentsMetadataRequest_Matcher_FhirMatcher
type BatchGetDocumentsMetadataRequest_Matcher_FhirMatcher struct {
// Matcher by FHIR resource names.
FhirMatcher *BatchGetDocumentsMetadataRequest_FhirMatcher `protobuf:"bytes,2,opt,name=fhir_matcher,json=fhirMatcher,proto3,oneof"`
}BatchGetDocumentsMetadataRequest_Matcher_UrisMatcher
type BatchGetDocumentsMetadataRequest_Matcher_UrisMatcher struct {
// Matcher by exact URIs.
UrisMatcher *BatchGetDocumentsMetadataRequest_UrisMatcher `protobuf:"bytes,1,opt,name=uris_matcher,json=urisMatcher,proto3,oneof"`
}BatchGetDocumentsMetadataRequest_UrisMatcher
type BatchGetDocumentsMetadataRequest_UrisMatcher struct {
// The exact URIs to match by.
Uris []string `protobuf:"bytes,1,rep,name=uris,proto3" json:"uris,omitempty"`
// contains filtered or unexported fields
}Matcher for the [Document][google.cloud.discoveryengine.v1beta.Document]s by exact uris.
func (*BatchGetDocumentsMetadataRequest_UrisMatcher) Descriptor
func (*BatchGetDocumentsMetadataRequest_UrisMatcher) Descriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataRequest_UrisMatcher.ProtoReflect.Descriptor instead.
func (*BatchGetDocumentsMetadataRequest_UrisMatcher) GetUris
func (x *BatchGetDocumentsMetadataRequest_UrisMatcher) GetUris() []stringfunc (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoMessage
func (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoMessage()func (*BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoReflect
func (x *BatchGetDocumentsMetadataRequest_UrisMatcher) ProtoReflect() protoreflect.Messagefunc (*BatchGetDocumentsMetadataRequest_UrisMatcher) Reset
func (x *BatchGetDocumentsMetadataRequest_UrisMatcher) Reset()func (*BatchGetDocumentsMetadataRequest_UrisMatcher) String
func (x *BatchGetDocumentsMetadataRequest_UrisMatcher) String() stringBatchGetDocumentsMetadataResponse
type BatchGetDocumentsMetadataResponse struct {
// The metadata of the
// [Document][google.cloud.discoveryengine.v1beta.Document]s.
DocumentsMetadata []*BatchGetDocumentsMetadataResponse_DocumentMetadata `protobuf:"bytes,1,rep,name=documents_metadata,json=documentsMetadata,proto3" json:"documents_metadata,omitempty"`
// contains filtered or unexported fields
}Response message for [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] method.
func (*BatchGetDocumentsMetadataResponse) Descriptor
func (*BatchGetDocumentsMetadataResponse) Descriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataResponse.ProtoReflect.Descriptor instead.
func (*BatchGetDocumentsMetadataResponse) GetDocumentsMetadata
func (x *BatchGetDocumentsMetadataResponse) GetDocumentsMetadata() []*BatchGetDocumentsMetadataResponse_DocumentMetadatafunc (*BatchGetDocumentsMetadataResponse) ProtoMessage
func (*BatchGetDocumentsMetadataResponse) ProtoMessage()func (*BatchGetDocumentsMetadataResponse) ProtoReflect
func (x *BatchGetDocumentsMetadataResponse) ProtoReflect() protoreflect.Messagefunc (*BatchGetDocumentsMetadataResponse) Reset
func (x *BatchGetDocumentsMetadataResponse) Reset()func (*BatchGetDocumentsMetadataResponse) String
func (x *BatchGetDocumentsMetadataResponse) String() stringBatchGetDocumentsMetadataResponse_DocumentMetadata
type BatchGetDocumentsMetadataResponse_DocumentMetadata struct {
// The value of the matcher that was used to match the
// [Document][google.cloud.discoveryengine.v1beta.Document].
MatcherValue *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue `protobuf:"bytes,2,opt,name=matcher_value,json=matcherValue,proto3" json:"matcher_value,omitempty"`
// The state of the document.
State BatchGetDocumentsMetadataResponse_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1beta.BatchGetDocumentsMetadataResponse_State" json:"state,omitempty"`
// The timestamp of the last time the
// [Document][google.cloud.discoveryengine.v1beta.Document] was last
// indexed.
LastRefreshedTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=last_refreshed_time,json=lastRefreshedTime,proto3" json:"last_refreshed_time,omitempty"`
// The data ingestion source of the
// [Document][google.cloud.discoveryengine.v1beta.Document].
//
// Allowed values are:
//
// * `batch`: Data ingested via Batch API, e.g., ImportDocuments.
// * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.
DataIngestionSource string `protobuf:"bytes,5,opt,name=data_ingestion_source,json=dataIngestionSource,proto3" json:"data_ingestion_source,omitempty"`
// contains filtered or unexported fields
}The metadata of a [Document][google.cloud.discoveryengine.v1beta.Document].
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) Descriptor
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) Descriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata.ProtoReflect.Descriptor instead.
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetDataIngestionSource
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetDataIngestionSource() stringfunc (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetLastRefreshedTime
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetLastRefreshedTime() *timestamppb.Timestampfunc (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetMatcherValue
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetMatcherValue() *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValuefunc (*BatchGetDocumentsMetadataResponse_DocumentMetadata) GetState
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) GetState() BatchGetDocumentsMetadataResponse_Statefunc (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoMessage
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoMessage()func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoReflect
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) ProtoReflect() protoreflect.Messagefunc (*BatchGetDocumentsMetadataResponse_DocumentMetadata) Reset
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) Reset()func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) String
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata) String() stringBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue
type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue struct {
// The value of the matcher that was used to match the
// [Document][google.cloud.discoveryengine.v1beta.Document].
//
// Types that are valid to be assigned to MatcherValue:
//
// *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri
// *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_FhirResource
MatcherValue isBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_MatcherValue `protobuf_oneof:"matcher_value"`
// contains filtered or unexported fields
}The value of the matcher that was used to match the [Document][google.cloud.discoveryengine.v1beta.Document].
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Descriptor
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Descriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue.ProtoReflect.Descriptor instead.
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetFhirResource
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetFhirResource() stringfunc (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetMatcherValue
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetMatcherValue() isBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_MatcherValuefunc (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetUri
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) GetUri() stringfunc (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoMessage
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoMessage()func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoReflect
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) ProtoReflect() protoreflect.Messagefunc (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Reset
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Reset()func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) String
func (x *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) String() stringBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_FhirResource
type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_FhirResource struct {
// Format:
// projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}
FhirResource string `protobuf:"bytes,2,opt,name=fhir_resource,json=fhirResource,proto3,oneof"`
}BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri
type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri struct {
// If match by URI, the URI of the
// [Document][google.cloud.discoveryengine.v1beta.Document].
Uri string `protobuf:"bytes,1,opt,name=uri,proto3,oneof"`
}BatchGetDocumentsMetadataResponse_State
type BatchGetDocumentsMetadataResponse_State int32The state of the [Document][google.cloud.discoveryengine.v1beta.Document].
BatchGetDocumentsMetadataResponse_STATE_UNSPECIFIED, BatchGetDocumentsMetadataResponse_INDEXED, BatchGetDocumentsMetadataResponse_NOT_IN_TARGET_SITE, BatchGetDocumentsMetadataResponse_NOT_IN_INDEX
const (
// Should never be set.
BatchGetDocumentsMetadataResponse_STATE_UNSPECIFIED BatchGetDocumentsMetadataResponse_State = 0
// The [Document][google.cloud.discoveryengine.v1beta.Document] is indexed.
BatchGetDocumentsMetadataResponse_INDEXED BatchGetDocumentsMetadataResponse_State = 1
// The [Document][google.cloud.discoveryengine.v1beta.Document] is not
// indexed because its URI is not in the
// [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
BatchGetDocumentsMetadataResponse_NOT_IN_TARGET_SITE BatchGetDocumentsMetadataResponse_State = 2
// The [Document][google.cloud.discoveryengine.v1beta.Document] is not
// indexed.
BatchGetDocumentsMetadataResponse_NOT_IN_INDEX BatchGetDocumentsMetadataResponse_State = 3
)func (BatchGetDocumentsMetadataResponse_State) Descriptor
func (BatchGetDocumentsMetadataResponse_State) Descriptor() protoreflect.EnumDescriptorfunc (BatchGetDocumentsMetadataResponse_State) Enum
func (BatchGetDocumentsMetadataResponse_State) EnumDescriptor
func (BatchGetDocumentsMetadataResponse_State) EnumDescriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataResponse_State.Descriptor instead.
func (BatchGetDocumentsMetadataResponse_State) Number
func (x BatchGetDocumentsMetadataResponse_State) Number() protoreflect.EnumNumberfunc (BatchGetDocumentsMetadataResponse_State) String
func (x BatchGetDocumentsMetadataResponse_State) String() stringfunc (BatchGetDocumentsMetadataResponse_State) Type
func (BatchGetDocumentsMetadataResponse_State) Type() protoreflect.EnumTypeBatchUpdateUserLicensesMetadata
type BatchUpdateUserLicensesMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Count of user licenses successfully updated.
SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
// Count of user licenses that failed to be updated.
FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1beta.UserLicenseService.BatchUpdateUserLicenses] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*BatchUpdateUserLicensesMetadata) Descriptor
func (*BatchUpdateUserLicensesMetadata) Descriptor() ([]byte, []int)Deprecated: Use BatchUpdateUserLicensesMetadata.ProtoReflect.Descriptor instead.
func (*BatchUpdateUserLicensesMetadata) GetCreateTime
func (x *BatchUpdateUserLicensesMetadata) GetCreateTime() *timestamppb.Timestampfunc (*BatchUpdateUserLicensesMetadata) GetFailureCount
func (x *BatchUpdateUserLicensesMetadata) GetFailureCount() int64func (*BatchUpdateUserLicensesMetadata) GetSuccessCount
func (x *BatchUpdateUserLicensesMetadata) GetSuccessCount() int64func (*BatchUpdateUserLicensesMetadata) GetUpdateTime
func (x *BatchUpdateUserLicensesMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*BatchUpdateUserLicensesMetadata) ProtoMessage
func (*BatchUpdateUserLicensesMetadata) ProtoMessage()func (*BatchUpdateUserLicensesMetadata) ProtoReflect
func (x *BatchUpdateUserLicensesMetadata) ProtoReflect() protoreflect.Messagefunc (*BatchUpdateUserLicensesMetadata) Reset
func (x *BatchUpdateUserLicensesMetadata) Reset()func (*BatchUpdateUserLicensesMetadata) String
func (x *BatchUpdateUserLicensesMetadata) String() stringBatchUpdateUserLicensesRequest
type BatchUpdateUserLicensesRequest struct {
// Required. The source of the input.
//
// Types that are valid to be assigned to Source:
//
// *BatchUpdateUserLicensesRequest_InlineSource_
Source isBatchUpdateUserLicensesRequest_Source `protobuf_oneof:"source"`
// Required. The parent
// [UserStore][google.cloud.discoveryengine.v1beta.UserStore] resource name,
// format:
// `projects/{project}/locations/{location}/userStores/{user_store_id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. If true, if user licenses removed associated license config, the
// user license will be deleted. By default which is false, the user license
// will be updated to unassigned state.
DeleteUnassignedUserLicenses bool `protobuf:"varint,4,opt,name=delete_unassigned_user_licenses,json=deleteUnassignedUserLicenses,proto3" json:"delete_unassigned_user_licenses,omitempty"`
// contains filtered or unexported fields
}Request message for [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1beta.UserLicenseService.BatchUpdateUserLicenses] method.
func (*BatchUpdateUserLicensesRequest) Descriptor
func (*BatchUpdateUserLicensesRequest) Descriptor() ([]byte, []int)Deprecated: Use BatchUpdateUserLicensesRequest.ProtoReflect.Descriptor instead.
func (*BatchUpdateUserLicensesRequest) GetDeleteUnassignedUserLicenses
func (x *BatchUpdateUserLicensesRequest) GetDeleteUnassignedUserLicenses() boolfunc (*BatchUpdateUserLicensesRequest) GetInlineSource
func (x *BatchUpdateUserLicensesRequest) GetInlineSource() *BatchUpdateUserLicensesRequest_InlineSourcefunc (*BatchUpdateUserLicensesRequest) GetParent
func (x *BatchUpdateUserLicensesRequest) GetParent() stringfunc (*BatchUpdateUserLicensesRequest) GetSource
func (x *BatchUpdateUserLicensesRequest) GetSource() isBatchUpdateUserLicensesRequest_Sourcefunc (*BatchUpdateUserLicensesRequest) ProtoMessage
func (*BatchUpdateUserLicensesRequest) ProtoMessage()func (*BatchUpdateUserLicensesRequest) ProtoReflect
func (x *BatchUpdateUserLicensesRequest) ProtoReflect() protoreflect.Messagefunc (*BatchUpdateUserLicensesRequest) Reset
func (x *BatchUpdateUserLicensesRequest) Reset()func (*BatchUpdateUserLicensesRequest) String
func (x *BatchUpdateUserLicensesRequest) String() stringBatchUpdateUserLicensesRequest_InlineSource
type BatchUpdateUserLicensesRequest_InlineSource struct {
// Required. A list of user licenses to update. Each user license
// must have a valid
// [UserLicense.user_principal][google.cloud.discoveryengine.v1beta.UserLicense.user_principal].
UserLicenses []*UserLicense `protobuf:"bytes,1,rep,name=user_licenses,json=userLicenses,proto3" json:"user_licenses,omitempty"`
// Optional. The list of fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}The inline source for the input config for BatchUpdateUserLicenses method.
func (*BatchUpdateUserLicensesRequest_InlineSource) Descriptor
func (*BatchUpdateUserLicensesRequest_InlineSource) Descriptor() ([]byte, []int)Deprecated: Use BatchUpdateUserLicensesRequest_InlineSource.ProtoReflect.Descriptor instead.
func (*BatchUpdateUserLicensesRequest_InlineSource) GetUpdateMask
func (x *BatchUpdateUserLicensesRequest_InlineSource) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*BatchUpdateUserLicensesRequest_InlineSource) GetUserLicenses
func (x *BatchUpdateUserLicensesRequest_InlineSource) GetUserLicenses() []*UserLicensefunc (*BatchUpdateUserLicensesRequest_InlineSource) ProtoMessage
func (*BatchUpdateUserLicensesRequest_InlineSource) ProtoMessage()func (*BatchUpdateUserLicensesRequest_InlineSource) ProtoReflect
func (x *BatchUpdateUserLicensesRequest_InlineSource) ProtoReflect() protoreflect.Messagefunc (*BatchUpdateUserLicensesRequest_InlineSource) Reset
func (x *BatchUpdateUserLicensesRequest_InlineSource) Reset()func (*BatchUpdateUserLicensesRequest_InlineSource) String
func (x *BatchUpdateUserLicensesRequest_InlineSource) String() stringBatchUpdateUserLicensesRequest_InlineSource_
type BatchUpdateUserLicensesRequest_InlineSource_ struct {
// The inline source for the input content for document embeddings.
InlineSource *BatchUpdateUserLicensesRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}BatchUpdateUserLicensesResponse
type BatchUpdateUserLicensesResponse struct {
// UserLicenses successfully updated.
UserLicenses []*UserLicense `protobuf:"bytes,1,rep,name=user_licenses,json=userLicenses,proto3" json:"user_licenses,omitempty"`
// A sample of errors encountered while processing the request.
ErrorSamples []*status.Status `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// contains filtered or unexported fields
}Response message for [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1beta.UserLicenseService.BatchUpdateUserLicenses] method.
func (*BatchUpdateUserLicensesResponse) Descriptor
func (*BatchUpdateUserLicensesResponse) Descriptor() ([]byte, []int)Deprecated: Use BatchUpdateUserLicensesResponse.ProtoReflect.Descriptor instead.
func (*BatchUpdateUserLicensesResponse) GetErrorSamples
func (x *BatchUpdateUserLicensesResponse) GetErrorSamples() []*status.Statusfunc (*BatchUpdateUserLicensesResponse) GetUserLicenses
func (x *BatchUpdateUserLicensesResponse) GetUserLicenses() []*UserLicensefunc (*BatchUpdateUserLicensesResponse) ProtoMessage
func (*BatchUpdateUserLicensesResponse) ProtoMessage()func (*BatchUpdateUserLicensesResponse) ProtoReflect
func (x *BatchUpdateUserLicensesResponse) ProtoReflect() protoreflect.Messagefunc (*BatchUpdateUserLicensesResponse) Reset
func (x *BatchUpdateUserLicensesResponse) Reset()func (*BatchUpdateUserLicensesResponse) String
func (x *BatchUpdateUserLicensesResponse) String() stringBatchVerifyTargetSitesMetadata
type BatchVerifyTargetSitesMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*BatchVerifyTargetSitesMetadata) Descriptor
func (*BatchVerifyTargetSitesMetadata) Descriptor() ([]byte, []int)Deprecated: Use BatchVerifyTargetSitesMetadata.ProtoReflect.Descriptor instead.
func (*BatchVerifyTargetSitesMetadata) GetCreateTime
func (x *BatchVerifyTargetSitesMetadata) GetCreateTime() *timestamppb.Timestampfunc (*BatchVerifyTargetSitesMetadata) GetUpdateTime
func (x *BatchVerifyTargetSitesMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*BatchVerifyTargetSitesMetadata) ProtoMessage
func (*BatchVerifyTargetSitesMetadata) ProtoMessage()func (*BatchVerifyTargetSitesMetadata) ProtoReflect
func (x *BatchVerifyTargetSitesMetadata) ProtoReflect() protoreflect.Messagefunc (*BatchVerifyTargetSitesMetadata) Reset
func (x *BatchVerifyTargetSitesMetadata) Reset()func (*BatchVerifyTargetSitesMetadata) String
func (x *BatchVerifyTargetSitesMetadata) String() stringBatchVerifyTargetSitesRequest
type BatchVerifyTargetSitesRequest struct {
// Required. The parent resource shared by all TargetSites being verified.
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] method.
func (*BatchVerifyTargetSitesRequest) Descriptor
func (*BatchVerifyTargetSitesRequest) Descriptor() ([]byte, []int)Deprecated: Use BatchVerifyTargetSitesRequest.ProtoReflect.Descriptor instead.
func (*BatchVerifyTargetSitesRequest) GetParent
func (x *BatchVerifyTargetSitesRequest) GetParent() stringfunc (*BatchVerifyTargetSitesRequest) ProtoMessage
func (*BatchVerifyTargetSitesRequest) ProtoMessage()func (*BatchVerifyTargetSitesRequest) ProtoReflect
func (x *BatchVerifyTargetSitesRequest) ProtoReflect() protoreflect.Messagefunc (*BatchVerifyTargetSitesRequest) Reset
func (x *BatchVerifyTargetSitesRequest) Reset()func (*BatchVerifyTargetSitesRequest) String
func (x *BatchVerifyTargetSitesRequest) String() stringBatchVerifyTargetSitesResponse
type BatchVerifyTargetSitesResponse struct {
// contains filtered or unexported fields
}Response message for [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] method.
func (*BatchVerifyTargetSitesResponse) Descriptor
func (*BatchVerifyTargetSitesResponse) Descriptor() ([]byte, []int)Deprecated: Use BatchVerifyTargetSitesResponse.ProtoReflect.Descriptor instead.
func (*BatchVerifyTargetSitesResponse) ProtoMessage
func (*BatchVerifyTargetSitesResponse) ProtoMessage()func (*BatchVerifyTargetSitesResponse) ProtoReflect
func (x *BatchVerifyTargetSitesResponse) ProtoReflect() protoreflect.Messagefunc (*BatchVerifyTargetSitesResponse) Reset
func (x *BatchVerifyTargetSitesResponse) Reset()func (*BatchVerifyTargetSitesResponse) String
func (x *BatchVerifyTargetSitesResponse) String() stringBigQuerySource
type BigQuerySource struct {
// BigQuery table partition info. Leave this empty if the BigQuery table
// is not partitioned.
//
// Types that are valid to be assigned to Partition:
//
// *BigQuerySource_PartitionDate
Partition isBigQuerySource_Partition `protobuf_oneof:"partition"`
// The project ID or the project number that contains the BigQuery source. Has
// a length limit of 128 characters. If not specified, inherits the project
// ID from the parent request.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Required. The BigQuery data set to copy the data from with a length limit
// of 1,024 characters.
DatasetId string `protobuf:"bytes,2,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
// Required. The BigQuery table to copy the data from with a length limit of
// 1,024 characters.
TableId string `protobuf:"bytes,3,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Intermediate Cloud Storage directory used for the import with a length
// limit of 2,000 characters. Can be specified if one wants to have the
// BigQuery export to a specific Cloud Storage directory.
GcsStagingDir string `protobuf:"bytes,4,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
// The schema to use when parsing the data from the source.
//
// Supported values for user event imports:
//
// * `user_event` (default): One
// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per row.
//
// Supported values for document imports:
//
// * `document` (default): One
// [Document][google.cloud.discoveryengine.v1beta.Document] format per
//
// row. Each document must have a valid
// [Document.id][google.cloud.discoveryengine.v1beta.Document.id] and one of
// [Document.json_data][google.cloud.discoveryengine.v1beta.Document.json_data]
// or
// [Document.struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data].
// - `custom`: One custom data per row in arbitrary format that conforms to
// the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
// data store. This can only be used by the GENERIC Data Store vertical.
DataSchema string `protobuf:"bytes,6,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
// contains filtered or unexported fields
}BigQuery source import data from.
func (*BigQuerySource) Descriptor
func (*BigQuerySource) Descriptor() ([]byte, []int)Deprecated: Use BigQuerySource.ProtoReflect.Descriptor instead.
func (*BigQuerySource) GetDataSchema
func (x *BigQuerySource) GetDataSchema() stringfunc (*BigQuerySource) GetDatasetId
func (x *BigQuerySource) GetDatasetId() stringfunc (*BigQuerySource) GetGcsStagingDir
func (x *BigQuerySource) GetGcsStagingDir() stringfunc (*BigQuerySource) GetPartition
func (x *BigQuerySource) GetPartition() isBigQuerySource_Partitionfunc (*BigQuerySource) GetPartitionDate
func (x *BigQuerySource) GetPartitionDate() *date.Datefunc (*BigQuerySource) GetProjectId
func (x *BigQuerySource) GetProjectId() stringfunc (*BigQuerySource) GetTableId
func (x *BigQuerySource) GetTableId() stringfunc (*BigQuerySource) ProtoMessage
func (*BigQuerySource) ProtoMessage()func (*BigQuerySource) ProtoReflect
func (x *BigQuerySource) ProtoReflect() protoreflect.Messagefunc (*BigQuerySource) Reset
func (x *BigQuerySource) Reset()func (*BigQuerySource) String
func (x *BigQuerySource) String() stringBigQuerySource_PartitionDate
type BigQuerySource_PartitionDate struct {
// BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
PartitionDate *date.Date `protobuf:"bytes,5,opt,name=partition_date,json=partitionDate,proto3,oneof"`
}BigtableOptions
type BigtableOptions struct {
// The field name used for saving row key value in the document. The name has
// to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
KeyFieldName string `protobuf:"bytes,1,opt,name=key_field_name,json=keyFieldName,proto3" json:"key_field_name,omitempty"`
// The mapping from family names to an object that contains column families
// level information for the given column family. If a family is not present
// in this map it will be ignored.
Families map[string]*BigtableOptions_BigtableColumnFamily `protobuf:"bytes,2,rep,name=families,proto3" json:"families,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}The Bigtable Options object that contains information to support the import.
func (*BigtableOptions) Descriptor
func (*BigtableOptions) Descriptor() ([]byte, []int)Deprecated: Use BigtableOptions.ProtoReflect.Descriptor instead.
func (*BigtableOptions) GetFamilies
func (x *BigtableOptions) GetFamilies() map[string]*BigtableOptions_BigtableColumnFamilyfunc (*BigtableOptions) GetKeyFieldName
func (x *BigtableOptions) GetKeyFieldName() stringfunc (*BigtableOptions) ProtoMessage
func (*BigtableOptions) ProtoMessage()func (*BigtableOptions) ProtoReflect
func (x *BigtableOptions) ProtoReflect() protoreflect.Messagefunc (*BigtableOptions) Reset
func (x *BigtableOptions) Reset()func (*BigtableOptions) String
func (x *BigtableOptions) String() stringBigtableOptions_BigtableColumn
type BigtableOptions_BigtableColumn struct {
// Required. Qualifier of the column. If it cannot be decoded with utf-8,
// use a base-64 encoded string instead.
Qualifier []byte `protobuf:"bytes,1,opt,name=qualifier,proto3" json:"qualifier,omitempty"`
// The field name to use for this column in the document. The name has to
// match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
// If not set, it is parsed from the qualifier bytes with best effort.
// However, due to different naming patterns, field name collisions could
// happen, where parsing behavior is undefined.
FieldName string `protobuf:"bytes,2,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// The encoding mode of the values when the type is not `STRING`.
// Acceptable encoding values are:
//
// * `TEXT`: indicates values are alphanumeric text strings.
// * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
// family of functions. This can be overridden for a specific column
// by listing that column in `columns` and specifying an encoding for it.
Encoding BigtableOptions_Encoding `protobuf:"varint,3,opt,name=encoding,proto3,enum=google.cloud.discoveryengine.v1beta.BigtableOptions_Encoding" json:"encoding,omitempty"`
// The type of values in this column family.
// The values are expected to be encoded using `HBase Bytes.toBytes`
// function when the encoding value is set to `BINARY`.
Type BigtableOptions_Type `protobuf:"varint,4,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1beta.BigtableOptions_Type" json:"type,omitempty"`
// contains filtered or unexported fields
}The column of the Bigtable.
func (*BigtableOptions_BigtableColumn) Descriptor
func (*BigtableOptions_BigtableColumn) Descriptor() ([]byte, []int)Deprecated: Use BigtableOptions_BigtableColumn.ProtoReflect.Descriptor instead.
func (*BigtableOptions_BigtableColumn) GetEncoding
func (x *BigtableOptions_BigtableColumn) GetEncoding() BigtableOptions_Encodingfunc (*BigtableOptions_BigtableColumn) GetFieldName
func (x *BigtableOptions_BigtableColumn) GetFieldName() stringfunc (*BigtableOptions_BigtableColumn) GetQualifier
func (x *BigtableOptions_BigtableColumn) GetQualifier() []bytefunc (*BigtableOptions_BigtableColumn) GetType
func (x *BigtableOptions_BigtableColumn) GetType() BigtableOptions_Typefunc (*BigtableOptions_BigtableColumn) ProtoMessage
func (*BigtableOptions_BigtableColumn) ProtoMessage()func (*BigtableOptions_BigtableColumn) ProtoReflect
func (x *BigtableOptions_BigtableColumn) ProtoReflect() protoreflect.Messagefunc (*BigtableOptions_BigtableColumn) Reset
func (x *BigtableOptions_BigtableColumn) Reset()func (*BigtableOptions_BigtableColumn) String
func (x *BigtableOptions_BigtableColumn) String() stringBigtableOptions_BigtableColumnFamily
type BigtableOptions_BigtableColumnFamily struct {
// The field name to use for this column family in the document. The
// name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set,
// it is parsed from the family name with best effort. However, due to
// different naming patterns, field name collisions could happen, where
// parsing behavior is undefined.
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// The encoding mode of the values when the type is not STRING.
// Acceptable encoding values are:
//
// * `TEXT`: indicates values are alphanumeric text strings.
// * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
// family of functions. This can be overridden for a specific column
// by listing that column in `columns` and specifying an encoding for it.
Encoding BigtableOptions_Encoding `protobuf:"varint,2,opt,name=encoding,proto3,enum=google.cloud.discoveryengine.v1beta.BigtableOptions_Encoding" json:"encoding,omitempty"`
// The type of values in this column family.
// The values are expected to be encoded using `HBase Bytes.toBytes`
// function when the encoding value is set to `BINARY`.
Type BigtableOptions_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1beta.BigtableOptions_Type" json:"type,omitempty"`
// The list of objects that contains column level information for each
// column. If a column is not present in this list it will be ignored.
Columns []*BigtableOptions_BigtableColumn `protobuf:"bytes,4,rep,name=columns,proto3" json:"columns,omitempty"`
// contains filtered or unexported fields
}The column family of the Bigtable.
func (*BigtableOptions_BigtableColumnFamily) Descriptor
func (*BigtableOptions_BigtableColumnFamily) Descriptor() ([]byte, []int)Deprecated: Use BigtableOptions_BigtableColumnFamily.ProtoReflect.Descriptor instead.
func (*BigtableOptions_BigtableColumnFamily) GetColumns
func (x *BigtableOptions_BigtableColumnFamily) GetColumns() []*BigtableOptions_BigtableColumnfunc (*BigtableOptions_BigtableColumnFamily) GetEncoding
func (x *BigtableOptions_BigtableColumnFamily) GetEncoding() BigtableOptions_Encodingfunc (*BigtableOptions_BigtableColumnFamily) GetFieldName
func (x *BigtableOptions_BigtableColumnFamily) GetFieldName() stringfunc (*BigtableOptions_BigtableColumnFamily) GetType
func (x *BigtableOptions_BigtableColumnFamily) GetType() BigtableOptions_Typefunc (*BigtableOptions_BigtableColumnFamily) ProtoMessage
func (*BigtableOptions_BigtableColumnFamily) ProtoMessage()func (*BigtableOptions_BigtableColumnFamily) ProtoReflect
func (x *BigtableOptions_BigtableColumnFamily) ProtoReflect() protoreflect.Messagefunc (*BigtableOptions_BigtableColumnFamily) Reset
func (x *BigtableOptions_BigtableColumnFamily) Reset()func (*BigtableOptions_BigtableColumnFamily) String
func (x *BigtableOptions_BigtableColumnFamily) String() stringBigtableOptions_Encoding
type BigtableOptions_Encoding int32The encoding mode of a Bigtable column or column family.
BigtableOptions_ENCODING_UNSPECIFIED, BigtableOptions_TEXT, BigtableOptions_BINARY
const (
// The encoding is unspecified.
BigtableOptions_ENCODING_UNSPECIFIED BigtableOptions_Encoding = 0
// Text encoding.
BigtableOptions_TEXT BigtableOptions_Encoding = 1
// Binary encoding.
BigtableOptions_BINARY BigtableOptions_Encoding = 2
)func (BigtableOptions_Encoding) Descriptor
func (BigtableOptions_Encoding) Descriptor() protoreflect.EnumDescriptorfunc (BigtableOptions_Encoding) Enum
func (x BigtableOptions_Encoding) Enum() *BigtableOptions_Encodingfunc (BigtableOptions_Encoding) EnumDescriptor
func (BigtableOptions_Encoding) EnumDescriptor() ([]byte, []int)Deprecated: Use BigtableOptions_Encoding.Descriptor instead.
func (BigtableOptions_Encoding) Number
func (x BigtableOptions_Encoding) Number() protoreflect.EnumNumberfunc (BigtableOptions_Encoding) String
func (x BigtableOptions_Encoding) String() stringfunc (BigtableOptions_Encoding) Type
func (BigtableOptions_Encoding) Type() protoreflect.EnumTypeBigtableOptions_Type
type BigtableOptions_Type int32The type of values in a Bigtable column or column family.
The values are expected to be encoded using
HBase
Bytes.toBytes
function when the encoding value is set to BINARY.
BigtableOptions_TYPE_UNSPECIFIED, BigtableOptions_STRING, BigtableOptions_NUMBER, BigtableOptions_INTEGER, BigtableOptions_VAR_INTEGER, BigtableOptions_BIG_NUMERIC, BigtableOptions_BOOLEAN, BigtableOptions_JSON
const (
// The type is unspecified.
BigtableOptions_TYPE_UNSPECIFIED BigtableOptions_Type = 0
// String type.
BigtableOptions_STRING BigtableOptions_Type = 1
// Numerical type.
BigtableOptions_NUMBER BigtableOptions_Type = 2
// Integer type.
BigtableOptions_INTEGER BigtableOptions_Type = 3
// Variable length integer type.
BigtableOptions_VAR_INTEGER BigtableOptions_Type = 4
// BigDecimal type.
BigtableOptions_BIG_NUMERIC BigtableOptions_Type = 5
// Boolean type.
BigtableOptions_BOOLEAN BigtableOptions_Type = 6
// JSON type.
BigtableOptions_JSON BigtableOptions_Type = 7
)func (BigtableOptions_Type) Descriptor
func (BigtableOptions_Type) Descriptor() protoreflect.EnumDescriptorfunc (BigtableOptions_Type) Enum
func (x BigtableOptions_Type) Enum() *BigtableOptions_Typefunc (BigtableOptions_Type) EnumDescriptor
func (BigtableOptions_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use BigtableOptions_Type.Descriptor instead.
func (BigtableOptions_Type) Number
func (x BigtableOptions_Type) Number() protoreflect.EnumNumberfunc (BigtableOptions_Type) String
func (x BigtableOptions_Type) String() stringfunc (BigtableOptions_Type) Type
func (BigtableOptions_Type) Type() protoreflect.EnumTypeBigtableSource
type BigtableSource struct {
// The project ID that contains the Bigtable source. Has a length limit of 128
// characters. If not specified, inherits the project ID from the parent
// request.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Required. The instance ID of the Cloud Bigtable that needs to be imported.
InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Required. The table ID of the Cloud Bigtable that needs to be imported.
TableId string `protobuf:"bytes,3,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Required. Bigtable options that contains information needed when parsing
// data into typed structures. For example, column type annotations.
BigtableOptions *BigtableOptions `protobuf:"bytes,4,opt,name=bigtable_options,json=bigtableOptions,proto3" json:"bigtable_options,omitempty"`
// contains filtered or unexported fields
}The Cloud Bigtable source for importing data.
func (*BigtableSource) Descriptor
func (*BigtableSource) Descriptor() ([]byte, []int)Deprecated: Use BigtableSource.ProtoReflect.Descriptor instead.
func (*BigtableSource) GetBigtableOptions
func (x *BigtableSource) GetBigtableOptions() *BigtableOptionsfunc (*BigtableSource) GetInstanceId
func (x *BigtableSource) GetInstanceId() stringfunc (*BigtableSource) GetProjectId
func (x *BigtableSource) GetProjectId() stringfunc (*BigtableSource) GetTableId
func (x *BigtableSource) GetTableId() stringfunc (*BigtableSource) ProtoMessage
func (*BigtableSource) ProtoMessage()func (*BigtableSource) ProtoReflect
func (x *BigtableSource) ProtoReflect() protoreflect.Messagefunc (*BigtableSource) Reset
func (x *BigtableSource) Reset()func (*BigtableSource) String
func (x *BigtableSource) String() stringCheckGroundingRequest
type CheckGroundingRequest struct {
// Required. The resource name of the grounding config, such as
// `projects/*/locations/global/groundingConfigs/default_grounding_config`.
GroundingConfig string `protobuf:"bytes,1,opt,name=grounding_config,json=groundingConfig,proto3" json:"grounding_config,omitempty"`
// Answer candidate to check. It can have a maximum length of 4096 tokens.
AnswerCandidate string `protobuf:"bytes,2,opt,name=answer_candidate,json=answerCandidate,proto3" json:"answer_candidate,omitempty"`
// List of facts for the grounding check.
// We support up to 200 facts.
Facts []*GroundingFact `protobuf:"bytes,3,rep,name=facts,proto3" json:"facts,omitempty"`
// Configuration of the grounding check.
GroundingSpec *CheckGroundingSpec `protobuf:"bytes,4,opt,name=grounding_spec,json=groundingSpec,proto3" json:"grounding_spec,omitempty"`
// The user labels applied to a resource must meet the following requirements:
//
// - Each resource can have multiple labels, up to a maximum of 64.
// - Each label must be a key-value pair.
// - Keys have a minimum length of 1 character and a maximum length of 63
// characters and cannot be empty. Values can be empty and have a maximum
// length of 63 characters.
// - Keys and values can contain only lowercase letters, numeric characters,
// underscores, and dashes. All characters must use UTF-8 encoding, and
// international characters are allowed.
// - The key portion of a label must be unique. However, you can use the same
// key with multiple resources.
// - Keys must start with a lowercase letter or international character.
//
// See [Google Cloud
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
// for more details.
UserLabels map[string]string `protobuf:"bytes,5,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Request message for [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] method.
func (*CheckGroundingRequest) Descriptor
func (*CheckGroundingRequest) Descriptor() ([]byte, []int)Deprecated: Use CheckGroundingRequest.ProtoReflect.Descriptor instead.
func (*CheckGroundingRequest) GetAnswerCandidate
func (x *CheckGroundingRequest) GetAnswerCandidate() stringfunc (*CheckGroundingRequest) GetFacts
func (x *CheckGroundingRequest) GetFacts() []*GroundingFactfunc (*CheckGroundingRequest) GetGroundingConfig
func (x *CheckGroundingRequest) GetGroundingConfig() stringfunc (*CheckGroundingRequest) GetGroundingSpec
func (x *CheckGroundingRequest) GetGroundingSpec() *CheckGroundingSpecfunc (*CheckGroundingRequest) GetUserLabels
func (x *CheckGroundingRequest) GetUserLabels() map[string]stringfunc (*CheckGroundingRequest) ProtoMessage
func (*CheckGroundingRequest) ProtoMessage()func (*CheckGroundingRequest) ProtoReflect
func (x *CheckGroundingRequest) ProtoReflect() protoreflect.Messagefunc (*CheckGroundingRequest) Reset
func (x *CheckGroundingRequest) Reset()func (*CheckGroundingRequest) String
func (x *CheckGroundingRequest) String() stringCheckGroundingResponse
type CheckGroundingResponse struct {
// The support score for the input answer candidate.
// Higher the score, higher is the fraction of claims that are supported by
// the provided facts. This is always set when a response is returned.
SupportScore *float32 `protobuf:"fixed32,1,opt,name=support_score,json=supportScore,proto3,oneof" json:"support_score,omitempty"`
// List of facts cited across all claims in the answer candidate.
// These are derived from the facts supplied in the request.
CitedChunks []*FactChunk `protobuf:"bytes,3,rep,name=cited_chunks,json=citedChunks,proto3" json:"cited_chunks,omitempty"`
// List of facts cited across all claims in the answer candidate.
// These are derived from the facts supplied in the request.
CitedFacts []*CheckGroundingResponse_CheckGroundingFactChunk `protobuf:"bytes,6,rep,name=cited_facts,json=citedFacts,proto3" json:"cited_facts,omitempty"`
// Claim texts and citation info across all claims in the answer candidate.
Claims []*CheckGroundingResponse_Claim `protobuf:"bytes,4,rep,name=claims,proto3" json:"claims,omitempty"`
// contains filtered or unexported fields
}Response message for the [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] method.
func (*CheckGroundingResponse) Descriptor
func (*CheckGroundingResponse) Descriptor() ([]byte, []int)Deprecated: Use CheckGroundingResponse.ProtoReflect.Descriptor instead.
func (*CheckGroundingResponse) GetCitedChunks
func (x *CheckGroundingResponse) GetCitedChunks() []*FactChunkfunc (*CheckGroundingResponse) GetCitedFacts
func (x *CheckGroundingResponse) GetCitedFacts() []*CheckGroundingResponse_CheckGroundingFactChunkfunc (*CheckGroundingResponse) GetClaims
func (x *CheckGroundingResponse) GetClaims() []*CheckGroundingResponse_Claimfunc (*CheckGroundingResponse) GetSupportScore
func (x *CheckGroundingResponse) GetSupportScore() float32func (*CheckGroundingResponse) ProtoMessage
func (*CheckGroundingResponse) ProtoMessage()func (*CheckGroundingResponse) ProtoReflect
func (x *CheckGroundingResponse) ProtoReflect() protoreflect.Messagefunc (*CheckGroundingResponse) Reset
func (x *CheckGroundingResponse) Reset()func (*CheckGroundingResponse) String
func (x *CheckGroundingResponse) String() stringCheckGroundingResponse_CheckGroundingFactChunk
type CheckGroundingResponse_CheckGroundingFactChunk struct {
// Text content of the fact chunk. Can be at most 10K characters long.
ChunkText string `protobuf:"bytes,1,opt,name=chunk_text,json=chunkText,proto3" json:"chunk_text,omitempty"`
// contains filtered or unexported fields
}Fact chunk for grounding check.
func (*CheckGroundingResponse_CheckGroundingFactChunk) Descriptor
func (*CheckGroundingResponse_CheckGroundingFactChunk) Descriptor() ([]byte, []int)Deprecated: Use CheckGroundingResponse_CheckGroundingFactChunk.ProtoReflect.Descriptor instead.
func (*CheckGroundingResponse_CheckGroundingFactChunk) GetChunkText
func (x *CheckGroundingResponse_CheckGroundingFactChunk) GetChunkText() stringfunc (*CheckGroundingResponse_CheckGroundingFactChunk) ProtoMessage
func (*CheckGroundingResponse_CheckGroundingFactChunk) ProtoMessage()func (*CheckGroundingResponse_CheckGroundingFactChunk) ProtoReflect
func (x *CheckGroundingResponse_CheckGroundingFactChunk) ProtoReflect() protoreflect.Messagefunc (*CheckGroundingResponse_CheckGroundingFactChunk) Reset
func (x *CheckGroundingResponse_CheckGroundingFactChunk) Reset()func (*CheckGroundingResponse_CheckGroundingFactChunk) String
func (x *CheckGroundingResponse_CheckGroundingFactChunk) String() stringCheckGroundingResponse_Claim
type CheckGroundingResponse_Claim struct {
// Position indicating the start of the claim in the answer candidate,
// measured in bytes. Note that this is not measured in characters and,
// therefore, must be rendered in the user interface keeping in mind that
// some characters may take more than one byte. For example,
// if the claim text contains non-ASCII characters, the start and end
// positions vary when measured in characters
// (programming-language-dependent) and when measured in bytes
// (programming-language-independent).
StartPos *int32 `protobuf:"varint,1,opt,name=start_pos,json=startPos,proto3,oneof" json:"start_pos,omitempty"`
// Position indicating the end of the claim in the answer candidate,
// exclusive, in bytes. Note that this is not measured in characters and,
// therefore, must be rendered as such. For example, if the claim text
// contains non-ASCII characters, the start and end positions vary when
// measured in characters (programming-language-dependent) and when measured
// in bytes (programming-language-independent).
EndPos *int32 `protobuf:"varint,2,opt,name=end_pos,json=endPos,proto3,oneof" json:"end_pos,omitempty"`
// Text for the claim in the answer candidate. Always provided regardless of
// whether citations or anti-citations are found.
ClaimText string `protobuf:"bytes,3,opt,name=claim_text,json=claimText,proto3" json:"claim_text,omitempty"`
// A list of indices (into 'cited_chunks') specifying the citations
// associated with the claim. For instance [1,3,4] means that
// cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
// supporting for the claim. A citation to a fact indicates that the claim
// is supported by the fact.
CitationIndices []int32 `protobuf:"varint,4,rep,packed,name=citation_indices,json=citationIndices,proto3" json:"citation_indices,omitempty"`
// Indicates that this claim required grounding check. When the system
// decided this claim doesn't require attribution/grounding check, this
// field will be set to false. In that case, no grounding check was done for
// the claim and therefore
// [citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.citation_indices]
// should not be returned.
GroundingCheckRequired *bool `protobuf:"varint,6,opt,name=grounding_check_required,json=groundingCheckRequired,proto3,oneof" json:"grounding_check_required,omitempty"`
// Confidence score for the claim in the answer candidate, in the range of
// [0, 1]. This is set only when
// `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.
Score *float64 `protobuf:"fixed64,7,opt,name=score,proto3,oneof" json:"score,omitempty"`
// contains filtered or unexported fields
}Text and citation info for a claim in the answer candidate.
func (*CheckGroundingResponse_Claim) Descriptor
func (*CheckGroundingResponse_Claim) Descriptor() ([]byte, []int)Deprecated: Use CheckGroundingResponse_Claim.ProtoReflect.Descriptor instead.
func (*CheckGroundingResponse_Claim) GetCitationIndices
func (x *CheckGroundingResponse_Claim) GetCitationIndices() []int32func (*CheckGroundingResponse_Claim) GetClaimText
func (x *CheckGroundingResponse_Claim) GetClaimText() stringfunc (*CheckGroundingResponse_Claim) GetEndPos
func (x *CheckGroundingResponse_Claim) GetEndPos() int32func (*CheckGroundingResponse_Claim) GetGroundingCheckRequired
func (x *CheckGroundingResponse_Claim) GetGroundingCheckRequired() boolfunc (*CheckGroundingResponse_Claim) GetScore
func (x *CheckGroundingResponse_Claim) GetScore() float64func (*CheckGroundingResponse_Claim) GetStartPos
func (x *CheckGroundingResponse_Claim) GetStartPos() int32func (*CheckGroundingResponse_Claim) ProtoMessage
func (*CheckGroundingResponse_Claim) ProtoMessage()func (*CheckGroundingResponse_Claim) ProtoReflect
func (x *CheckGroundingResponse_Claim) ProtoReflect() protoreflect.Messagefunc (*CheckGroundingResponse_Claim) Reset
func (x *CheckGroundingResponse_Claim) Reset()func (*CheckGroundingResponse_Claim) String
func (x *CheckGroundingResponse_Claim) String() stringCheckGroundingSpec
type CheckGroundingSpec struct {
// The threshold (in [0,1]) used for determining whether a fact must be
// cited for a claim in the answer candidate. Choosing a higher threshold
// will lead to fewer but very strong citations, while choosing a lower
// threshold may lead to more but somewhat weaker citations. If unset, the
// threshold will default to 0.6.
CitationThreshold *float64 `protobuf:"fixed64,1,opt,name=citation_threshold,json=citationThreshold,proto3,oneof" json:"citation_threshold,omitempty"`
// The control flag that enables claim-level grounding score in the response.
EnableClaimLevelScore *bool `protobuf:"varint,4,opt,name=enable_claim_level_score,json=enableClaimLevelScore,proto3,oneof" json:"enable_claim_level_score,omitempty"`
// contains filtered or unexported fields
}Specification for the grounding check.
func (*CheckGroundingSpec) Descriptor
func (*CheckGroundingSpec) Descriptor() ([]byte, []int)Deprecated: Use CheckGroundingSpec.ProtoReflect.Descriptor instead.
func (*CheckGroundingSpec) GetCitationThreshold
func (x *CheckGroundingSpec) GetCitationThreshold() float64func (*CheckGroundingSpec) GetEnableClaimLevelScore
func (x *CheckGroundingSpec) GetEnableClaimLevelScore() boolfunc (*CheckGroundingSpec) ProtoMessage
func (*CheckGroundingSpec) ProtoMessage()func (*CheckGroundingSpec) ProtoReflect
func (x *CheckGroundingSpec) ProtoReflect() protoreflect.Messagefunc (*CheckGroundingSpec) Reset
func (x *CheckGroundingSpec) Reset()func (*CheckGroundingSpec) String
func (x *CheckGroundingSpec) String() stringChunk
type Chunk struct {
// The full resource name of the chunk.
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Unique chunk ID of the current chunk.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// Content is a string from a document (parsed content).
Content string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
// Output only. Represents the relevance score based on similarity.
// Higher score indicates higher chunk relevance.
// The score is in range [-1.0, 1.0].
// Only populated on
// [SearchResponse][google.cloud.discoveryengine.v1beta.SearchResponse].
RelevanceScore *float64 `protobuf:"fixed64,8,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
// Metadata of the document from the current chunk.
DocumentMetadata *Chunk_DocumentMetadata `protobuf:"bytes,5,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
// Output only. This field is OUTPUT_ONLY.
// It contains derived data that are not in the original input document.
DerivedStructData *structpb.Struct `protobuf:"bytes,4,opt,name=derived_struct_data,json=derivedStructData,proto3" json:"derived_struct_data,omitempty"`
// Page span of the chunk.
PageSpan *Chunk_PageSpan `protobuf:"bytes,6,opt,name=page_span,json=pageSpan,proto3" json:"page_span,omitempty"`
// Output only. Metadata of the current chunk.
ChunkMetadata *Chunk_ChunkMetadata `protobuf:"bytes,7,opt,name=chunk_metadata,json=chunkMetadata,proto3" json:"chunk_metadata,omitempty"`
// Output only. Image Data URLs if the current chunk contains images.
// Data URLs are composed of four parts: a prefix (data:), a MIME type
// indicating the type of data, an optional base64 token if non-textual,
// and the data itself:
// data:[Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.
func (*Chunk) Descriptor
Deprecated: Use Chunk.ProtoReflect.Descriptor instead.
func (*Chunk) GetAnnotationContents
func (*Chunk) GetAnnotationMetadata
func (x *Chunk) GetAnnotationMetadata() []*Chunk_AnnotationMetadatafunc (*Chunk) GetChunkMetadata
func (x *Chunk) GetChunkMetadata() *Chunk_ChunkMetadatafunc (*Chunk) GetContent
func (*Chunk) GetDataUrls
func (*Chunk) GetDerivedStructData
func (*Chunk) GetDocumentMetadata
func (x *Chunk) GetDocumentMetadata() *Chunk_DocumentMetadatafunc (*Chunk) GetId
func (*Chunk) GetName
func (*Chunk) GetPageSpan
func (x *Chunk) GetPageSpan() *Chunk_PageSpanfunc (*Chunk) GetRelevanceScore
func (*Chunk) ProtoMessage
func (*Chunk) ProtoMessage()func (*Chunk) ProtoReflect
func (x *Chunk) ProtoReflect() protoreflect.Messagefunc (*Chunk) Reset
func (x *Chunk) Reset()func (*Chunk) String
Chunk_AnnotationMetadata
type Chunk_AnnotationMetadata struct {
// Output only. The structured content information.
StructuredContent *Chunk_StructuredContent `protobuf:"bytes,1,opt,name=structured_content,json=structuredContent,proto3" json:"structured_content,omitempty"`
// Output only. Image id is provided if the structured content is based on
// an image.
ImageId string `protobuf:"bytes,2,opt,name=image_id,json=imageId,proto3" json:"image_id,omitempty"`
// contains filtered or unexported fields
}The annotation metadata includes structured content in the current chunk.
func (*Chunk_AnnotationMetadata) Descriptor
func (*Chunk_AnnotationMetadata) Descriptor() ([]byte, []int)Deprecated: Use Chunk_AnnotationMetadata.ProtoReflect.Descriptor instead.
func (*Chunk_AnnotationMetadata) GetImageId
func (x *Chunk_AnnotationMetadata) GetImageId() stringfunc (*Chunk_AnnotationMetadata) GetStructuredContent
func (x *Chunk_AnnotationMetadata) GetStructuredContent() *Chunk_StructuredContentfunc (*Chunk_AnnotationMetadata) ProtoMessage
func (*Chunk_AnnotationMetadata) ProtoMessage()func (*Chunk_AnnotationMetadata) ProtoReflect
func (x *Chunk_AnnotationMetadata) ProtoReflect() protoreflect.Messagefunc (*Chunk_AnnotationMetadata) Reset
func (x *Chunk_AnnotationMetadata) Reset()func (*Chunk_AnnotationMetadata) String
func (x *Chunk_AnnotationMetadata) String() stringChunk_ChunkMetadata
type Chunk_ChunkMetadata struct {
// The previous chunks of the current chunk. The number is controlled by
// [SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks].
// This field is only populated on
// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
// API.
PreviousChunks []*Chunk `protobuf:"bytes,1,rep,name=previous_chunks,json=previousChunks,proto3" json:"previous_chunks,omitempty"`
// The next chunks of the current chunk. The number is controlled by
// [SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks].
// This field is only populated on
// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
// API.
NextChunks []*Chunk `protobuf:"bytes,2,rep,name=next_chunks,json=nextChunks,proto3" json:"next_chunks,omitempty"`
// contains filtered or unexported fields
}Metadata of the current chunk. This field is only populated on [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] API.
func (*Chunk_ChunkMetadata) Descriptor
func (*Chunk_ChunkMetadata) Descriptor() ([]byte, []int)Deprecated: Use Chunk_ChunkMetadata.ProtoReflect.Descriptor instead.
func (*Chunk_ChunkMetadata) GetNextChunks
func (x *Chunk_ChunkMetadata) GetNextChunks() []*Chunkfunc (*Chunk_ChunkMetadata) GetPreviousChunks
func (x *Chunk_ChunkMetadata) GetPreviousChunks() []*Chunkfunc (*Chunk_ChunkMetadata) ProtoMessage
func (*Chunk_ChunkMetadata) ProtoMessage()func (*Chunk_ChunkMetadata) ProtoReflect
func (x *Chunk_ChunkMetadata) ProtoReflect() protoreflect.Messagefunc (*Chunk_ChunkMetadata) Reset
func (x *Chunk_ChunkMetadata) Reset()func (*Chunk_ChunkMetadata) String
func (x *Chunk_ChunkMetadata) String() stringChunk_DocumentMetadata
type Chunk_DocumentMetadata struct {
// Uri of the document.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// Title of the document.
Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
// The mime type of the document.
// https://www.iana.org/assignments/media-types/media-types.xhtml.
MimeType string `protobuf:"bytes,4,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// Data representation.
// The structured JSON data for the document. It should conform to the
// registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
// `INVALID_ARGUMENT` error is thrown.
StructData *structpb.Struct `protobuf:"bytes,3,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
// contains filtered or unexported fields
}Document metadata contains the information of the document of the current chunk.
func (*Chunk_DocumentMetadata) Descriptor
func (*Chunk_DocumentMetadata) Descriptor() ([]byte, []int)Deprecated: Use Chunk_DocumentMetadata.ProtoReflect.Descriptor instead.
func (*Chunk_DocumentMetadata) GetMimeType
func (x *Chunk_DocumentMetadata) GetMimeType() stringfunc (*Chunk_DocumentMetadata) GetStructData
func (x *Chunk_DocumentMetadata) GetStructData() *structpb.Structfunc (*Chunk_DocumentMetadata) GetTitle
func (x *Chunk_DocumentMetadata) GetTitle() stringfunc (*Chunk_DocumentMetadata) GetUri
func (x *Chunk_DocumentMetadata) GetUri() stringfunc (*Chunk_DocumentMetadata) ProtoMessage
func (*Chunk_DocumentMetadata) ProtoMessage()func (*Chunk_DocumentMetadata) ProtoReflect
func (x *Chunk_DocumentMetadata) ProtoReflect() protoreflect.Messagefunc (*Chunk_DocumentMetadata) Reset
func (x *Chunk_DocumentMetadata) Reset()func (*Chunk_DocumentMetadata) String
func (x *Chunk_DocumentMetadata) String() stringChunk_PageSpan
type Chunk_PageSpan struct {
// The start page of the chunk.
PageStart int32 `protobuf:"varint,1,opt,name=page_start,json=pageStart,proto3" json:"page_start,omitempty"`
// The end page of the chunk.
PageEnd int32 `protobuf:"varint,2,opt,name=page_end,json=pageEnd,proto3" json:"page_end,omitempty"`
// contains filtered or unexported fields
}Page span of the chunk.
func (*Chunk_PageSpan) Descriptor
func (*Chunk_PageSpan) Descriptor() ([]byte, []int)Deprecated: Use Chunk_PageSpan.ProtoReflect.Descriptor instead.
func (*Chunk_PageSpan) GetPageEnd
func (x *Chunk_PageSpan) GetPageEnd() int32func (*Chunk_PageSpan) GetPageStart
func (x *Chunk_PageSpan) GetPageStart() int32func (*Chunk_PageSpan) ProtoMessage
func (*Chunk_PageSpan) ProtoMessage()func (*Chunk_PageSpan) ProtoReflect
func (x *Chunk_PageSpan) ProtoReflect() protoreflect.Messagefunc (*Chunk_PageSpan) Reset
func (x *Chunk_PageSpan) Reset()func (*Chunk_PageSpan) String
func (x *Chunk_PageSpan) String() stringChunk_StructureType
type Chunk_StructureType int32Defines the types of the structured content that can be extracted.
Chunk_STRUCTURE_TYPE_UNSPECIFIED, Chunk_SHAREHOLDER_STRUCTURE, Chunk_SIGNATURE_STRUCTURE, Chunk_CHECKBOX_STRUCTURE
const (
// Default value.
Chunk_STRUCTURE_TYPE_UNSPECIFIED Chunk_StructureType = 0
// Shareholder structure.
Chunk_SHAREHOLDER_STRUCTURE Chunk_StructureType = 1
// Signature structure.
Chunk_SIGNATURE_STRUCTURE Chunk_StructureType = 2
// Checkbox structure.
Chunk_CHECKBOX_STRUCTURE Chunk_StructureType = 3
)func (Chunk_StructureType) Descriptor
func (Chunk_StructureType) Descriptor() protoreflect.EnumDescriptorfunc (Chunk_StructureType) Enum
func (x Chunk_StructureType) Enum() *Chunk_StructureTypefunc (Chunk_StructureType) EnumDescriptor
func (Chunk_StructureType) EnumDescriptor() ([]byte, []int)Deprecated: Use Chunk_StructureType.Descriptor instead.
func (Chunk_StructureType) Number
func (x Chunk_StructureType) Number() protoreflect.EnumNumberfunc (Chunk_StructureType) String
func (x Chunk_StructureType) String() stringfunc (Chunk_StructureType) Type
func (Chunk_StructureType) Type() protoreflect.EnumTypeChunk_StructuredContent
type Chunk_StructuredContent struct {
// Output only. The structure type of the structured content.
StructureType Chunk_StructureType `protobuf:"varint,1,opt,name=structure_type,json=structureType,proto3,enum=google.cloud.discoveryengine.v1beta.Chunk_StructureType" json:"structure_type,omitempty"`
// Output only. The content of the structured content.
Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
// contains filtered or unexported fields
}The structured content information.
func (*Chunk_StructuredContent) Descriptor
func (*Chunk_StructuredContent) Descriptor() ([]byte, []int)Deprecated: Use Chunk_StructuredContent.ProtoReflect.Descriptor instead.
func (*Chunk_StructuredContent) GetContent
func (x *Chunk_StructuredContent) GetContent() stringfunc (*Chunk_StructuredContent) GetStructureType
func (x *Chunk_StructuredContent) GetStructureType() Chunk_StructureTypefunc (*Chunk_StructuredContent) ProtoMessage
func (*Chunk_StructuredContent) ProtoMessage()func (*Chunk_StructuredContent) ProtoReflect
func (x *Chunk_StructuredContent) ProtoReflect() protoreflect.Messagefunc (*Chunk_StructuredContent) Reset
func (x *Chunk_StructuredContent) Reset()func (*Chunk_StructuredContent) String
func (x *Chunk_StructuredContent) String() stringCitation
type Citation struct {
// Output only. Start index into the content.
StartIndex int32 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
// Output only. End index into the content.
EndIndex int32 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
// Output only. Url reference of the attribution.
Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
// Output only. Title of the attribution.
Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`
// Output only. License of the attribution.
License string `protobuf:"bytes,5,opt,name=license,proto3" json:"license,omitempty"`
// Output only. Publication date of the attribution.
PublicationDate *date.Date `protobuf:"bytes,6,opt,name=publication_date,json=publicationDate,proto3" json:"publication_date,omitempty"`
// contains filtered or unexported fields
}Source attributions for content.
func (*Citation) Descriptor
Deprecated: Use Citation.ProtoReflect.Descriptor instead.
func (*Citation) GetEndIndex
func (*Citation) GetLicense
func (*Citation) GetPublicationDate
func (*Citation) GetStartIndex
func (*Citation) GetTitle
func (*Citation) GetUri
func (*Citation) ProtoMessage
func (*Citation) ProtoMessage()func (*Citation) ProtoReflect
func (x *Citation) ProtoReflect() protoreflect.Messagefunc (*Citation) Reset
func (x *Citation) Reset()func (*Citation) String
CitationMetadata
type CitationMetadata struct {
// Output only. List of citations.
Citations []*Citation `protobuf:"bytes,1,rep,name=citations,proto3" json:"citations,omitempty"`
// contains filtered or unexported fields
}A collection of source attributions for a piece of content.
func (*CitationMetadata) Descriptor
func (*CitationMetadata) Descriptor() ([]byte, []int)Deprecated: Use CitationMetadata.ProtoReflect.Descriptor instead.
func (*CitationMetadata) GetCitations
func (x *CitationMetadata) GetCitations() []*Citationfunc (*CitationMetadata) ProtoMessage
func (*CitationMetadata) ProtoMessage()func (*CitationMetadata) ProtoReflect
func (x *CitationMetadata) ProtoReflect() protoreflect.Messagefunc (*CitationMetadata) Reset
func (x *CitationMetadata) Reset()func (*CitationMetadata) String
func (x *CitationMetadata) String() stringCitation_PhishBlockThreshold
type Citation_PhishBlockThreshold int32These are available confidence level user can set to block malicious urls with chosen confidence and above. For understanding different confidence of webrisk, please refer to https://cloud.google.com/web-risk/docs/reference/rpc/google.cloud.webrisk.v1eap1#confidencelevel
Citation_PHISH_BLOCK_THRESHOLD_UNSPECIFIED, Citation_BLOCK_LOW_AND_ABOVE, Citation_BLOCK_MEDIUM_AND_ABOVE, Citation_BLOCK_HIGH_AND_ABOVE, Citation_BLOCK_HIGHER_AND_ABOVE, Citation_BLOCK_VERY_HIGH_AND_ABOVE, Citation_BLOCK_ONLY_EXTREMELY_HIGH
const (
// Defaults to unspecified.
Citation_PHISH_BLOCK_THRESHOLD_UNSPECIFIED Citation_PhishBlockThreshold = 0
// Blocks Low and above confidence URL that is risky.
Citation_BLOCK_LOW_AND_ABOVE Citation_PhishBlockThreshold = 30
// Blocks Medium and above confidence URL that is risky.
Citation_BLOCK_MEDIUM_AND_ABOVE Citation_PhishBlockThreshold = 40
// Blocks High and above confidence URL that is risky.
Citation_BLOCK_HIGH_AND_ABOVE Citation_PhishBlockThreshold = 50
// Blocks Higher and above confidence URL that is risky.
Citation_BLOCK_HIGHER_AND_ABOVE Citation_PhishBlockThreshold = 55
// Blocks Very high and above confidence URL that is risky.
Citation_BLOCK_VERY_HIGH_AND_ABOVE Citation_PhishBlockThreshold = 60
// Blocks Extremely high confidence URL that is risky.
Citation_BLOCK_ONLY_EXTREMELY_HIGH Citation_PhishBlockThreshold = 100
)func (Citation_PhishBlockThreshold) Descriptor
func (Citation_PhishBlockThreshold) Descriptor() protoreflect.EnumDescriptorfunc (Citation_PhishBlockThreshold) Enum
func (x Citation_PhishBlockThreshold) Enum() *Citation_PhishBlockThresholdfunc (Citation_PhishBlockThreshold) EnumDescriptor
func (Citation_PhishBlockThreshold) EnumDescriptor() ([]byte, []int)Deprecated: Use Citation_PhishBlockThreshold.Descriptor instead.
func (Citation_PhishBlockThreshold) Number
func (x Citation_PhishBlockThreshold) Number() protoreflect.EnumNumberfunc (Citation_PhishBlockThreshold) String
func (x Citation_PhishBlockThreshold) String() stringfunc (Citation_PhishBlockThreshold) Type
func (Citation_PhishBlockThreshold) Type() protoreflect.EnumTypeCloudSqlSource
type CloudSqlSource struct {
// The project ID that contains the Cloud SQL source. Has a length limit of
// 128 characters. If not specified, inherits the project ID from the parent
// request.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Required. The Cloud SQL instance to copy the data from with a length limit
// of 256 characters.
InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Required. The Cloud SQL database to copy the data from with a length limit
// of 256 characters.
DatabaseId string `protobuf:"bytes,3,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// Required. The Cloud SQL table to copy the data from with a length limit of
// 256 characters.
TableId string `protobuf:"bytes,4,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Intermediate Cloud Storage directory used for the import with a length
// limit of 2,000 characters. Can be specified if one wants to have the
// Cloud SQL export to a specific Cloud Storage directory.
//
// Ensure that the Cloud SQL service account has the necessary Cloud
// Storage Admin permissions to access the specified Cloud Storage directory.
GcsStagingDir string `protobuf:"bytes,5,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
// Option for serverless export. Enabling this option will incur additional
// cost. More info can be found
// [here](https://cloud.google.com/sql/pricing#serverless).
Offload bool `protobuf:"varint,6,opt,name=offload,proto3" json:"offload,omitempty"`
// contains filtered or unexported fields
}Cloud SQL source import data from.
func (*CloudSqlSource) Descriptor
func (*CloudSqlSource) Descriptor() ([]byte, []int)Deprecated: Use CloudSqlSource.ProtoReflect.Descriptor instead.
func (*CloudSqlSource) GetDatabaseId
func (x *CloudSqlSource) GetDatabaseId() stringfunc (*CloudSqlSource) GetGcsStagingDir
func (x *CloudSqlSource) GetGcsStagingDir() stringfunc (*CloudSqlSource) GetInstanceId
func (x *CloudSqlSource) GetInstanceId() stringfunc (*CloudSqlSource) GetOffload
func (x *CloudSqlSource) GetOffload() boolfunc (*CloudSqlSource) GetProjectId
func (x *CloudSqlSource) GetProjectId() stringfunc (*CloudSqlSource) GetTableId
func (x *CloudSqlSource) GetTableId() stringfunc (*CloudSqlSource) ProtoMessage
func (*CloudSqlSource) ProtoMessage()func (*CloudSqlSource) ProtoReflect
func (x *CloudSqlSource) ProtoReflect() protoreflect.Messagefunc (*CloudSqlSource) Reset
func (x *CloudSqlSource) Reset()func (*CloudSqlSource) String
func (x *CloudSqlSource) String() stringCmekConfig
type CmekConfig struct {
// Required. The name of the CmekConfig of the form
// `projects/{project}/locations/{location}/cmekConfig` or
// `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. KMS key resource name which will be used to encrypt resources
// `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
KmsKey string `protobuf:"bytes,2,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
// Output only. KMS key version resource name which will be used to encrypt
// resources
// `Configurations used to enable CMEK data encryption with Cloud KMS keys.
func (*CmekConfig) Descriptor
func (*CmekConfig) Descriptor() ([]byte, []int)Deprecated: Use CmekConfig.ProtoReflect.Descriptor instead.
func (*CmekConfig) GetIsDefault
func (x *CmekConfig) GetIsDefault() boolfunc (*CmekConfig) GetKmsKey
func (x *CmekConfig) GetKmsKey() stringfunc (*CmekConfig) GetKmsKeyVersion
func (x *CmekConfig) GetKmsKeyVersion() stringfunc (*CmekConfig) GetLastRotationTimestampMicros
func (x *CmekConfig) GetLastRotationTimestampMicros() int64func (*CmekConfig) GetName
func (x *CmekConfig) GetName() stringfunc (*CmekConfig) GetNotebooklmState
func (x *CmekConfig) GetNotebooklmState() CmekConfig_NotebookLMStatefunc (*CmekConfig) GetSingleRegionKeys
func (x *CmekConfig) GetSingleRegionKeys() []*SingleRegionKeyfunc (*CmekConfig) GetState
func (x *CmekConfig) GetState() CmekConfig_Statefunc (*CmekConfig) ProtoMessage
func (*CmekConfig) ProtoMessage()func (*CmekConfig) ProtoReflect
func (x *CmekConfig) ProtoReflect() protoreflect.Messagefunc (*CmekConfig) Reset
func (x *CmekConfig) Reset()func (*CmekConfig) String
func (x *CmekConfig) String() stringCmekConfigServiceClient
type CmekConfigServiceClient interface {
// Provisions a CMEK key for use in a location of a customer's project.
// This method will also conduct location validation on the provided
// cmekConfig to make sure the key is valid and can be used in the
// selected location.
UpdateCmekConfig(ctx context.Context, in *UpdateCmekConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets the [CmekConfig][google.cloud.discoveryengine.v1beta.CmekConfig].
GetCmekConfig(ctx context.Context, in *GetCmekConfigRequest, opts ...grpc.CallOption) (*CmekConfig, error)
// Lists all the [CmekConfig][google.cloud.discoveryengine.v1beta.CmekConfig]s
// with the project.
ListCmekConfigs(ctx context.Context, in *ListCmekConfigsRequest, opts ...grpc.CallOption) (*ListCmekConfigsResponse, error)
// De-provisions a CmekConfig.
DeleteCmekConfig(ctx context.Context, in *DeleteCmekConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}CmekConfigServiceClient is the client API for CmekConfigService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewCmekConfigServiceClient
func NewCmekConfigServiceClient(cc grpc.ClientConnInterface) CmekConfigServiceClientCmekConfigServiceServer
type CmekConfigServiceServer interface {
// Provisions a CMEK key for use in a location of a customer's project.
// This method will also conduct location validation on the provided
// cmekConfig to make sure the key is valid and can be used in the
// selected location.
UpdateCmekConfig(context.Context, *UpdateCmekConfigRequest) (*longrunningpb.Operation, error)
// Gets the [CmekConfig][google.cloud.discoveryengine.v1beta.CmekConfig].
GetCmekConfig(context.Context, *GetCmekConfigRequest) (*CmekConfig, error)
// Lists all the [CmekConfig][google.cloud.discoveryengine.v1beta.CmekConfig]s
// with the project.
ListCmekConfigs(context.Context, *ListCmekConfigsRequest) (*ListCmekConfigsResponse, error)
// De-provisions a CmekConfig.
DeleteCmekConfig(context.Context, *DeleteCmekConfigRequest) (*longrunningpb.Operation, error)
}CmekConfigServiceServer is the server API for CmekConfigService service. All implementations should embed UnimplementedCmekConfigServiceServer for forward compatibility
CmekConfig_NotebookLMState
type CmekConfig_NotebookLMState int32States of NotebookLM.
CmekConfig_NOTEBOOK_LM_STATE_UNSPECIFIED, CmekConfig_NOTEBOOK_LM_NOT_READY, CmekConfig_NOTEBOOK_LM_READY, CmekConfig_NOTEBOOK_LM_NOT_ENABLED
const (
// The NotebookLM state is unknown.
CmekConfig_NOTEBOOK_LM_STATE_UNSPECIFIED CmekConfig_NotebookLMState = 0
// The NotebookLM is not ready.
CmekConfig_NOTEBOOK_LM_NOT_READY CmekConfig_NotebookLMState = 1
// The NotebookLM is ready to be used.
CmekConfig_NOTEBOOK_LM_READY CmekConfig_NotebookLMState = 2
// The NotebookLM is not enabled.
CmekConfig_NOTEBOOK_LM_NOT_ENABLED CmekConfig_NotebookLMState = 3
)func (CmekConfig_NotebookLMState) Descriptor
func (CmekConfig_NotebookLMState) Descriptor() protoreflect.EnumDescriptorfunc (CmekConfig_NotebookLMState) Enum
func (x CmekConfig_NotebookLMState) Enum() *CmekConfig_NotebookLMStatefunc (CmekConfig_NotebookLMState) EnumDescriptor
func (CmekConfig_NotebookLMState) EnumDescriptor() ([]byte, []int)Deprecated: Use CmekConfig_NotebookLMState.Descriptor instead.
func (CmekConfig_NotebookLMState) Number
func (x CmekConfig_NotebookLMState) Number() protoreflect.EnumNumberfunc (CmekConfig_NotebookLMState) String
func (x CmekConfig_NotebookLMState) String() stringfunc (CmekConfig_NotebookLMState) Type
func (CmekConfig_NotebookLMState) Type() protoreflect.EnumTypeCmekConfig_State
type CmekConfig_State int32States of the CmekConfig.
CmekConfig_STATE_UNSPECIFIED, CmekConfig_CREATING, CmekConfig_ACTIVE, CmekConfig_KEY_ISSUE, CmekConfig_DELETING, CmekConfig_DELETE_FAILED, CmekConfig_UNUSABLE, CmekConfig_ACTIVE_ROTATING, CmekConfig_DELETED, CmekConfig_EXPIRED
const (
// The CmekConfig state is unknown.
CmekConfig_STATE_UNSPECIFIED CmekConfig_State = 0
// The CmekConfig is creating.
CmekConfig_CREATING CmekConfig_State = 1
// The CmekConfig can be used with DataStores.
CmekConfig_ACTIVE CmekConfig_State = 2
// The CmekConfig is unavailable, most likely due to the KMS Key being
// revoked.
CmekConfig_KEY_ISSUE CmekConfig_State = 3
// The CmekConfig is deleting.
CmekConfig_DELETING CmekConfig_State = 4
// The CmekConfig deletion process failed.
CmekConfig_DELETE_FAILED CmekConfig_State = 7
// The CmekConfig is not usable, most likely due to some internal issue.
CmekConfig_UNUSABLE CmekConfig_State = 5
// The KMS key version is being rotated.
CmekConfig_ACTIVE_ROTATING CmekConfig_State = 6
// The KMS key is soft deleted. Some cleanup policy will eventually be
// applied.
CmekConfig_DELETED CmekConfig_State = 8
// The KMS key is expired, meaning the key has been disabled for 30+ days.
// The customer can call DeleteCmekConfig to change the state to DELETED.
CmekConfig_EXPIRED CmekConfig_State = 9
)func (CmekConfig_State) Descriptor
func (CmekConfig_State) Descriptor() protoreflect.EnumDescriptorfunc (CmekConfig_State) Enum
func (x CmekConfig_State) Enum() *CmekConfig_Statefunc (CmekConfig_State) EnumDescriptor
func (CmekConfig_State) EnumDescriptor() ([]byte, []int)Deprecated: Use CmekConfig_State.Descriptor instead.
func (CmekConfig_State) Number
func (x CmekConfig_State) Number() protoreflect.EnumNumberfunc (CmekConfig_State) String
func (x CmekConfig_State) String() stringfunc (CmekConfig_State) Type
func (CmekConfig_State) Type() protoreflect.EnumTypeCollectUserEventRequest
type CollectUserEventRequest struct {
// Required. The parent resource name.
// If the collect user event action is applied in
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore] level, the
// format is:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
// If the collect user event action is applied in
// [Location][google.cloud.location.Location] level, for example, the event
// with [Document][google.cloud.discoveryengine.v1beta.Document] across
// multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore], the
// format is: `projects/{project}/locations/{location}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. URL encoded UserEvent proto with a length limit of 2,000,000
// characters.
UserEvent string `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
// The URL including cgi-parameters but excluding the hash fragment with a
// length limit of 5,000 characters. This is often more useful than the
// referer URL, because many browsers only send the domain for third-party
// requests.
Uri *string `protobuf:"bytes,3,opt,name=uri,proto3,oneof" json:"uri,omitempty"`
// The event timestamp in milliseconds. This prevents browser caching of
// otherwise identical get requests. The name is abbreviated to reduce the
// payload bytes.
Ets *int64 `protobuf:"varint,4,opt,name=ets,proto3,oneof" json:"ets,omitempty"`
// contains filtered or unexported fields
}Request message for CollectUserEvent method.
func (*CollectUserEventRequest) Descriptor
func (*CollectUserEventRequest) Descriptor() ([]byte, []int)Deprecated: Use CollectUserEventRequest.ProtoReflect.Descriptor instead.
func (*CollectUserEventRequest) GetEts
func (x *CollectUserEventRequest) GetEts() int64func (*CollectUserEventRequest) GetParent
func (x *CollectUserEventRequest) GetParent() stringfunc (*CollectUserEventRequest) GetUri
func (x *CollectUserEventRequest) GetUri() stringfunc (*CollectUserEventRequest) GetUserEvent
func (x *CollectUserEventRequest) GetUserEvent() stringfunc (*CollectUserEventRequest) ProtoMessage
func (*CollectUserEventRequest) ProtoMessage()func (*CollectUserEventRequest) ProtoReflect
func (x *CollectUserEventRequest) ProtoReflect() protoreflect.Messagefunc (*CollectUserEventRequest) Reset
func (x *CollectUserEventRequest) Reset()func (*CollectUserEventRequest) String
func (x *CollectUserEventRequest) String() stringCompleteQueryRequest
type CompleteQueryRequest struct {
// Required. The parent data store resource name for which the completion is
// performed, such as
// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// Required. The typeahead input used to fetch suggestions. Maximum length is
// 128 characters.
Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
// Specifies the autocomplete data model. This overrides any model specified
// in the Configuration > Autocomplete section of the Cloud console. Currently
// supported values:
//
// * `document` - Using suggestions generated from user-imported documents.
// * `search-history` - Using suggestions generated from the past history of
// [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
// API calls. Do not use it when there is no traffic for Search API.
// * `user-event` - Using suggestions generated from user-imported search
// events.
// * `document-completable` - Using suggestions taken directly from
// user-imported document fields marked as completable.
//
// Default values:
//
// * `document` is the default model for regular dataStores.
// * `search-history` is the default model for site search dataStores.
QueryModel string `protobuf:"bytes,3,opt,name=query_model,json=queryModel,proto3" json:"query_model,omitempty"`
// Optional. A unique identifier for tracking visitors. For example, this
// could be implemented with an HTTP cookie, which should be able to uniquely
// identify a visitor on a single device. This unique identifier should not
// change if the visitor logs in or out of the website.
//
// This field should NOT have a fixed value such as `unknown_visitor`.
//
// This should be the same identifier as
// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
// and
// [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].
//
// The field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
UserPseudoId string `protobuf:"bytes,4,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
// Indicates if tail suggestions should be returned if there are no
// suggestions that match the full query. Even if set to true, if there are
// suggestions that match the full query, those are returned and no
// tail suggestions are returned.
IncludeTailSuggestions bool `protobuf:"varint,5,opt,name=include_tail_suggestions,json=includeTailSuggestions,proto3" json:"include_tail_suggestions,omitempty"`
// contains filtered or unexported fields
}Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.
func (*CompleteQueryRequest) Descriptor
func (*CompleteQueryRequest) Descriptor() ([]byte, []int)Deprecated: Use CompleteQueryRequest.ProtoReflect.Descriptor instead.
func (*CompleteQueryRequest) GetDataStore
func (x *CompleteQueryRequest) GetDataStore() stringfunc (*CompleteQueryRequest) GetIncludeTailSuggestions
func (x *CompleteQueryRequest) GetIncludeTailSuggestions() boolfunc (*CompleteQueryRequest) GetQuery
func (x *CompleteQueryRequest) GetQuery() stringfunc (*CompleteQueryRequest) GetQueryModel
func (x *CompleteQueryRequest) GetQueryModel() stringfunc (*CompleteQueryRequest) GetUserPseudoId
func (x *CompleteQueryRequest) GetUserPseudoId() stringfunc (*CompleteQueryRequest) ProtoMessage
func (*CompleteQueryRequest) ProtoMessage()func (*CompleteQueryRequest) ProtoReflect
func (x *CompleteQueryRequest) ProtoReflect() protoreflect.Messagefunc (*CompleteQueryRequest) Reset
func (x *CompleteQueryRequest) Reset()func (*CompleteQueryRequest) String
func (x *CompleteQueryRequest) String() stringCompleteQueryResponse
type CompleteQueryResponse struct {
// Results of the matched query suggestions. The result list is ordered and
// the first result is a top suggestion.
QuerySuggestions []*CompleteQueryResponse_QuerySuggestion `protobuf:"bytes,1,rep,name=query_suggestions,json=querySuggestions,proto3" json:"query_suggestions,omitempty"`
// True if the returned suggestions are all tail suggestions.
//
// For tail matching to be triggered, include_tail_suggestions in the request
// must be true and there must be no suggestions that match the full query.
TailMatchTriggered bool `protobuf:"varint,2,opt,name=tail_match_triggered,json=tailMatchTriggered,proto3" json:"tail_match_triggered,omitempty"`
// contains filtered or unexported fields
}Response message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.
func (*CompleteQueryResponse) Descriptor
func (*CompleteQueryResponse) Descriptor() ([]byte, []int)Deprecated: Use CompleteQueryResponse.ProtoReflect.Descriptor instead.
func (*CompleteQueryResponse) GetQuerySuggestions
func (x *CompleteQueryResponse) GetQuerySuggestions() []*CompleteQueryResponse_QuerySuggestionfunc (*CompleteQueryResponse) GetTailMatchTriggered
func (x *CompleteQueryResponse) GetTailMatchTriggered() boolfunc (*CompleteQueryResponse) ProtoMessage
func (*CompleteQueryResponse) ProtoMessage()func (*CompleteQueryResponse) ProtoReflect
func (x *CompleteQueryResponse) ProtoReflect() protoreflect.Messagefunc (*CompleteQueryResponse) Reset
func (x *CompleteQueryResponse) Reset()func (*CompleteQueryResponse) String
func (x *CompleteQueryResponse) String() stringCompleteQueryResponse_QuerySuggestion
type CompleteQueryResponse_QuerySuggestion struct {
// The suggestion for the query.
Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
// The unique document field paths that serve as the source of this
// suggestion if it was generated from completable fields.
//
// This field is only populated for the document-completable model.
CompletableFieldPaths []string `protobuf:"bytes,2,rep,name=completable_field_paths,json=completableFieldPaths,proto3" json:"completable_field_paths,omitempty"`
// contains filtered or unexported fields
}Suggestions as search queries.
func (*CompleteQueryResponse_QuerySuggestion) Descriptor
func (*CompleteQueryResponse_QuerySuggestion) Descriptor() ([]byte, []int)Deprecated: Use CompleteQueryResponse_QuerySuggestion.ProtoReflect.Descriptor instead.
func (*CompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths
func (x *CompleteQueryResponse_QuerySuggestion) GetCompletableFieldPaths() []stringfunc (*CompleteQueryResponse_QuerySuggestion) GetSuggestion
func (x *CompleteQueryResponse_QuerySuggestion) GetSuggestion() stringfunc (*CompleteQueryResponse_QuerySuggestion) ProtoMessage
func (*CompleteQueryResponse_QuerySuggestion) ProtoMessage()func (*CompleteQueryResponse_QuerySuggestion) ProtoReflect
func (x *CompleteQueryResponse_QuerySuggestion) ProtoReflect() protoreflect.Messagefunc (*CompleteQueryResponse_QuerySuggestion) Reset
func (x *CompleteQueryResponse_QuerySuggestion) Reset()func (*CompleteQueryResponse_QuerySuggestion) String
func (x *CompleteQueryResponse_QuerySuggestion) String() stringCompletionInfo
type CompletionInfo struct {
// End user selected
// [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1beta.CompleteQueryResponse.QuerySuggestion.suggestion].
SelectedSuggestion string `protobuf:"bytes,1,opt,name=selected_suggestion,json=selectedSuggestion,proto3" json:"selected_suggestion,omitempty"`
// End user selected
// [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1beta.CompleteQueryResponse.QuerySuggestion.suggestion]
// position, starting from 0.
SelectedPosition int32 `protobuf:"varint,2,opt,name=selected_position,json=selectedPosition,proto3" json:"selected_position,omitempty"`
// contains filtered or unexported fields
}Detailed completion information including completion attribution token and clicked completion info.
func (*CompletionInfo) Descriptor
func (*CompletionInfo) Descriptor() ([]byte, []int)Deprecated: Use CompletionInfo.ProtoReflect.Descriptor instead.
func (*CompletionInfo) GetSelectedPosition
func (x *CompletionInfo) GetSelectedPosition() int32func (*CompletionInfo) GetSelectedSuggestion
func (x *CompletionInfo) GetSelectedSuggestion() stringfunc (*CompletionInfo) ProtoMessage
func (*CompletionInfo) ProtoMessage()func (*CompletionInfo) ProtoReflect
func (x *CompletionInfo) ProtoReflect() protoreflect.Messagefunc (*CompletionInfo) Reset
func (x *CompletionInfo) Reset()func (*CompletionInfo) String
func (x *CompletionInfo) String() stringCompletionServiceClient
type CompletionServiceClient interface {
// Completes the specified user input with keyword suggestions.
CompleteQuery(ctx context.Context, in *CompleteQueryRequest, opts ...grpc.CallOption) (*CompleteQueryResponse, error)
// Completes the user input with advanced keyword suggestions.
AdvancedCompleteQuery(ctx context.Context, in *AdvancedCompleteQueryRequest, opts ...grpc.CallOption) (*AdvancedCompleteQueryResponse, error)
// Imports all
// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry]
// for a DataStore.
ImportSuggestionDenyListEntries(ctx context.Context, in *ImportSuggestionDenyListEntriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Permanently deletes all
// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry]
// for a DataStore.
PurgeSuggestionDenyListEntries(ctx context.Context, in *PurgeSuggestionDenyListEntriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Imports
// [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
// for a DataStore.
ImportCompletionSuggestions(ctx context.Context, in *ImportCompletionSuggestionsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Permanently deletes all
// [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
// for a DataStore.
PurgeCompletionSuggestions(ctx context.Context, in *PurgeCompletionSuggestionsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Removes the search history suggestion in an engine for a user. This will
// remove the suggestion from being returned in the
// [AdvancedCompleteQueryResponse.recent_search_suggestions][google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.recent_search_suggestions]
// for this user. If the user searches the same suggestion again, the new
// history will override and suggest this suggestion again.
RemoveSuggestion(ctx context.Context, in *RemoveSuggestionRequest, opts ...grpc.CallOption) (*RemoveSuggestionResponse, 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) CompletionServiceClientCompletionServiceServer
type CompletionServiceServer interface {
// Completes the specified user input with keyword suggestions.
CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)
// Completes the user input with advanced keyword suggestions.
AdvancedCompleteQuery(context.Context, *AdvancedCompleteQueryRequest) (*AdvancedCompleteQueryResponse, error)
// Imports all
// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry]
// for a DataStore.
ImportSuggestionDenyListEntries(context.Context, *ImportSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)
// Permanently deletes all
// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry]
// for a DataStore.
PurgeSuggestionDenyListEntries(context.Context, *PurgeSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)
// Imports
// [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
// for a DataStore.
ImportCompletionSuggestions(context.Context, *ImportCompletionSuggestionsRequest) (*longrunningpb.Operation, error)
// Permanently deletes all
// [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
// for a DataStore.
PurgeCompletionSuggestions(context.Context, *PurgeCompletionSuggestionsRequest) (*longrunningpb.Operation, error)
// Removes the search history suggestion in an engine for a user. This will
// remove the suggestion from being returned in the
// [AdvancedCompleteQueryResponse.recent_search_suggestions][google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.recent_search_suggestions]
// for this user. If the user searches the same suggestion again, the new
// history will override and suggest this suggestion again.
RemoveSuggestion(context.Context, *RemoveSuggestionRequest) (*RemoveSuggestionResponse, error)
}CompletionServiceServer is the server API for CompletionService service. All implementations should embed UnimplementedCompletionServiceServer for forward compatibility
CompletionSuggestion
type CompletionSuggestion struct {
// Ranking metrics of this suggestion.
//
// Types that are valid to be assigned to RankingInfo:
//
// *CompletionSuggestion_GlobalScore
// *CompletionSuggestion_Frequency
RankingInfo isCompletionSuggestion_RankingInfo `protobuf_oneof:"ranking_info"`
// Required. The suggestion text.
Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
// BCP-47 language code of this suggestion.
LanguageCode string `protobuf:"bytes,4,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// If two suggestions have the same groupId, they will not be
// returned together. Instead the one ranked higher will be returned. This can
// be used to deduplicate semantically identical suggestions.
GroupId string `protobuf:"bytes,5,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
// The score of this suggestion within its group.
GroupScore float64 `protobuf:"fixed64,6,opt,name=group_score,json=groupScore,proto3" json:"group_score,omitempty"`
// Alternative matching phrases for this suggestion.
AlternativePhrases []string `protobuf:"bytes,7,rep,name=alternative_phrases,json=alternativePhrases,proto3" json:"alternative_phrases,omitempty"`
// contains filtered or unexported fields
}Autocomplete suggestions that are imported from Customer.
func (*CompletionSuggestion) Descriptor
func (*CompletionSuggestion) Descriptor() ([]byte, []int)Deprecated: Use CompletionSuggestion.ProtoReflect.Descriptor instead.
func (*CompletionSuggestion) GetAlternativePhrases
func (x *CompletionSuggestion) GetAlternativePhrases() []stringfunc (*CompletionSuggestion) GetFrequency
func (x *CompletionSuggestion) GetFrequency() int64func (*CompletionSuggestion) GetGlobalScore
func (x *CompletionSuggestion) GetGlobalScore() float64func (*CompletionSuggestion) GetGroupId
func (x *CompletionSuggestion) GetGroupId() stringfunc (*CompletionSuggestion) GetGroupScore
func (x *CompletionSuggestion) GetGroupScore() float64func (*CompletionSuggestion) GetLanguageCode
func (x *CompletionSuggestion) GetLanguageCode() stringfunc (*CompletionSuggestion) GetRankingInfo
func (x *CompletionSuggestion) GetRankingInfo() isCompletionSuggestion_RankingInfofunc (*CompletionSuggestion) GetSuggestion
func (x *CompletionSuggestion) GetSuggestion() stringfunc (*CompletionSuggestion) ProtoMessage
func (*CompletionSuggestion) ProtoMessage()func (*CompletionSuggestion) ProtoReflect
func (x *CompletionSuggestion) ProtoReflect() protoreflect.Messagefunc (*CompletionSuggestion) Reset
func (x *CompletionSuggestion) Reset()func (*CompletionSuggestion) String
func (x *CompletionSuggestion) String() stringCompletionSuggestion_Frequency
type CompletionSuggestion_Frequency struct {
// Frequency of this suggestion. Will be used to rank suggestions when score
// is not available.
Frequency int64 `protobuf:"varint,3,opt,name=frequency,proto3,oneof"`
}CompletionSuggestion_GlobalScore
type CompletionSuggestion_GlobalScore struct {
// Global score of this suggestion. Control how this suggestion would be
// scored / ranked.
GlobalScore float64 `protobuf:"fixed64,2,opt,name=global_score,json=globalScore,proto3,oneof"`
}Condition
type Condition struct {
// Search only
// A list of terms to match the query on.
// Cannot be set when
// [Condition.query_regex][google.cloud.discoveryengine.v1beta.Condition.query_regex]
// is set.
//
// Maximum of 10 query terms.
QueryTerms []*Condition_QueryTerm `protobuf:"bytes,2,rep,name=query_terms,json=queryTerms,proto3" json:"query_terms,omitempty"`
// Range of time(s) specifying when condition is active.
//
// Maximum of 10 time ranges.
ActiveTimeRange []*Condition_TimeRange `protobuf:"bytes,3,rep,name=active_time_range,json=activeTimeRange,proto3" json:"active_time_range,omitempty"`
// Optional. Query regex to match the whole search query.
// Cannot be set when
// [Condition.query_terms][google.cloud.discoveryengine.v1beta.Condition.query_terms]
// is set. Only supported for Basic Site Search promotion serving controls.
QueryRegex string `protobuf:"bytes,4,opt,name=query_regex,json=queryRegex,proto3" json:"query_regex,omitempty"`
// contains filtered or unexported fields
}Defines circumstances to be checked before allowing a behavior
func (*Condition) Descriptor
Deprecated: Use Condition.ProtoReflect.Descriptor instead.
func (*Condition) GetActiveTimeRange
func (x *Condition) GetActiveTimeRange() []*Condition_TimeRangefunc (*Condition) GetQueryRegex
func (*Condition) GetQueryTerms
func (x *Condition) GetQueryTerms() []*Condition_QueryTermfunc (*Condition) ProtoMessage
func (*Condition) ProtoMessage()func (*Condition) ProtoReflect
func (x *Condition) ProtoReflect() protoreflect.Messagefunc (*Condition) Reset
func (x *Condition) Reset()func (*Condition) String
Condition_QueryTerm
type Condition_QueryTerm struct {
// The specific query value to match against
//
// Must be lowercase, must be UTF-8.
// Can have at most 3 space separated terms if full_match is true.
// Cannot be an empty string.
// Maximum length of 5000 characters.
Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
// Whether the search query needs to exactly match the query term.
FullMatch bool `protobuf:"varint,2,opt,name=full_match,json=fullMatch,proto3" json:"full_match,omitempty"`
// contains filtered or unexported fields
}Matcher for search request query
func (*Condition_QueryTerm) Descriptor
func (*Condition_QueryTerm) Descriptor() ([]byte, []int)Deprecated: Use Condition_QueryTerm.ProtoReflect.Descriptor instead.
func (*Condition_QueryTerm) GetFullMatch
func (x *Condition_QueryTerm) GetFullMatch() boolfunc (*Condition_QueryTerm) GetValue
func (x *Condition_QueryTerm) GetValue() stringfunc (*Condition_QueryTerm) ProtoMessage
func (*Condition_QueryTerm) ProtoMessage()func (*Condition_QueryTerm) ProtoReflect
func (x *Condition_QueryTerm) ProtoReflect() protoreflect.Messagefunc (*Condition_QueryTerm) Reset
func (x *Condition_QueryTerm) Reset()func (*Condition_QueryTerm) String
func (x *Condition_QueryTerm) String() stringCondition_TimeRange
type Condition_TimeRange struct {
// Start of time range.
//
// Range is inclusive.
StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// End of time range.
//
// Range is inclusive.
// Must be in the future.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}Used for time-dependent conditions.
func (*Condition_TimeRange) Descriptor
func (*Condition_TimeRange) Descriptor() ([]byte, []int)Deprecated: Use Condition_TimeRange.ProtoReflect.Descriptor instead.
func (*Condition_TimeRange) GetEndTime
func (x *Condition_TimeRange) GetEndTime() *timestamppb.Timestampfunc (*Condition_TimeRange) GetStartTime
func (x *Condition_TimeRange) GetStartTime() *timestamppb.Timestampfunc (*Condition_TimeRange) ProtoMessage
func (*Condition_TimeRange) ProtoMessage()func (*Condition_TimeRange) ProtoReflect
func (x *Condition_TimeRange) ProtoReflect() protoreflect.Messagefunc (*Condition_TimeRange) Reset
func (x *Condition_TimeRange) Reset()func (*Condition_TimeRange) String
func (x *Condition_TimeRange) String() stringControl
type Control struct {
// Types that are valid to be assigned to Action:
//
// *Control_BoostAction_
// *Control_FilterAction_
// *Control_RedirectAction_
// *Control_SynonymsAction_
// *Control_PromoteAction_
Action isControl_Action `protobuf_oneof:"action"`
// Immutable. Fully qualified name
// `projects/*/locations/global/dataStore/*/controls/*`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Human readable name. The identifier used in UI views.
//
// Must be UTF-8 encoded string. Length limit is 128 characters.
// Otherwise an INVALID ARGUMENT error is thrown.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. List of all
// [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] IDs this
// control is attached to. May take up to 10 minutes to update after changes.
AssociatedServingConfigIds []string `protobuf:"bytes,3,rep,name=associated_serving_config_ids,json=associatedServingConfigIds,proto3" json:"associated_serving_config_ids,omitempty"`
// Required. Immutable. What solution the control belongs to.
//
// Must be compatible with vertical of resource.
// Otherwise an INVALID ARGUMENT error is thrown.
SolutionType SolutionType `protobuf:"varint,4,opt,name=solution_type,json=solutionType,proto3,enum=google.cloud.discoveryengine.v1beta.SolutionType" json:"solution_type,omitempty"`
// Specifies the use case for the control.
// Affects what condition fields can be set.
// Only applies to
// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
// Currently only allow one use case per control.
// Must be set when solution_type is
// [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
UseCases []SearchUseCase `protobuf:"varint,8,rep,packed,name=use_cases,json=useCases,proto3,enum=google.cloud.discoveryengine.v1beta.SearchUseCase" json:"use_cases,omitempty"`
// Determines when the associated action will trigger.
//
// Omit to always apply the action.
// Currently only a single condition may be specified.
// Otherwise an INVALID ARGUMENT error is thrown.
Conditions []*Condition `protobuf:"bytes,5,rep,name=conditions,proto3" json:"conditions,omitempty"`
// contains filtered or unexported fields
}Defines a conditioned behavior to employ during serving.
Must be attached to a
[ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] to be
considered at serving time. Permitted actions dependent on SolutionType.
func (*Control) Descriptor
Deprecated: Use Control.ProtoReflect.Descriptor instead.
func (*Control) GetAction
func (x *Control) GetAction() isControl_Actionfunc (*Control) GetAssociatedServingConfigIds
func (*Control) GetBoostAction
func (x *Control) GetBoostAction() *Control_BoostActionfunc (*Control) GetConditions
func (*Control) GetDisplayName
func (*Control) GetFilterAction
func (x *Control) GetFilterAction() *Control_FilterActionfunc (*Control) GetName
func (*Control) GetPromoteAction
func (x *Control) GetPromoteAction() *Control_PromoteActionfunc (*Control) GetRedirectAction
func (x *Control) GetRedirectAction() *Control_RedirectActionfunc (*Control) GetSolutionType
func (x *Control) GetSolutionType() SolutionTypefunc (*Control) GetSynonymsAction
func (x *Control) GetSynonymsAction() *Control_SynonymsActionfunc (*Control) GetUseCases
func (x *Control) GetUseCases() []SearchUseCasefunc (*Control) ProtoMessage
func (*Control) ProtoMessage()func (*Control) ProtoReflect
func (x *Control) ProtoReflect() protoreflect.Messagefunc (*Control) Reset
func (x *Control) Reset()func (*Control) String
ControlServiceClient
type ControlServiceClient interface {
// Creates a Control.
//
// By default 1000 controls are allowed for a data store.
// A request can be submitted to adjust this limit.
// If the [Control][google.cloud.discoveryengine.v1beta.Control] to create
// already exists, an ALREADY_EXISTS error is returned.
CreateControl(ctx context.Context, in *CreateControlRequest, opts ...grpc.CallOption) (*Control, error)
// Deletes a Control.
//
// If the [Control][google.cloud.discoveryengine.v1beta.Control] to delete
// does not exist, a NOT_FOUND error is returned.
DeleteControl(ctx context.Context, in *DeleteControlRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates a Control.
//
// [Control][google.cloud.discoveryengine.v1beta.Control] action type cannot
// be changed. If the [Control][google.cloud.discoveryengine.v1beta.Control]
// to update does not exist, a NOT_FOUND error is returned.
UpdateControl(ctx context.Context, in *UpdateControlRequest, opts ...grpc.CallOption) (*Control, error)
// Gets a Control.
GetControl(ctx context.Context, in *GetControlRequest, opts ...grpc.CallOption) (*Control, error)
// Lists all Controls by their parent
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
ListControls(ctx context.Context, in *ListControlsRequest, opts ...grpc.CallOption) (*ListControlsResponse, error)
}ControlServiceClient is the client API for ControlService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewControlServiceClient
func NewControlServiceClient(cc grpc.ClientConnInterface) ControlServiceClientControlServiceServer
type ControlServiceServer interface {
// Creates a Control.
//
// By default 1000 controls are allowed for a data store.
// A request can be submitted to adjust this limit.
// If the [Control][google.cloud.discoveryengine.v1beta.Control] to create
// already exists, an ALREADY_EXISTS error is returned.
CreateControl(context.Context, *CreateControlRequest) (*Control, error)
// Deletes a Control.
//
// If the [Control][google.cloud.discoveryengine.v1beta.Control] to delete
// does not exist, a NOT_FOUND error is returned.
DeleteControl(context.Context, *DeleteControlRequest) (*emptypb.Empty, error)
// Updates a Control.
//
// [Control][google.cloud.discoveryengine.v1beta.Control] action type cannot
// be changed. If the [Control][google.cloud.discoveryengine.v1beta.Control]
// to update does not exist, a NOT_FOUND error is returned.
UpdateControl(context.Context, *UpdateControlRequest) (*Control, error)
// Gets a Control.
GetControl(context.Context, *GetControlRequest) (*Control, error)
// Lists all Controls by their parent
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
ListControls(context.Context, *ListControlsRequest) (*ListControlsResponse, error)
}ControlServiceServer is the server API for ControlService service. All implementations should embed UnimplementedControlServiceServer for forward compatibility
Control_BoostAction
type Control_BoostAction struct {
// Constant value boost or custom ranking based boost specifications.
//
// Types that are valid to be assigned to BoostSpec:
//
// *Control_BoostAction_FixedBoost
// *Control_BoostAction_InterpolationBoostSpec_
BoostSpec isControl_BoostAction_BoostSpec `protobuf_oneof:"boost_spec"`
// Strength of the boost, which should be in [-1, 1]. Negative
// boost means demotion. Default is 0.0 (No-op).
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/control.proto.
Boost float32 `protobuf:"fixed32,1,opt,name=boost,proto3" json:"boost,omitempty"`
// Required. Specifies which products to apply the boost to.
//
// If no filter is provided all products will be boosted (No-op).
// Syntax documentation:
// https://cloud.google.com/retail/docs/filter-and-order
// Maximum length is 5000 characters.
// Otherwise an INVALID ARGUMENT error is thrown.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Required. Specifies which data store's documents can be boosted by this
// control. Full data store name e.g.
// projects/123/locations/global/collections/default_collection/dataStores/default_data_store
DataStore string `protobuf:"bytes,3,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// contains filtered or unexported fields
}Adjusts order of products in returned list.
func (*Control_BoostAction) Descriptor
func (*Control_BoostAction) Descriptor() ([]byte, []int)Deprecated: Use Control_BoostAction.ProtoReflect.Descriptor instead.
func (*Control_BoostAction) GetBoost
func (x *Control_BoostAction) GetBoost() float32Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/control.proto.
func (*Control_BoostAction) GetBoostSpec
func (x *Control_BoostAction) GetBoostSpec() isControl_BoostAction_BoostSpecfunc (*Control_BoostAction) GetDataStore
func (x *Control_BoostAction) GetDataStore() stringfunc (*Control_BoostAction) GetFilter
func (x *Control_BoostAction) GetFilter() stringfunc (*Control_BoostAction) GetFixedBoost
func (x *Control_BoostAction) GetFixedBoost() float32func (*Control_BoostAction) GetInterpolationBoostSpec
func (x *Control_BoostAction) GetInterpolationBoostSpec() *Control_BoostAction_InterpolationBoostSpecfunc (*Control_BoostAction) ProtoMessage
func (*Control_BoostAction) ProtoMessage()func (*Control_BoostAction) ProtoReflect
func (x *Control_BoostAction) ProtoReflect() protoreflect.Messagefunc (*Control_BoostAction) Reset
func (x *Control_BoostAction) Reset()func (*Control_BoostAction) String
func (x *Control_BoostAction) String() stringControl_BoostAction_
type Control_BoostAction_ struct {
// Defines a boost-type control
BoostAction *Control_BoostAction `protobuf:"bytes,6,opt,name=boost_action,json=boostAction,proto3,oneof"`
}Control_BoostAction_FixedBoost
type Control_BoostAction_FixedBoost struct {
// Optional. Strength of the boost, which should be in [-1, 1]. Negative
// boost means demotion. Default is 0.0 (No-op).
FixedBoost float32 `protobuf:"fixed32,4,opt,name=fixed_boost,json=fixedBoost,proto3,oneof"`
}Control_BoostAction_InterpolationBoostSpec
type Control_BoostAction_InterpolationBoostSpec struct {
// Optional. The name of the field whose value will be used to determine
// the boost amount.
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// Optional. The attribute type to be used to determine the boost amount.
// The attribute value can be derived from the field value of the
// specified field_name. In the case of numerical it is straightforward
// i.e. attribute_value = numerical_field_value. In the case of freshness
// however, attribute_value = (time.now() - datetime_field_value).
AttributeType Control_BoostAction_InterpolationBoostSpec_AttributeType `protobuf:"varint,2,opt,name=attribute_type,json=attributeType,proto3,enum=google.cloud.discoveryengine.v1beta.Control_BoostAction_InterpolationBoostSpec_AttributeType" json:"attribute_type,omitempty"`
// Optional. The interpolation type to be applied to connect the control
// points listed below.
InterpolationType Control_BoostAction_InterpolationBoostSpec_InterpolationType `protobuf:"varint,3,opt,name=interpolation_type,json=interpolationType,proto3,enum=google.cloud.discoveryengine.v1beta.Control_BoostAction_InterpolationBoostSpec_InterpolationType" json:"interpolation_type,omitempty"`
// Optional. The control points used to define the curve. The monotonic
// function (defined through the interpolation_type above) passes through
// the control points listed here.
ControlPoints []*Control_BoostAction_InterpolationBoostSpec_ControlPoint `protobuf:"bytes,4,rep,name=control_points,json=controlPoints,proto3" json:"control_points,omitempty"`
// contains filtered or unexported fields
}Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
func (*Control_BoostAction_InterpolationBoostSpec) Descriptor
func (*Control_BoostAction_InterpolationBoostSpec) Descriptor() ([]byte, []int)Deprecated: Use Control_BoostAction_InterpolationBoostSpec.ProtoReflect.Descriptor instead.
func (*Control_BoostAction_InterpolationBoostSpec) GetAttributeType
func (x *Control_BoostAction_InterpolationBoostSpec) GetAttributeType() Control_BoostAction_InterpolationBoostSpec_AttributeTypefunc (*Control_BoostAction_InterpolationBoostSpec) GetControlPoints
func (x *Control_BoostAction_InterpolationBoostSpec) GetControlPoints() []*Control_BoostAction_InterpolationBoostSpec_ControlPointfunc (*Control_BoostAction_InterpolationBoostSpec) GetFieldName
func (x *Control_BoostAction_InterpolationBoostSpec) GetFieldName() stringfunc (*Control_BoostAction_InterpolationBoostSpec) GetInterpolationType
func (x *Control_BoostAction_InterpolationBoostSpec) GetInterpolationType() Control_BoostAction_InterpolationBoostSpec_InterpolationTypefunc (*Control_BoostAction_InterpolationBoostSpec) ProtoMessage
func (*Control_BoostAction_InterpolationBoostSpec) ProtoMessage()func (*Control_BoostAction_InterpolationBoostSpec) ProtoReflect
func (x *Control_BoostAction_InterpolationBoostSpec) ProtoReflect() protoreflect.Messagefunc (*Control_BoostAction_InterpolationBoostSpec) Reset
func (x *Control_BoostAction_InterpolationBoostSpec) Reset()func (*Control_BoostAction_InterpolationBoostSpec) String
func (x *Control_BoostAction_InterpolationBoostSpec) String() stringControl_BoostAction_InterpolationBoostSpec_
type Control_BoostAction_InterpolationBoostSpec_ struct {
// Optional. Complex specification for custom ranking based on customer
// defined attribute value.
InterpolationBoostSpec *Control_BoostAction_InterpolationBoostSpec `protobuf:"bytes,5,opt,name=interpolation_boost_spec,json=interpolationBoostSpec,proto3,oneof"`
}Control_BoostAction_InterpolationBoostSpec_AttributeType
type Control_BoostAction_InterpolationBoostSpec_AttributeType int32The attribute(or function) for which the custom ranking is to be applied.
Control_BoostAction_InterpolationBoostSpec_ATTRIBUTE_TYPE_UNSPECIFIED, Control_BoostAction_InterpolationBoostSpec_NUMERICAL, Control_BoostAction_InterpolationBoostSpec_FRESHNESS
const (
// Unspecified AttributeType.
Control_BoostAction_InterpolationBoostSpec_ATTRIBUTE_TYPE_UNSPECIFIED Control_BoostAction_InterpolationBoostSpec_AttributeType = 0
// The value of the numerical field will be used to dynamically update
// the boost amount. In this case, the attribute_value (the x value)
// of the control point will be the actual value of the numerical
// field for which the boost_amount is specified.
Control_BoostAction_InterpolationBoostSpec_NUMERICAL Control_BoostAction_InterpolationBoostSpec_AttributeType = 1
// For the freshness use case the attribute value will be the duration
// between the current time and the date in the datetime field
// specified. The value must be formatted as an XSD `dayTimeDuration`
// value (a restricted subset of an ISO 8601 duration value). The
// pattern for this is: `[nD][T[nH][nM][nS]]`.
// For example, `5D`, `3DT12H30M`, `T24H`.
Control_BoostAction_InterpolationBoostSpec_FRESHNESS Control_BoostAction_InterpolationBoostSpec_AttributeType = 2
)func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Descriptor
func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Descriptor() protoreflect.EnumDescriptorfunc (Control_BoostAction_InterpolationBoostSpec_AttributeType) Enum
func (x Control_BoostAction_InterpolationBoostSpec_AttributeType) Enum() *Control_BoostAction_InterpolationBoostSpec_AttributeTypefunc (Control_BoostAction_InterpolationBoostSpec_AttributeType) EnumDescriptor
func (Control_BoostAction_InterpolationBoostSpec_AttributeType) EnumDescriptor() ([]byte, []int)Deprecated: Use Control_BoostAction_InterpolationBoostSpec_AttributeType.Descriptor instead.
func (Control_BoostAction_InterpolationBoostSpec_AttributeType) Number
func (x Control_BoostAction_InterpolationBoostSpec_AttributeType) Number() protoreflect.EnumNumberfunc (Control_BoostAction_InterpolationBoostSpec_AttributeType) String
func (x Control_BoostAction_InterpolationBoostSpec_AttributeType) String() stringfunc (Control_BoostAction_InterpolationBoostSpec_AttributeType) Type
Control_BoostAction_InterpolationBoostSpec_ControlPoint
type Control_BoostAction_InterpolationBoostSpec_ControlPoint struct {
// Optional. Can be one of:
// 1. The numerical field value.
// 2. The duration spec for freshness:
// The value must be formatted as an XSD `dayTimeDuration` value (a
// restricted subset of an ISO 8601 duration value). The pattern for
// this is: `[nD][T[nH][nM][nS]]`.
AttributeValue string `protobuf:"bytes,1,opt,name=attribute_value,json=attributeValue,proto3" json:"attribute_value,omitempty"`
// Optional. The value between -1 to 1 by which to boost the score if
// the attribute_value evaluates to the value specified above.
BoostAmount float32 `protobuf:"fixed32,2,opt,name=boost_amount,json=boostAmount,proto3" json:"boost_amount,omitempty"`
// contains filtered or unexported fields
}The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) Descriptor
func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) Descriptor() ([]byte, []int)Deprecated: Use Control_BoostAction_InterpolationBoostSpec_ControlPoint.ProtoReflect.Descriptor instead.
func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) GetAttributeValue
func (x *Control_BoostAction_InterpolationBoostSpec_ControlPoint) GetAttributeValue() stringfunc (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) GetBoostAmount
func (x *Control_BoostAction_InterpolationBoostSpec_ControlPoint) GetBoostAmount() float32func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) ProtoMessage
func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) ProtoMessage()func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) ProtoReflect
func (x *Control_BoostAction_InterpolationBoostSpec_ControlPoint) ProtoReflect() protoreflect.Messagefunc (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) Reset
func (x *Control_BoostAction_InterpolationBoostSpec_ControlPoint) Reset()func (*Control_BoostAction_InterpolationBoostSpec_ControlPoint) String
func (x *Control_BoostAction_InterpolationBoostSpec_ControlPoint) String() stringControl_BoostAction_InterpolationBoostSpec_InterpolationType
type Control_BoostAction_InterpolationBoostSpec_InterpolationType int32The interpolation type to be applied. Default will be linear (Piecewise Linear).
Control_BoostAction_InterpolationBoostSpec_INTERPOLATION_TYPE_UNSPECIFIED, Control_BoostAction_InterpolationBoostSpec_LINEAR
const (
// Interpolation type is unspecified. In this case, it defaults to
// Linear.
Control_BoostAction_InterpolationBoostSpec_INTERPOLATION_TYPE_UNSPECIFIED Control_BoostAction_InterpolationBoostSpec_InterpolationType = 0
// Piecewise linear interpolation will be applied.
Control_BoostAction_InterpolationBoostSpec_LINEAR Control_BoostAction_InterpolationBoostSpec_InterpolationType = 1
)func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Descriptor
func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Descriptor() protoreflect.EnumDescriptorfunc (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Enum
func (x Control_BoostAction_InterpolationBoostSpec_InterpolationType) Enum() *Control_BoostAction_InterpolationBoostSpec_InterpolationTypefunc (Control_BoostAction_InterpolationBoostSpec_InterpolationType) EnumDescriptor
func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) EnumDescriptor() ([]byte, []int)Deprecated: Use Control_BoostAction_InterpolationBoostSpec_InterpolationType.Descriptor instead.
func (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Number
func (x Control_BoostAction_InterpolationBoostSpec_InterpolationType) Number() protoreflect.EnumNumberfunc (Control_BoostAction_InterpolationBoostSpec_InterpolationType) String
func (x Control_BoostAction_InterpolationBoostSpec_InterpolationType) String() stringfunc (Control_BoostAction_InterpolationBoostSpec_InterpolationType) Type
Control_FilterAction
type Control_FilterAction struct {
// Required. A filter to apply on the matching condition results.
//
// Required
// Syntax documentation:
// https://cloud.google.com/retail/docs/filter-and-order
// Maximum length is 5000 characters. Otherwise an INVALID
// ARGUMENT error is thrown.
Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
// Required. Specifies which data store's documents can be filtered by this
// control. Full data store name e.g.
// projects/123/locations/global/collections/default_collection/dataStores/default_data_store
DataStore string `protobuf:"bytes,2,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// contains filtered or unexported fields
}Specified which products may be included in results. Uses same filter as boost.
func (*Control_FilterAction) Descriptor
func (*Control_FilterAction) Descriptor() ([]byte, []int)Deprecated: Use Control_FilterAction.ProtoReflect.Descriptor instead.
func (*Control_FilterAction) GetDataStore
func (x *Control_FilterAction) GetDataStore() stringfunc (*Control_FilterAction) GetFilter
func (x *Control_FilterAction) GetFilter() stringfunc (*Control_FilterAction) ProtoMessage
func (*Control_FilterAction) ProtoMessage()func (*Control_FilterAction) ProtoReflect
func (x *Control_FilterAction) ProtoReflect() protoreflect.Messagefunc (*Control_FilterAction) Reset
func (x *Control_FilterAction) Reset()func (*Control_FilterAction) String
func (x *Control_FilterAction) String() stringControl_FilterAction_
type Control_FilterAction_ struct {
// Defines a filter-type control
// Currently not supported by Recommendation
FilterAction *Control_FilterAction `protobuf:"bytes,7,opt,name=filter_action,json=filterAction,proto3,oneof"`
}Control_PromoteAction
type Control_PromoteAction struct {
// Required. Data store with which this promotion is attached to.
DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// Required. Promotion attached to this action.
SearchLinkPromotion *SearchLinkPromotion `protobuf:"bytes,2,opt,name=search_link_promotion,json=searchLinkPromotion,proto3" json:"search_link_promotion,omitempty"`
// contains filtered or unexported fields
}Promote certain links based on some trigger queries.
Example: Promote shoe store link when searching for shoe keyword.
The link can be outside of associated data store.
func (*Control_PromoteAction) Descriptor
func (*Control_PromoteAction) Descriptor() ([]byte, []int)Deprecated: Use Control_PromoteAction.ProtoReflect.Descriptor instead.
func (*Control_PromoteAction) GetDataStore
func (x *Control_PromoteAction) GetDataStore() stringfunc (*Control_PromoteAction) GetSearchLinkPromotion
func (x *Control_PromoteAction) GetSearchLinkPromotion() *SearchLinkPromotionfunc (*Control_PromoteAction) ProtoMessage
func (*Control_PromoteAction) ProtoMessage()func (*Control_PromoteAction) ProtoReflect
func (x *Control_PromoteAction) ProtoReflect() protoreflect.Messagefunc (*Control_PromoteAction) Reset
func (x *Control_PromoteAction) Reset()func (*Control_PromoteAction) String
func (x *Control_PromoteAction) String() stringControl_PromoteAction_
type Control_PromoteAction_ struct {
// Promote certain links based on predefined trigger queries.
PromoteAction *Control_PromoteAction `protobuf:"bytes,15,opt,name=promote_action,json=promoteAction,proto3,oneof"`
}Control_RedirectAction
type Control_RedirectAction struct {
// Required. The URI to which the shopper will be redirected.
//
// Required.
// URI must have length equal or less than 2000 characters.
// Otherwise an INVALID ARGUMENT error is thrown.
RedirectUri string `protobuf:"bytes,1,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`
// contains filtered or unexported fields
}Redirects a shopper to the provided URI.
func (*Control_RedirectAction) Descriptor
func (*Control_RedirectAction) Descriptor() ([]byte, []int)Deprecated: Use Control_RedirectAction.ProtoReflect.Descriptor instead.
func (*Control_RedirectAction) GetRedirectUri
func (x *Control_RedirectAction) GetRedirectUri() stringfunc (*Control_RedirectAction) ProtoMessage
func (*Control_RedirectAction) ProtoMessage()func (*Control_RedirectAction) ProtoReflect
func (x *Control_RedirectAction) ProtoReflect() protoreflect.Messagefunc (*Control_RedirectAction) Reset
func (x *Control_RedirectAction) Reset()func (*Control_RedirectAction) String
func (x *Control_RedirectAction) String() stringControl_RedirectAction_
type Control_RedirectAction_ struct {
// Defines a redirect-type control.
RedirectAction *Control_RedirectAction `protobuf:"bytes,9,opt,name=redirect_action,json=redirectAction,proto3,oneof"`
}Control_SynonymsAction
type Control_SynonymsAction struct {
// Defines a set of synonyms.
// Can specify up to 100 synonyms.
// Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
// thrown.
Synonyms []string `protobuf:"bytes,1,rep,name=synonyms,proto3" json:"synonyms,omitempty"`
// contains filtered or unexported fields
}Creates a set of terms that will act as synonyms of one another.
Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".
func (*Control_SynonymsAction) Descriptor
func (*Control_SynonymsAction) Descriptor() ([]byte, []int)Deprecated: Use Control_SynonymsAction.ProtoReflect.Descriptor instead.
func (*Control_SynonymsAction) GetSynonyms
func (x *Control_SynonymsAction) GetSynonyms() []stringfunc (*Control_SynonymsAction) ProtoMessage
func (*Control_SynonymsAction) ProtoMessage()func (*Control_SynonymsAction) ProtoReflect
func (x *Control_SynonymsAction) ProtoReflect() protoreflect.Messagefunc (*Control_SynonymsAction) Reset
func (x *Control_SynonymsAction) Reset()func (*Control_SynonymsAction) String
func (x *Control_SynonymsAction) String() stringControl_SynonymsAction_
type Control_SynonymsAction_ struct {
// Treats a group of terms as synonyms of one another.
SynonymsAction *Control_SynonymsAction `protobuf:"bytes,10,opt,name=synonyms_action,json=synonymsAction,proto3,oneof"`
}Conversation
type Conversation struct {
// Immutable. Fully qualified name
// `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*`
// or
// `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The state of the Conversation.
State Conversation_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1beta.Conversation_State" json:"state,omitempty"`
// A unique identifier for tracking users.
UserPseudoId string `protobuf:"bytes,3,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
// Conversation messages.
Messages []*ConversationMessage `protobuf:"bytes,4,rep,name=messages,proto3" json:"messages,omitempty"`
// Output only. The time the conversation started.
StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. The time the conversation finished.
EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}External conversation proto definition.
func (*Conversation) Descriptor
func (*Conversation) Descriptor() ([]byte, []int)Deprecated: Use Conversation.ProtoReflect.Descriptor instead.
func (*Conversation) GetEndTime
func (x *Conversation) GetEndTime() *timestamppb.Timestampfunc (*Conversation) GetMessages
func (x *Conversation) GetMessages() []*ConversationMessagefunc (*Conversation) GetName
func (x *Conversation) GetName() stringfunc (*Conversation) GetStartTime
func (x *Conversation) GetStartTime() *timestamppb.Timestampfunc (*Conversation) GetState
func (x *Conversation) GetState() Conversation_Statefunc (*Conversation) GetUserPseudoId
func (x *Conversation) GetUserPseudoId() stringfunc (*Conversation) ProtoMessage
func (*Conversation) ProtoMessage()func (*Conversation) ProtoReflect
func (x *Conversation) ProtoReflect() protoreflect.Messagefunc (*Conversation) Reset
func (x *Conversation) Reset()func (*Conversation) String
func (x *Conversation) String() stringConversationContext
type ConversationContext struct {
// The current list of documents the user is seeing.
// It contains the document resource references.
ContextDocuments []string `protobuf:"bytes,1,rep,name=context_documents,json=contextDocuments,proto3" json:"context_documents,omitempty"`
// The current active document the user opened.
// It contains the document resource reference.
ActiveDocument string `protobuf:"bytes,2,opt,name=active_document,json=activeDocument,proto3" json:"active_document,omitempty"`
// contains filtered or unexported fields
}Defines context of the conversation
func (*ConversationContext) Descriptor
func (*ConversationContext) Descriptor() ([]byte, []int)Deprecated: Use ConversationContext.ProtoReflect.Descriptor instead.
func (*ConversationContext) GetActiveDocument
func (x *ConversationContext) GetActiveDocument() stringfunc (*ConversationContext) GetContextDocuments
func (x *ConversationContext) GetContextDocuments() []stringfunc (*ConversationContext) ProtoMessage
func (*ConversationContext) ProtoMessage()func (*ConversationContext) ProtoReflect
func (x *ConversationContext) ProtoReflect() protoreflect.Messagefunc (*ConversationContext) Reset
func (x *ConversationContext) Reset()func (*ConversationContext) String
func (x *ConversationContext) String() stringConversationMessage
type ConversationMessage struct {
// Types that are valid to be assigned to Message:
//
// *ConversationMessage_UserInput
// *ConversationMessage_Reply
Message isConversationMessage_Message `protobuf_oneof:"message"`
// Output only. Message creation timestamp.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}Defines a conversation message.
func (*ConversationMessage) Descriptor
func (*ConversationMessage) Descriptor() ([]byte, []int)Deprecated: Use ConversationMessage.ProtoReflect.Descriptor instead.
func (*ConversationMessage) GetCreateTime
func (x *ConversationMessage) GetCreateTime() *timestamppb.Timestampfunc (*ConversationMessage) GetMessage
func (x *ConversationMessage) GetMessage() isConversationMessage_Messagefunc (*ConversationMessage) GetReply
func (x *ConversationMessage) GetReply() *Replyfunc (*ConversationMessage) GetUserInput
func (x *ConversationMessage) GetUserInput() *TextInputfunc (*ConversationMessage) ProtoMessage
func (*ConversationMessage) ProtoMessage()func (*ConversationMessage) ProtoReflect
func (x *ConversationMessage) ProtoReflect() protoreflect.Messagefunc (*ConversationMessage) Reset
func (x *ConversationMessage) Reset()func (*ConversationMessage) String
func (x *ConversationMessage) String() stringConversationMessage_Reply
type ConversationMessage_Reply struct {
// Search reply.
Reply *Reply `protobuf:"bytes,2,opt,name=reply,proto3,oneof"`
}ConversationMessage_UserInput
type ConversationMessage_UserInput struct {
// User text input.
UserInput *TextInput `protobuf:"bytes,1,opt,name=user_input,json=userInput,proto3,oneof"`
}Conversation_State
type Conversation_State int32Enumeration of the state of the conversation.
Conversation_STATE_UNSPECIFIED, Conversation_IN_PROGRESS, Conversation_COMPLETED
const (
// Unknown.
Conversation_STATE_UNSPECIFIED Conversation_State = 0
// Conversation is currently open.
Conversation_IN_PROGRESS Conversation_State = 1
// Conversation has been completed.
Conversation_COMPLETED Conversation_State = 2
)func (Conversation_State) Descriptor
func (Conversation_State) Descriptor() protoreflect.EnumDescriptorfunc (Conversation_State) Enum
func (x Conversation_State) Enum() *Conversation_Statefunc (Conversation_State) EnumDescriptor
func (Conversation_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Conversation_State.Descriptor instead.
func (Conversation_State) Number
func (x Conversation_State) Number() protoreflect.EnumNumberfunc (Conversation_State) String
func (x Conversation_State) String() stringfunc (Conversation_State) Type
func (Conversation_State) Type() protoreflect.EnumTypeConversationalSearchServiceClient
type ConversationalSearchServiceClient interface {
// Converses a conversation.
ConverseConversation(ctx context.Context, in *ConverseConversationRequest, opts ...grpc.CallOption) (*ConverseConversationResponse, error)
// Creates a Conversation.
//
// If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to
// create already exists, an ALREADY_EXISTS error is returned.
CreateConversation(ctx context.Context, in *CreateConversationRequest, opts ...grpc.CallOption) (*Conversation, error)
// Deletes a Conversation.
//
// If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to
// delete does not exist, a NOT_FOUND error is returned.
DeleteConversation(ctx context.Context, in *DeleteConversationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates a Conversation.
//
// [Conversation][google.cloud.discoveryengine.v1beta.Conversation] action
// type cannot be changed. If the
// [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to update
// does not exist, a NOT_FOUND error is returned.
UpdateConversation(ctx context.Context, in *UpdateConversationRequest, opts ...grpc.CallOption) (*Conversation, error)
// Gets a Conversation.
GetConversation(ctx context.Context, in *GetConversationRequest, opts ...grpc.CallOption) (*Conversation, error)
// Lists all Conversations by their parent
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
ListConversations(ctx context.Context, in *ListConversationsRequest, opts ...grpc.CallOption) (*ListConversationsResponse, error)
// Answer query method.
AnswerQuery(ctx context.Context, in *AnswerQueryRequest, opts ...grpc.CallOption) (*AnswerQueryResponse, error)
// Answer query method (streaming).
//
// It takes one
// [AnswerQueryRequest][google.cloud.discoveryengine.v1beta.AnswerQueryRequest]
// and returns multiple
// [AnswerQueryResponse][google.cloud.discoveryengine.v1beta.AnswerQueryResponse]
// messages in a stream.
StreamAnswerQuery(ctx context.Context, in *AnswerQueryRequest, opts ...grpc.CallOption) (ConversationalSearchService_StreamAnswerQueryClient, error)
// Gets a Answer.
GetAnswer(ctx context.Context, in *GetAnswerRequest, opts ...grpc.CallOption) (*Answer, error)
// Creates a Session.
//
// If the [Session][google.cloud.discoveryengine.v1beta.Session] to create
// already exists, an ALREADY_EXISTS error is returned.
CreateSession(ctx context.Context, in *CreateSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Deletes a Session.
//
// If the [Session][google.cloud.discoveryengine.v1beta.Session] to delete
// does not exist, a NOT_FOUND error is returned.
DeleteSession(ctx context.Context, in *DeleteSessionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates a Session.
//
// [Session][google.cloud.discoveryengine.v1beta.Session] action type cannot
// be changed. If the [Session][google.cloud.discoveryengine.v1beta.Session]
// to update does not exist, a NOT_FOUND error is returned.
UpdateSession(ctx context.Context, in *UpdateSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Gets a Session.
GetSession(ctx context.Context, in *GetSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Lists all Sessions by their parent
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
ListSessions(ctx context.Context, in *ListSessionsRequest, opts ...grpc.CallOption) (*ListSessionsResponse, error)
}ConversationalSearchServiceClient is the client API for ConversationalSearchService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewConversationalSearchServiceClient
func NewConversationalSearchServiceClient(cc grpc.ClientConnInterface) ConversationalSearchServiceClientConversationalSearchServiceServer
type ConversationalSearchServiceServer interface {
// Converses a conversation.
ConverseConversation(context.Context, *ConverseConversationRequest) (*ConverseConversationResponse, error)
// Creates a Conversation.
//
// If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to
// create already exists, an ALREADY_EXISTS error is returned.
CreateConversation(context.Context, *CreateConversationRequest) (*Conversation, error)
// Deletes a Conversation.
//
// If the [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to
// delete does not exist, a NOT_FOUND error is returned.
DeleteConversation(context.Context, *DeleteConversationRequest) (*emptypb.Empty, error)
// Updates a Conversation.
//
// [Conversation][google.cloud.discoveryengine.v1beta.Conversation] action
// type cannot be changed. If the
// [Conversation][google.cloud.discoveryengine.v1beta.Conversation] to update
// does not exist, a NOT_FOUND error is returned.
UpdateConversation(context.Context, *UpdateConversationRequest) (*Conversation, error)
// Gets a Conversation.
GetConversation(context.Context, *GetConversationRequest) (*Conversation, error)
// Lists all Conversations by their parent
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
ListConversations(context.Context, *ListConversationsRequest) (*ListConversationsResponse, error)
// Answer query method.
AnswerQuery(context.Context, *AnswerQueryRequest) (*AnswerQueryResponse, error)
// Answer query method (streaming).
//
// It takes one
// [AnswerQueryRequest][google.cloud.discoveryengine.v1beta.AnswerQueryRequest]
// and returns multiple
// [AnswerQueryResponse][google.cloud.discoveryengine.v1beta.AnswerQueryResponse]
// messages in a stream.
StreamAnswerQuery(*AnswerQueryRequest, ConversationalSearchService_StreamAnswerQueryServer) error
// Gets a Answer.
GetAnswer(context.Context, *GetAnswerRequest) (*Answer, error)
// Creates a Session.
//
// If the [Session][google.cloud.discoveryengine.v1beta.Session] to create
// already exists, an ALREADY_EXISTS error is returned.
CreateSession(context.Context, *CreateSessionRequest) (*Session, error)
// Deletes a Session.
//
// If the [Session][google.cloud.discoveryengine.v1beta.Session] to delete
// does not exist, a NOT_FOUND error is returned.
DeleteSession(context.Context, *DeleteSessionRequest) (*emptypb.Empty, error)
// Updates a Session.
//
// [Session][google.cloud.discoveryengine.v1beta.Session] action type cannot
// be changed. If the [Session][google.cloud.discoveryengine.v1beta.Session]
// to update does not exist, a NOT_FOUND error is returned.
UpdateSession(context.Context, *UpdateSessionRequest) (*Session, error)
// Gets a Session.
GetSession(context.Context, *GetSessionRequest) (*Session, error)
// Lists all Sessions by their parent
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)
}ConversationalSearchServiceServer is the server API for ConversationalSearchService service. All implementations should embed UnimplementedConversationalSearchServiceServer for forward compatibility
ConversationalSearchService_StreamAnswerQueryClient
type ConversationalSearchService_StreamAnswerQueryClient interface {
Recv() (*AnswerQueryResponse, error)
grpc.ClientStream
}ConversationalSearchService_StreamAnswerQueryServer
type ConversationalSearchService_StreamAnswerQueryServer interface {
Send(*AnswerQueryResponse) error
grpc.ServerStream
}ConverseConversationRequest
type ConverseConversationRequest struct {
// Required. The resource name of the Conversation to get. Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
// Use
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
// to activate auto session mode, which automatically creates a new
// conversation inside a ConverseConversation session.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Current user input.
Query *TextInput `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
// The resource name of the Serving Config to use. Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
// If this is not set, the default serving config will be used.
ServingConfig string `protobuf:"bytes,3,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
// The conversation to be used by auto session only. The name field will be
// ignored as we automatically assign new name for the conversation in auto
// session.
Conversation *Conversation `protobuf:"bytes,5,opt,name=conversation,proto3" json:"conversation,omitempty"`
// Whether to turn on safe search.
SafeSearch bool `protobuf:"varint,6,opt,name=safe_search,json=safeSearch,proto3" json:"safe_search,omitempty"`
// The user labels applied to a resource must meet the following requirements:
//
// - Each resource can have multiple labels, up to a maximum of 64.
// - Each label must be a key-value pair.
// - Keys have a minimum length of 1 character and a maximum length of 63
// characters and cannot be empty. Values can be empty and have a maximum
// length of 63 characters.
// - Keys and values can contain only lowercase letters, numeric characters,
// underscores, and dashes. All characters must use UTF-8 encoding, and
// international characters are allowed.
// - The key portion of a label must be unique. However, you can use the same
// key with multiple resources.
// - Keys must start with a lowercase letter or international character.
//
// See [Google Cloud
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
// for more details.
UserLabels map[string]string `protobuf:"bytes,7,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// A specification for configuring the summary returned in the response.
SummarySpec *SearchRequest_ContentSearchSpec_SummarySpec `protobuf:"bytes,8,opt,name=summary_spec,json=summarySpec,proto3" json:"summary_spec,omitempty"`
// The filter syntax consists of an expression language for constructing a
// predicate from one or more fields of the documents being filtered. Filter
// expression is case-sensitive. This will be used to filter search results
// which may affect the summary response.
//
// If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
//
// Filtering in Vertex AI Search is done by mapping the LHS filter key to a
// key property defined in the Vertex AI Search backend -- this mapping is
// defined by the customer in their schema. For example a media customer might
// have a field 'name' in their schema. In this case the filter would look
// like this: filter --> name:'ANY("king kong")'
//
// For more information about filtering including syntax and filter
// operators, see
// [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
Filter string `protobuf:"bytes,9,opt,name=filter,proto3" json:"filter,omitempty"`
// Boost specification to boost certain documents in search results which may
// affect the converse response. For more information on boosting, see
// [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,10,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
// contains filtered or unexported fields
}Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.
func (*ConverseConversationRequest) Descriptor
func (*ConverseConversationRequest) Descriptor() ([]byte, []int)Deprecated: Use ConverseConversationRequest.ProtoReflect.Descriptor instead.
func (*ConverseConversationRequest) GetBoostSpec
func (x *ConverseConversationRequest) GetBoostSpec() *SearchRequest_BoostSpecfunc (*ConverseConversationRequest) GetConversation
func (x *ConverseConversationRequest) GetConversation() *Conversationfunc (*ConverseConversationRequest) GetFilter
func (x *ConverseConversationRequest) GetFilter() stringfunc (*ConverseConversationRequest) GetName
func (x *ConverseConversationRequest) GetName() stringfunc (*ConverseConversationRequest) GetQuery
func (x *ConverseConversationRequest) GetQuery() *TextInputfunc (*ConverseConversationRequest) GetSafeSearch
func (x *ConverseConversationRequest) GetSafeSearch() boolfunc (*ConverseConversationRequest) GetServingConfig
func (x *ConverseConversationRequest) GetServingConfig() stringfunc (*ConverseConversationRequest) GetSummarySpec
func (x *ConverseConversationRequest) GetSummarySpec() *SearchRequest_ContentSearchSpec_SummarySpecfunc (*ConverseConversationRequest) GetUserLabels
func (x *ConverseConversationRequest) GetUserLabels() map[string]stringfunc (*ConverseConversationRequest) ProtoMessage
func (*ConverseConversationRequest) ProtoMessage()func (*ConverseConversationRequest) ProtoReflect
func (x *ConverseConversationRequest) ProtoReflect() protoreflect.Messagefunc (*ConverseConversationRequest) Reset
func (x *ConverseConversationRequest) Reset()func (*ConverseConversationRequest) String
func (x *ConverseConversationRequest) String() stringConverseConversationResponse
type ConverseConversationResponse struct {
// Answer to the current query.
Reply *Reply `protobuf:"bytes,1,opt,name=reply,proto3" json:"reply,omitempty"`
// Updated conversation including the answer.
Conversation *Conversation `protobuf:"bytes,2,opt,name=conversation,proto3" json:"conversation,omitempty"`
// Suggested related questions.
RelatedQuestions []string `protobuf:"bytes,6,rep,name=related_questions,json=relatedQuestions,proto3" json:"related_questions,omitempty"`
// Search Results.
SearchResults []*SearchResponse_SearchResult `protobuf:"bytes,3,rep,name=search_results,json=searchResults,proto3" json:"search_results,omitempty"`
// contains filtered or unexported fields
}Response message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.
func (*ConverseConversationResponse) Descriptor
func (*ConverseConversationResponse) Descriptor() ([]byte, []int)Deprecated: Use ConverseConversationResponse.ProtoReflect.Descriptor instead.
func (*ConverseConversationResponse) GetConversation
func (x *ConverseConversationResponse) GetConversation() *Conversationfunc (*ConverseConversationResponse) GetRelatedQuestions
func (x *ConverseConversationResponse) GetRelatedQuestions() []stringfunc (*ConverseConversationResponse) GetReply
func (x *ConverseConversationResponse) GetReply() *Replyfunc (*ConverseConversationResponse) GetSearchResults
func (x *ConverseConversationResponse) GetSearchResults() []*SearchResponse_SearchResultfunc (*ConverseConversationResponse) ProtoMessage
func (*ConverseConversationResponse) ProtoMessage()func (*ConverseConversationResponse) ProtoReflect
func (x *ConverseConversationResponse) ProtoReflect() protoreflect.Messagefunc (*ConverseConversationResponse) Reset
func (x *ConverseConversationResponse) Reset()func (*ConverseConversationResponse) String
func (x *ConverseConversationResponse) String() stringCreateAssistantRequest
type CreateAssistantRequest struct {
// Required. The parent resource name.
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Assistant][google.cloud.discoveryengine.v1beta.Assistant] to
// create.
Assistant *Assistant `protobuf:"bytes,2,opt,name=assistant,proto3" json:"assistant,omitempty"`
// Required. The ID to use for the
// [Assistant][google.cloud.discoveryengine.v1beta.Assistant], which will
// become the final component of the
// [Assistant][google.cloud.discoveryengine.v1beta.Assistant]'s resource name.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// with a length limit of 63 characters.
AssistantId string `protobuf:"bytes,3,opt,name=assistant_id,json=assistantId,proto3" json:"assistant_id,omitempty"`
// contains filtered or unexported fields
}Request for the [AssistantService.CreateAssistant][google.cloud.discoveryengine.v1beta.AssistantService.CreateAssistant] method.
func (*CreateAssistantRequest) Descriptor
func (*CreateAssistantRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateAssistantRequest.ProtoReflect.Descriptor instead.
func (*CreateAssistantRequest) GetAssistant
func (x *CreateAssistantRequest) GetAssistant() *Assistantfunc (*CreateAssistantRequest) GetAssistantId
func (x *CreateAssistantRequest) GetAssistantId() stringfunc (*CreateAssistantRequest) GetParent
func (x *CreateAssistantRequest) GetParent() stringfunc (*CreateAssistantRequest) ProtoMessage
func (*CreateAssistantRequest) ProtoMessage()func (*CreateAssistantRequest) ProtoReflect
func (x *CreateAssistantRequest) ProtoReflect() protoreflect.Messagefunc (*CreateAssistantRequest) Reset
func (x *CreateAssistantRequest) Reset()func (*CreateAssistantRequest) String
func (x *CreateAssistantRequest) String() stringCreateControlRequest
type CreateControlRequest struct {
// Required. Full resource name of parent data store. Format:
// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
// or
// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The Control to create.
Control *Control `protobuf:"bytes,2,opt,name=control,proto3" json:"control,omitempty"`
// Required. The ID to use for the Control, which will become the final
// component of the Control's resource name.
//
// This value must be within 1-63 characters.
// Valid characters are /[a-z][0-9]-_/.
ControlId string `protobuf:"bytes,3,opt,name=control_id,json=controlId,proto3" json:"control_id,omitempty"`
// contains filtered or unexported fields
}Request for CreateControl method.
func (*CreateControlRequest) Descriptor
func (*CreateControlRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateControlRequest.ProtoReflect.Descriptor instead.
func (*CreateControlRequest) GetControl
func (x *CreateControlRequest) GetControl() *Controlfunc (*CreateControlRequest) GetControlId
func (x *CreateControlRequest) GetControlId() stringfunc (*CreateControlRequest) GetParent
func (x *CreateControlRequest) GetParent() stringfunc (*CreateControlRequest) ProtoMessage
func (*CreateControlRequest) ProtoMessage()func (*CreateControlRequest) ProtoReflect
func (x *CreateControlRequest) ProtoReflect() protoreflect.Messagefunc (*CreateControlRequest) Reset
func (x *CreateControlRequest) Reset()func (*CreateControlRequest) String
func (x *CreateControlRequest) String() stringCreateConversationRequest
type CreateConversationRequest struct {
// Required. Full resource name of parent data store. Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The conversation to create.
Conversation *Conversation `protobuf:"bytes,2,opt,name=conversation,proto3" json:"conversation,omitempty"`
// contains filtered or unexported fields
}Request for CreateConversation method.
func (*CreateConversationRequest) Descriptor
func (*CreateConversationRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateConversationRequest.ProtoReflect.Descriptor instead.
func (*CreateConversationRequest) GetConversation
func (x *CreateConversationRequest) GetConversation() *Conversationfunc (*CreateConversationRequest) GetParent
func (x *CreateConversationRequest) GetParent() stringfunc (*CreateConversationRequest) ProtoMessage
func (*CreateConversationRequest) ProtoMessage()func (*CreateConversationRequest) ProtoReflect
func (x *CreateConversationRequest) ProtoReflect() protoreflect.Messagefunc (*CreateConversationRequest) Reset
func (x *CreateConversationRequest) Reset()func (*CreateConversationRequest) String
func (x *CreateConversationRequest) String() stringCreateDataStoreMetadata
type CreateDataStoreMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*CreateDataStoreMetadata) Descriptor
func (*CreateDataStoreMetadata) Descriptor() ([]byte, []int)Deprecated: Use CreateDataStoreMetadata.ProtoReflect.Descriptor instead.
func (*CreateDataStoreMetadata) GetCreateTime
func (x *CreateDataStoreMetadata) GetCreateTime() *timestamppb.Timestampfunc (*CreateDataStoreMetadata) GetUpdateTime
func (x *CreateDataStoreMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*CreateDataStoreMetadata) ProtoMessage
func (*CreateDataStoreMetadata) ProtoMessage()func (*CreateDataStoreMetadata) ProtoReflect
func (x *CreateDataStoreMetadata) ProtoReflect() protoreflect.Messagefunc (*CreateDataStoreMetadata) Reset
func (x *CreateDataStoreMetadata) Reset()func (*CreateDataStoreMetadata) String
func (x *CreateDataStoreMetadata) String() stringCreateDataStoreRequest
type CreateDataStoreRequest struct {
// CMEK options for the DataStore. Setting this field will override the
// default CmekConfig if one is set for the project.
//
// Types that are valid to be assigned to CmekOptions:
//
// *CreateDataStoreRequest_CmekConfigName
// *CreateDataStoreRequest_DisableCmek
CmekOptions isCreateDataStoreRequest_CmekOptions `protobuf_oneof:"cmek_options"`
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to
// create.
DataStore *DataStore `protobuf:"bytes,2,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// Required. The ID to use for the
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore], which will
// become the final component of the
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore]'s resource name.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters. Otherwise, an
// INVALID_ARGUMENT error is returned.
DataStoreId string `protobuf:"bytes,3,opt,name=data_store_id,json=dataStoreId,proto3" json:"data_store_id,omitempty"`
// A boolean flag indicating whether user want to directly create an advanced
// data store for site search.
// If the data store is not configured as site
// search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
// be ignored.
CreateAdvancedSiteSearch bool `protobuf:"varint,4,opt,name=create_advanced_site_search,json=createAdvancedSiteSearch,proto3" json:"create_advanced_site_search,omitempty"`
// A boolean flag indicating whether to skip the default schema creation for
// the data store. Only enable this flag if you are certain that the default
// schema is incompatible with your use case.
//
// If set to true, you must manually create a schema for the data store before
// any documents can be ingested.
//
// This flag cannot be specified if `data_store.starting_schema` is specified.
SkipDefaultSchemaCreation bool `protobuf:"varint,7,opt,name=skip_default_schema_creation,json=skipDefaultSchemaCreation,proto3" json:"skip_default_schema_creation,omitempty"`
// contains filtered or unexported fields
}Request for [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] method.
func (*CreateDataStoreRequest) Descriptor
func (*CreateDataStoreRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateDataStoreRequest.ProtoReflect.Descriptor instead.
func (*CreateDataStoreRequest) GetCmekConfigName
func (x *CreateDataStoreRequest) GetCmekConfigName() stringfunc (*CreateDataStoreRequest) GetCmekOptions
func (x *CreateDataStoreRequest) GetCmekOptions() isCreateDataStoreRequest_CmekOptionsfunc (*CreateDataStoreRequest) GetCreateAdvancedSiteSearch
func (x *CreateDataStoreRequest) GetCreateAdvancedSiteSearch() boolfunc (*CreateDataStoreRequest) GetDataStore
func (x *CreateDataStoreRequest) GetDataStore() *DataStorefunc (*CreateDataStoreRequest) GetDataStoreId
func (x *CreateDataStoreRequest) GetDataStoreId() stringfunc (*CreateDataStoreRequest) GetDisableCmek
func (x *CreateDataStoreRequest) GetDisableCmek() boolfunc (*CreateDataStoreRequest) GetParent
func (x *CreateDataStoreRequest) GetParent() stringfunc (*CreateDataStoreRequest) GetSkipDefaultSchemaCreation
func (x *CreateDataStoreRequest) GetSkipDefaultSchemaCreation() boolfunc (*CreateDataStoreRequest) ProtoMessage
func (*CreateDataStoreRequest) ProtoMessage()func (*CreateDataStoreRequest) ProtoReflect
func (x *CreateDataStoreRequest) ProtoReflect() protoreflect.Messagefunc (*CreateDataStoreRequest) Reset
func (x *CreateDataStoreRequest) Reset()func (*CreateDataStoreRequest) String
func (x *CreateDataStoreRequest) String() stringCreateDataStoreRequest_CmekConfigName
type CreateDataStoreRequest_CmekConfigName struct {
// Resource name of the CmekConfig to use for protecting this DataStore.
CmekConfigName string `protobuf:"bytes,5,opt,name=cmek_config_name,json=cmekConfigName,proto3,oneof"`
}CreateDataStoreRequest_DisableCmek
type CreateDataStoreRequest_DisableCmek struct {
// DataStore without CMEK protections. If a default CmekConfig is set for
// the project, setting this field will override the default CmekConfig as
// well.
DisableCmek bool `protobuf:"varint,6,opt,name=disable_cmek,json=disableCmek,proto3,oneof"`
}CreateDocumentRequest
type CreateDocumentRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Document][google.cloud.discoveryengine.v1beta.Document] to
// create.
Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
// Required. The ID to use for the
// [Document][google.cloud.discoveryengine.v1beta.Document], which becomes the
// final component of the
// [Document.name][google.cloud.discoveryengine.v1beta.Document.name].
//
// If the caller does not have permission to create the
// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
// whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// This field must be unique among all
// [Document][google.cloud.discoveryengine.v1beta.Document]s with the same
// [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent].
// Otherwise, an `ALREADY_EXISTS` error is returned.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 128 characters. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
DocumentId string `protobuf:"bytes,3,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument] method.
func (*CreateDocumentRequest) Descriptor
func (*CreateDocumentRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateDocumentRequest.ProtoReflect.Descriptor instead.
func (*CreateDocumentRequest) GetDocument
func (x *CreateDocumentRequest) GetDocument() *Documentfunc (*CreateDocumentRequest) GetDocumentId
func (x *CreateDocumentRequest) GetDocumentId() stringfunc (*CreateDocumentRequest) GetParent
func (x *CreateDocumentRequest) GetParent() stringfunc (*CreateDocumentRequest) ProtoMessage
func (*CreateDocumentRequest) ProtoMessage()func (*CreateDocumentRequest) ProtoReflect
func (x *CreateDocumentRequest) ProtoReflect() protoreflect.Messagefunc (*CreateDocumentRequest) Reset
func (x *CreateDocumentRequest) Reset()func (*CreateDocumentRequest) String
func (x *CreateDocumentRequest) String() stringCreateEngineMetadata
type CreateEngineMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [EngineService.CreateEngine][google.cloud.discoveryengine.v1beta.EngineService.CreateEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*CreateEngineMetadata) Descriptor
func (*CreateEngineMetadata) Descriptor() ([]byte, []int)Deprecated: Use CreateEngineMetadata.ProtoReflect.Descriptor instead.
func (*CreateEngineMetadata) GetCreateTime
func (x *CreateEngineMetadata) GetCreateTime() *timestamppb.Timestampfunc (*CreateEngineMetadata) GetUpdateTime
func (x *CreateEngineMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*CreateEngineMetadata) ProtoMessage
func (*CreateEngineMetadata) ProtoMessage()func (*CreateEngineMetadata) ProtoReflect
func (x *CreateEngineMetadata) ProtoReflect() protoreflect.Messagefunc (*CreateEngineMetadata) Reset
func (x *CreateEngineMetadata) Reset()func (*CreateEngineMetadata) String
func (x *CreateEngineMetadata) String() stringCreateEngineRequest
type CreateEngineRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Engine][google.cloud.discoveryengine.v1beta.Engine] to
// create.
Engine *Engine `protobuf:"bytes,2,opt,name=engine,proto3" json:"engine,omitempty"`
// Required. The ID to use for the
// [Engine][google.cloud.discoveryengine.v1beta.Engine], which will become the
// final component of the
// [Engine][google.cloud.discoveryengine.v1beta.Engine]'s resource name.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters. Otherwise, an
// INVALID_ARGUMENT error is returned.
EngineId string `protobuf:"bytes,3,opt,name=engine_id,json=engineId,proto3" json:"engine_id,omitempty"`
// contains filtered or unexported fields
}Request for [EngineService.CreateEngine][google.cloud.discoveryengine.v1beta.EngineService.CreateEngine] method.
func (*CreateEngineRequest) Descriptor
func (*CreateEngineRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateEngineRequest.ProtoReflect.Descriptor instead.
func (*CreateEngineRequest) GetEngine
func (x *CreateEngineRequest) GetEngine() *Enginefunc (*CreateEngineRequest) GetEngineId
func (x *CreateEngineRequest) GetEngineId() stringfunc (*CreateEngineRequest) GetParent
func (x *CreateEngineRequest) GetParent() stringfunc (*CreateEngineRequest) ProtoMessage
func (*CreateEngineRequest) ProtoMessage()func (*CreateEngineRequest) ProtoReflect
func (x *CreateEngineRequest) ProtoReflect() protoreflect.Messagefunc (*CreateEngineRequest) Reset
func (x *CreateEngineRequest) Reset()func (*CreateEngineRequest) String
func (x *CreateEngineRequest) String() stringCreateEvaluationMetadata
type CreateEvaluationMetadata struct {
// contains filtered or unexported fields
}Metadata for [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] method.
func (*CreateEvaluationMetadata) Descriptor
func (*CreateEvaluationMetadata) Descriptor() ([]byte, []int)Deprecated: Use CreateEvaluationMetadata.ProtoReflect.Descriptor instead.
func (*CreateEvaluationMetadata) ProtoMessage
func (*CreateEvaluationMetadata) ProtoMessage()func (*CreateEvaluationMetadata) ProtoReflect
func (x *CreateEvaluationMetadata) ProtoReflect() protoreflect.Messagefunc (*CreateEvaluationMetadata) Reset
func (x *CreateEvaluationMetadata) Reset()func (*CreateEvaluationMetadata) String
func (x *CreateEvaluationMetadata) String() stringCreateEvaluationRequest
type CreateEvaluationRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]
// to create.
Evaluation *Evaluation `protobuf:"bytes,2,opt,name=evaluation,proto3" json:"evaluation,omitempty"`
// contains filtered or unexported fields
}Request message for [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] method.
func (*CreateEvaluationRequest) Descriptor
func (*CreateEvaluationRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateEvaluationRequest.ProtoReflect.Descriptor instead.
func (*CreateEvaluationRequest) GetEvaluation
func (x *CreateEvaluationRequest) GetEvaluation() *Evaluationfunc (*CreateEvaluationRequest) GetParent
func (x *CreateEvaluationRequest) GetParent() stringfunc (*CreateEvaluationRequest) ProtoMessage
func (*CreateEvaluationRequest) ProtoMessage()func (*CreateEvaluationRequest) ProtoReflect
func (x *CreateEvaluationRequest) ProtoReflect() protoreflect.Messagefunc (*CreateEvaluationRequest) Reset
func (x *CreateEvaluationRequest) Reset()func (*CreateEvaluationRequest) String
func (x *CreateEvaluationRequest) String() stringCreateIdentityMappingStoreRequest
type CreateIdentityMappingStoreRequest struct {
// CMEK options for the Identity Mapping Store. Setting this field will
// override the default CmekConfig if one is set for the project.
//
// Types that are valid to be assigned to CmekOptions:
//
// *CreateIdentityMappingStoreRequest_CmekConfigName
// *CreateIdentityMappingStoreRequest_DisableCmek
CmekOptions isCreateIdentityMappingStoreRequest_CmekOptions `protobuf_oneof:"cmek_options"`
// Required. The parent collection resource name, such as
// `projects/{project}/locations/{location}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The ID of the Identity Mapping Store to create.
//
// The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
// (_), and hyphens (-). The maximum length is 63 characters.
IdentityMappingStoreId string `protobuf:"bytes,2,opt,name=identity_mapping_store_id,json=identityMappingStoreId,proto3" json:"identity_mapping_store_id,omitempty"`
// Required. The Identity Mapping Store to create.
IdentityMappingStore *IdentityMappingStore `protobuf:"bytes,3,opt,name=identity_mapping_store,json=identityMappingStore,proto3" json:"identity_mapping_store,omitempty"`
// contains filtered or unexported fields
}Request message for [IdentityMappingStoreService.CreateIdentityMappingStore][google.cloud.discoveryengine.v1beta.IdentityMappingStoreService.CreateIdentityMappingStore]
func (*CreateIdentityMappingStoreRequest) Descriptor
func (*CreateIdentityMappingStoreRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateIdentityMappingStoreRequest.ProtoReflect.Descriptor instead.
func (*CreateIdentityMappingStoreRequest) GetCmekConfigName
func (x *CreateIdentityMappingStoreRequest) GetCmekConfigName() stringfunc (*CreateIdentityMappingStoreRequest) GetCmekOptions
func (x *CreateIdentityMappingStoreRequest) GetCmekOptions() isCreateIdentityMappingStoreRequest_CmekOptionsfunc (*CreateIdentityMappingStoreRequest) GetDisableCmek
func (x *CreateIdentityMappingStoreRequest) GetDisableCmek() boolfunc (*CreateIdentityMappingStoreRequest) GetIdentityMappingStore
func (x *CreateIdentityMappingStoreRequest) GetIdentityMappingStore() *IdentityMappingStorefunc (*CreateIdentityMappingStoreRequest) GetIdentityMappingStoreId
func (x *CreateIdentityMappingStoreRequest) GetIdentityMappingStoreId() stringfunc (*CreateIdentityMappingStoreRequest) GetParent
func (x *CreateIdentityMappingStoreRequest) GetParent() stringfunc (*CreateIdentityMappingStoreRequest) ProtoMessage
func (*CreateIdentityMappingStoreRequest) ProtoMessage()func (*CreateIdentityMappingStoreRequest) ProtoReflect
func (x *CreateIdentityMappingStoreRequest) ProtoReflect() protoreflect.Messagefunc (*CreateIdentityMappingStoreRequest) Reset
func (x *CreateIdentityMappingStoreRequest) Reset()func (*CreateIdentityMappingStoreRequest) String
func (x *CreateIdentityMappingStoreRequest) String() stringCreateIdentityMappingStoreRequest_CmekConfigName
type CreateIdentityMappingStoreRequest_CmekConfigName struct {
// Resource name of the CmekConfig to use for protecting this Identity
// Mapping Store.
CmekConfigName string `protobuf:"bytes,5,opt,name=cmek_config_name,json=cmekConfigName,proto3,oneof"`
}CreateIdentityMappingStoreRequest_DisableCmek
type CreateIdentityMappingStoreRequest_DisableCmek struct {
// Identity Mapping Store without CMEK protections. If a default CmekConfig
// is set for the project, setting this field will override the default
// CmekConfig as well.
DisableCmek bool `protobuf:"varint,6,opt,name=disable_cmek,json=disableCmek,proto3,oneof"`
}CreateLicenseConfigRequest
type CreateLicenseConfigRequest 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
// [LicenseConfig][google.cloud.discoveryengine.v1beta.LicenseConfig] to
// create.
LicenseConfig *LicenseConfig `protobuf:"bytes,2,opt,name=license_config,json=licenseConfig,proto3" json:"license_config,omitempty"`
// Optional. The ID to use for the
// [LicenseConfig][google.cloud.discoveryengine.v1beta.LicenseConfig], which
// will become the final component of the
// [LicenseConfig][google.cloud.discoveryengine.v1beta.LicenseConfig]'s
// resource name. We are using the tier (product edition) name as the license
// config id such as `search` or `search_and_assistant`.
LicenseConfigId string `protobuf:"bytes,3,opt,name=license_config_id,json=licenseConfigId,proto3" json:"license_config_id,omitempty"`
// contains filtered or unexported fields
}Request message for [LicenseConfigService.CreateLicenseConfig][google.cloud.discoveryengine.v1beta.LicenseConfigService.CreateLicenseConfig] method.
func (*CreateLicenseConfigRequest) Descriptor
func (*CreateLicenseConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateLicenseConfigRequest.ProtoReflect.Descriptor instead.
func (*CreateLicenseConfigRequest) GetLicenseConfig
func (x *CreateLicenseConfigRequest) GetLicenseConfig() *LicenseConfigfunc (*CreateLicenseConfigRequest) GetLicenseConfigId
func (x *CreateLicenseConfigRequest) GetLicenseConfigId() stringfunc (*CreateLicenseConfigRequest) GetParent
func (x *CreateLicenseConfigRequest) GetParent() stringfunc (*CreateLicenseConfigRequest) ProtoMessage
func (*CreateLicenseConfigRequest) ProtoMessage()func (*CreateLicenseConfigRequest) ProtoReflect
func (x *CreateLicenseConfigRequest) ProtoReflect() protoreflect.Messagefunc (*CreateLicenseConfigRequest) Reset
func (x *CreateLicenseConfigRequest) Reset()func (*CreateLicenseConfigRequest) String
func (x *CreateLicenseConfigRequest) String() stringCreateSampleQueryRequest
type CreateSampleQueryRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The
// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] to create.
SampleQuery *SampleQuery `protobuf:"bytes,2,opt,name=sample_query,json=sampleQuery,proto3" json:"sample_query,omitempty"`
// Required. The ID to use for the
// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], which will
// become the final component of the
// [SampleQuery.name][google.cloud.discoveryengine.v1beta.SampleQuery.name].
//
// If the caller does not have permission to create the
// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], regardless
// of whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// This field must be unique among all
// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s with the
// same
// [parent][google.cloud.discoveryengine.v1beta.CreateSampleQueryRequest.parent].
// Otherwise, an `ALREADY_EXISTS` error is returned.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
SampleQueryId string `protobuf:"bytes,3,opt,name=sample_query_id,json=sampleQueryId,proto3" json:"sample_query_id,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.CreateSampleQuery] method.
func (*CreateSampleQueryRequest) Descriptor
func (*CreateSampleQueryRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSampleQueryRequest.ProtoReflect.Descriptor instead.
func (*CreateSampleQueryRequest) GetParent
func (x *CreateSampleQueryRequest) GetParent() stringfunc (*CreateSampleQueryRequest) GetSampleQuery
func (x *CreateSampleQueryRequest) GetSampleQuery() *SampleQueryfunc (*CreateSampleQueryRequest) GetSampleQueryId
func (x *CreateSampleQueryRequest) GetSampleQueryId() stringfunc (*CreateSampleQueryRequest) ProtoMessage
func (*CreateSampleQueryRequest) ProtoMessage()func (*CreateSampleQueryRequest) ProtoReflect
func (x *CreateSampleQueryRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSampleQueryRequest) Reset
func (x *CreateSampleQueryRequest) Reset()func (*CreateSampleQueryRequest) String
func (x *CreateSampleQueryRequest) String() stringCreateSampleQuerySetRequest
type CreateSampleQuerySetRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The
// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to
// create.
SampleQuerySet *SampleQuerySet `protobuf:"bytes,2,opt,name=sample_query_set,json=sampleQuerySet,proto3" json:"sample_query_set,omitempty"`
// Required. The ID to use for the
// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], which
// will become the final component of the
// [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name].
//
// If the caller does not have permission to create the
// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet],
// regardless of whether or not it exists, a `PERMISSION_DENIED` error is
// returned.
//
// This field must be unique among all
// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s with
// the same
// [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.parent].
// Otherwise, an `ALREADY_EXISTS` error is returned.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
SampleQuerySetId string `protobuf:"bytes,3,opt,name=sample_query_set_id,json=sampleQuerySetId,proto3" json:"sample_query_set_id,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.CreateSampleQuerySet] method.
func (*CreateSampleQuerySetRequest) Descriptor
func (*CreateSampleQuerySetRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSampleQuerySetRequest.ProtoReflect.Descriptor instead.
func (*CreateSampleQuerySetRequest) GetParent
func (x *CreateSampleQuerySetRequest) GetParent() stringfunc (*CreateSampleQuerySetRequest) GetSampleQuerySet
func (x *CreateSampleQuerySetRequest) GetSampleQuerySet() *SampleQuerySetfunc (*CreateSampleQuerySetRequest) GetSampleQuerySetId
func (x *CreateSampleQuerySetRequest) GetSampleQuerySetId() stringfunc (*CreateSampleQuerySetRequest) ProtoMessage
func (*CreateSampleQuerySetRequest) ProtoMessage()func (*CreateSampleQuerySetRequest) ProtoReflect
func (x *CreateSampleQuerySetRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSampleQuerySetRequest) Reset
func (x *CreateSampleQuerySetRequest) Reset()func (*CreateSampleQuerySetRequest) String
func (x *CreateSampleQuerySetRequest) String() stringCreateSchemaMetadata
type CreateSchemaMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata for Create Schema LRO.
func (*CreateSchemaMetadata) Descriptor
func (*CreateSchemaMetadata) Descriptor() ([]byte, []int)Deprecated: Use CreateSchemaMetadata.ProtoReflect.Descriptor instead.
func (*CreateSchemaMetadata) GetCreateTime
func (x *CreateSchemaMetadata) GetCreateTime() *timestamppb.Timestampfunc (*CreateSchemaMetadata) GetUpdateTime
func (x *CreateSchemaMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*CreateSchemaMetadata) ProtoMessage
func (*CreateSchemaMetadata) ProtoMessage()func (*CreateSchemaMetadata) ProtoReflect
func (x *CreateSchemaMetadata) ProtoReflect() protoreflect.Messagefunc (*CreateSchemaMetadata) Reset
func (x *CreateSchemaMetadata) Reset()func (*CreateSchemaMetadata) String
func (x *CreateSchemaMetadata) String() stringCreateSchemaRequest
type CreateSchemaRequest struct {
// Required. The parent data store resource name, in the format of
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Schema][google.cloud.discoveryengine.v1beta.Schema] to
// create.
Schema *Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
// Required. The ID to use for the
// [Schema][google.cloud.discoveryengine.v1beta.Schema], which becomes the
// final component of the
// [Schema.name][google.cloud.discoveryengine.v1beta.Schema.name].
//
// This field should conform to
// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
// limit of 63 characters.
SchemaId string `protobuf:"bytes,3,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
// contains filtered or unexported fields
}Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema] method.
func (*CreateSchemaRequest) Descriptor
func (*CreateSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSchemaRequest.ProtoReflect.Descriptor instead.
func (*CreateSchemaRequest) GetParent
func (x *CreateSchemaRequest) GetParent() stringfunc (*CreateSchemaRequest) GetSchema
func (x *CreateSchemaRequest) GetSchema() *Schemafunc (*CreateSchemaRequest) GetSchemaId
func (x *CreateSchemaRequest) GetSchemaId() stringfunc (*CreateSchemaRequest) ProtoMessage
func (*CreateSchemaRequest) ProtoMessage()func (*CreateSchemaRequest) ProtoReflect
func (x *CreateSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSchemaRequest) Reset
func (x *CreateSchemaRequest) Reset()func (*CreateSchemaRequest) String
func (x *CreateSchemaRequest) String() stringCreateServingConfigRequest
type CreateServingConfigRequest struct {
// Required. Full resource name of parent. Format:
// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The ServingConfig to create.
ServingConfig *ServingConfig `protobuf:"bytes,2,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
// Required. The ID to use for the ServingConfig, which will become the final
// component of the ServingConfig's resource name.
//
// This value should be 4-63 characters, and valid characters
// are /[a-zA-Z0-9][a-zA-Z0-9_-]+/.
ServingConfigId string `protobuf:"bytes,3,opt,name=serving_config_id,json=servingConfigId,proto3" json:"serving_config_id,omitempty"`
// contains filtered or unexported fields
}Request for CreateServingConfig method.
func (*CreateServingConfigRequest) Descriptor
func (*CreateServingConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateServingConfigRequest.ProtoReflect.Descriptor instead.
func (*CreateServingConfigRequest) GetParent
func (x *CreateServingConfigRequest) GetParent() stringfunc (*CreateServingConfigRequest) GetServingConfig
func (x *CreateServingConfigRequest) GetServingConfig() *ServingConfigfunc (*CreateServingConfigRequest) GetServingConfigId
func (x *CreateServingConfigRequest) GetServingConfigId() stringfunc (*CreateServingConfigRequest) ProtoMessage
func (*CreateServingConfigRequest) ProtoMessage()func (*CreateServingConfigRequest) ProtoReflect
func (x *CreateServingConfigRequest) ProtoReflect() protoreflect.Messagefunc (*CreateServingConfigRequest) Reset
func (x *CreateServingConfigRequest) Reset()func (*CreateServingConfigRequest) String
func (x *CreateServingConfigRequest) String() stringCreateSessionRequest
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"`
// Optional. The ID to use for the session, which will become the final
// component of the session's resource name.
//
// This value should be 1-63 characters, and valid characters
// are /[a-z0-9][a-z0-9-]{0,61}[a-z0-9]/. If not specified, a unique ID will
// be generated.
SessionId string `protobuf:"bytes,3,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// contains filtered or unexported fields
}Request for CreateSession method.
func (*CreateSessionRequest) Descriptor
func (*CreateSessionRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSessionRequest.ProtoReflect.Descriptor instead.
func (*CreateSessionRequest) GetParent
func (x *CreateSessionRequest) GetParent() stringfunc (*CreateSessionRequest) GetSession
func (x *CreateSessionRequest) GetSession() *Sessionfunc (*CreateSessionRequest) GetSessionId
func (x *CreateSessionRequest) GetSessionId() stringfunc (*CreateSessionRequest) ProtoMessage
func (*CreateSessionRequest) ProtoMessage()func (*CreateSessionRequest) ProtoReflect
func (x *CreateSessionRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSessionRequest) Reset
func (x *CreateSessionRequest) Reset()func (*CreateSessionRequest) String
func (x *CreateSessionRequest) String() stringCreateSitemapMetadata
type CreateSitemapMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateSitemap] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*CreateSitemapMetadata) Descriptor
func (*CreateSitemapMetadata) Descriptor() ([]byte, []int)Deprecated: Use CreateSitemapMetadata.ProtoReflect.Descriptor instead.
func (*CreateSitemapMetadata) GetCreateTime
func (x *CreateSitemapMetadata) GetCreateTime() *timestamppb.Timestampfunc (*CreateSitemapMetadata) GetUpdateTime
func (x *CreateSitemapMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*CreateSitemapMetadata) ProtoMessage
func (*CreateSitemapMetadata) ProtoMessage()func (*CreateSitemapMetadata) ProtoReflect
func (x *CreateSitemapMetadata) ProtoReflect() protoreflect.Messagefunc (*CreateSitemapMetadata) Reset
func (x *CreateSitemapMetadata) Reset()func (*CreateSitemapMetadata) String
func (x *CreateSitemapMetadata) String() stringCreateSitemapRequest
type CreateSitemapRequest struct {
// Required. Parent resource name of the
// [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine],
// such as
// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap] to
// create.
Sitemap *Sitemap `protobuf:"bytes,2,opt,name=sitemap,proto3" json:"sitemap,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateSitemap] method.
func (*CreateSitemapRequest) Descriptor
func (*CreateSitemapRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSitemapRequest.ProtoReflect.Descriptor instead.
func (*CreateSitemapRequest) GetParent
func (x *CreateSitemapRequest) GetParent() stringfunc (*CreateSitemapRequest) GetSitemap
func (x *CreateSitemapRequest) GetSitemap() *Sitemapfunc (*CreateSitemapRequest) ProtoMessage
func (*CreateSitemapRequest) ProtoMessage()func (*CreateSitemapRequest) ProtoReflect
func (x *CreateSitemapRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSitemapRequest) Reset
func (x *CreateSitemapRequest) Reset()func (*CreateSitemapRequest) String
func (x *CreateSitemapRequest) String() stringCreateTargetSiteMetadata
type CreateTargetSiteMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*CreateTargetSiteMetadata) Descriptor
func (*CreateTargetSiteMetadata) Descriptor() ([]byte, []int)Deprecated: Use CreateTargetSiteMetadata.ProtoReflect.Descriptor instead.
func (*CreateTargetSiteMetadata) GetCreateTime
func (x *CreateTargetSiteMetadata) GetCreateTime() *timestamppb.Timestampfunc (*CreateTargetSiteMetadata) GetUpdateTime
func (x *CreateTargetSiteMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*CreateTargetSiteMetadata) ProtoMessage
func (*CreateTargetSiteMetadata) ProtoMessage()func (*CreateTargetSiteMetadata) ProtoReflect
func (x *CreateTargetSiteMetadata) ProtoReflect() protoreflect.Messagefunc (*CreateTargetSiteMetadata) Reset
func (x *CreateTargetSiteMetadata) Reset()func (*CreateTargetSiteMetadata) String
func (x *CreateTargetSiteMetadata) String() stringCreateTargetSiteRequest
type CreateTargetSiteRequest struct {
// Required. Parent resource name of
// [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]
// to create.
TargetSite *TargetSite `protobuf:"bytes,2,opt,name=target_site,json=targetSite,proto3" json:"target_site,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateTargetSite] method.
func (*CreateTargetSiteRequest) Descriptor
func (*CreateTargetSiteRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateTargetSiteRequest.ProtoReflect.Descriptor instead.
func (*CreateTargetSiteRequest) GetParent
func (x *CreateTargetSiteRequest) GetParent() stringfunc (*CreateTargetSiteRequest) GetTargetSite
func (x *CreateTargetSiteRequest) GetTargetSite() *TargetSitefunc (*CreateTargetSiteRequest) ProtoMessage
func (*CreateTargetSiteRequest) ProtoMessage()func (*CreateTargetSiteRequest) ProtoReflect
func (x *CreateTargetSiteRequest) ProtoReflect() protoreflect.Messagefunc (*CreateTargetSiteRequest) Reset
func (x *CreateTargetSiteRequest) Reset()func (*CreateTargetSiteRequest) String
func (x *CreateTargetSiteRequest) String() stringCustomAttribute
type CustomAttribute struct {
// The textual values of this custom attribute. For example, `["yellow",
// "green"]` when the key is "color".
//
// Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is
// returned.
//
// Exactly one of
// [CustomAttribute.text][google.cloud.discoveryengine.v1beta.CustomAttribute.text]
// or
// [CustomAttribute.numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers]
// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
Text []string `protobuf:"bytes,1,rep,name=text,proto3" json:"text,omitempty"`
// The numerical values of this custom attribute. For example, `[2.3, 15.4]`
// when the key is "lengths_cm".
//
// Exactly one of
// [CustomAttribute.text][google.cloud.discoveryengine.v1beta.CustomAttribute.text]
// or
// [CustomAttribute.numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers]
// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
Numbers []float64 `protobuf:"fixed64,2,rep,packed,name=numbers,proto3" json:"numbers,omitempty"`
// contains filtered or unexported fields
}A custom attribute that is not explicitly modeled in a resource, e.g. [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent].
func (*CustomAttribute) Descriptor
func (*CustomAttribute) Descriptor() ([]byte, []int)Deprecated: Use CustomAttribute.ProtoReflect.Descriptor instead.
func (*CustomAttribute) GetNumbers
func (x *CustomAttribute) GetNumbers() []float64func (*CustomAttribute) GetText
func (x *CustomAttribute) GetText() []stringfunc (*CustomAttribute) ProtoMessage
func (*CustomAttribute) ProtoMessage()func (*CustomAttribute) ProtoReflect
func (x *CustomAttribute) ProtoReflect() protoreflect.Messagefunc (*CustomAttribute) Reset
func (x *CustomAttribute) Reset()func (*CustomAttribute) String
func (x *CustomAttribute) String() stringCustomTuningModel
type CustomTuningModel struct {
// Required. The fully qualified resource name of the model.
//
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.
//
// Model must be an alpha-numerical string with limit of 40 characters.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The display name of the model.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The version of the model.
ModelVersion int64 `protobuf:"varint,3,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
// The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
ModelState CustomTuningModel_ModelState `protobuf:"varint,4,opt,name=model_state,json=modelState,proto3,enum=google.cloud.discoveryengine.v1beta.CustomTuningModel_ModelState" json:"model_state,omitempty"`
// Deprecated: Timestamp the Model was created at.
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/custom_tuning_model.proto.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Timestamp the model training was initiated.
TrainingStartTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=training_start_time,json=trainingStartTime,proto3" json:"training_start_time,omitempty"`
// The metrics of the trained model.
Metrics map[string]float64 `protobuf:"bytes,7,rep,name=metrics,proto3" json:"metrics,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"fixed64,2,opt,name=value"`
// Currently this is only populated if the model state is
// `INPUT_VALIDATION_FAILED`.
ErrorMessage string `protobuf:"bytes,8,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// contains filtered or unexported fields
}Metadata that describes a custom tuned model.
func (*CustomTuningModel) Descriptor
func (*CustomTuningModel) Descriptor() ([]byte, []int)Deprecated: Use CustomTuningModel.ProtoReflect.Descriptor instead.
func (*CustomTuningModel) GetCreateTime
func (x *CustomTuningModel) GetCreateTime() *timestamppb.TimestampDeprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/custom_tuning_model.proto.
func (*CustomTuningModel) GetDisplayName
func (x *CustomTuningModel) GetDisplayName() stringfunc (*CustomTuningModel) GetErrorMessage
func (x *CustomTuningModel) GetErrorMessage() stringfunc (*CustomTuningModel) GetMetrics
func (x *CustomTuningModel) GetMetrics() map[string]float64func (*CustomTuningModel) GetModelState
func (x *CustomTuningModel) GetModelState() CustomTuningModel_ModelStatefunc (*CustomTuningModel) GetModelVersion
func (x *CustomTuningModel) GetModelVersion() int64func (*CustomTuningModel) GetName
func (x *CustomTuningModel) GetName() stringfunc (*CustomTuningModel) GetTrainingStartTime
func (x *CustomTuningModel) GetTrainingStartTime() *timestamppb.Timestampfunc (*CustomTuningModel) ProtoMessage
func (*CustomTuningModel) ProtoMessage()func (*CustomTuningModel) ProtoReflect
func (x *CustomTuningModel) ProtoReflect() protoreflect.Messagefunc (*CustomTuningModel) Reset
func (x *CustomTuningModel) Reset()func (*CustomTuningModel) String
func (x *CustomTuningModel) String() stringCustomTuningModel_ModelState
type CustomTuningModel_ModelState int32The state of the model.
CustomTuningModel_MODEL_STATE_UNSPECIFIED, CustomTuningModel_TRAINING_PAUSED, CustomTuningModel_TRAINING, CustomTuningModel_TRAINING_COMPLETE, CustomTuningModel_READY_FOR_SERVING, CustomTuningModel_TRAINING_FAILED, CustomTuningModel_NO_IMPROVEMENT, CustomTuningModel_INPUT_VALIDATION_FAILED
const (
// Default value.
CustomTuningModel_MODEL_STATE_UNSPECIFIED CustomTuningModel_ModelState = 0
// The model is in a paused training state.
CustomTuningModel_TRAINING_PAUSED CustomTuningModel_ModelState = 1
// The model is currently training.
CustomTuningModel_TRAINING CustomTuningModel_ModelState = 2
// The model has successfully completed training.
CustomTuningModel_TRAINING_COMPLETE CustomTuningModel_ModelState = 3
// The model is ready for serving.
CustomTuningModel_READY_FOR_SERVING CustomTuningModel_ModelState = 4
// The model training failed.
CustomTuningModel_TRAINING_FAILED CustomTuningModel_ModelState = 5
// The model training finished successfully but metrics did not improve.
CustomTuningModel_NO_IMPROVEMENT CustomTuningModel_ModelState = 6
// Input data validation failed. Model training didn't start.
CustomTuningModel_INPUT_VALIDATION_FAILED CustomTuningModel_ModelState = 7
)func (CustomTuningModel_ModelState) Descriptor
func (CustomTuningModel_ModelState) Descriptor() protoreflect.EnumDescriptorfunc (CustomTuningModel_ModelState) Enum
func (x CustomTuningModel_ModelState) Enum() *CustomTuningModel_ModelStatefunc (CustomTuningModel_ModelState) EnumDescriptor
func (CustomTuningModel_ModelState) EnumDescriptor() ([]byte, []int)Deprecated: Use CustomTuningModel_ModelState.Descriptor instead.
func (CustomTuningModel_ModelState) Number
func (x CustomTuningModel_ModelState) Number() protoreflect.EnumNumberfunc (CustomTuningModel_ModelState) String
func (x CustomTuningModel_ModelState) String() stringfunc (CustomTuningModel_ModelState) Type
func (CustomTuningModel_ModelState) Type() protoreflect.EnumTypeDataStore
type DataStore struct {
// Immutable. Identifier. The full resource name of the data store.
// Format:
// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The data store display name.
//
// This field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an INVALID_ARGUMENT error is returned.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Immutable. The industry vertical that the data store registers.
IndustryVertical IndustryVertical `protobuf:"varint,3,opt,name=industry_vertical,json=industryVertical,proto3,enum=google.cloud.discoveryengine.v1beta.IndustryVertical" json:"industry_vertical,omitempty"`
// The solutions that the data store enrolls. Available solutions for each
// [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.industry_vertical]:
//
// - `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
// - `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
// solutions cannot be enrolled.
SolutionTypes []SolutionType `protobuf:"varint,5,rep,packed,name=solution_types,json=solutionTypes,proto3,enum=google.cloud.discoveryengine.v1beta.SolutionType" json:"solution_types,omitempty"`
// Output only. The id of the default
// [Schema][google.cloud.discoveryengine.v1beta.Schema] associated to this
// data store.
DefaultSchemaId string `protobuf:"bytes,7,opt,name=default_schema_id,json=defaultSchemaId,proto3" json:"default_schema_id,omitempty"`
// Immutable. The content config of the data store. If this field is unset,
// the server behavior defaults to
// [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.NO_CONTENT].
ContentConfig DataStore_ContentConfig `protobuf:"varint,6,opt,name=content_config,json=contentConfig,proto3,enum=google.cloud.discoveryengine.v1beta.DataStore_ContentConfig" json:"content_config,omitempty"`
// Output only. Timestamp the
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Optional. Configuration for advanced site search.
AdvancedSiteSearchConfig *AdvancedSiteSearchConfig `protobuf:"bytes,12,opt,name=advanced_site_search_config,json=advancedSiteSearchConfig,proto3" json:"advanced_site_search_config,omitempty"`
// Language info for DataStore.
LanguageInfo *LanguageInfo `protobuf:"bytes,14,opt,name=language_info,json=languageInfo,proto3" json:"language_info,omitempty"`
// Optional. Configuration for Natural Language Query Understanding.
NaturalLanguageQueryUnderstandingConfig *NaturalLanguageQueryUnderstandingConfig `protobuf:"bytes,34,opt,name=natural_language_query_understanding_config,json=naturalLanguageQueryUnderstandingConfig,proto3" json:"natural_language_query_understanding_config,omitempty"`
// Input only. The KMS key to be used to protect this DataStore at creation
// time.
//
// Must be set for requests that need to comply with CMEK Org Policy
// protections.
//
// If this field is set and processed successfully, the DataStore will be
// protected by the KMS key, as indicated in the cmek_config field.
KmsKeyName string `protobuf:"bytes,32,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
// Output only. CMEK-related information for the DataStore.
CmekConfig *CmekConfig `protobuf:"bytes,18,opt,name=cmek_config,json=cmekConfig,proto3" json:"cmek_config,omitempty"`
// Output only. Data size estimation for billing.
BillingEstimation *DataStore_BillingEstimation `protobuf:"bytes,23,opt,name=billing_estimation,json=billingEstimation,proto3" json:"billing_estimation,omitempty"`
// Immutable. Whether data in the
// [DataStore][google.cloud.discoveryengine.v1beta.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.v1beta.DocumentService.ImportDocuments]
// methods.
//
// When ACL is enabled for the
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore],
// [Document][google.cloud.discoveryengine.v1beta.Document] can't be accessed
// by calling
// [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
// or
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.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.v1beta.DataStore.content_config]
// is set as
// [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.GOOGLE_WORKSPACE].
WorkspaceConfig *WorkspaceConfig `protobuf:"bytes,25,opt,name=workspace_config,json=workspaceConfig,proto3" json:"workspace_config,omitempty"`
// Configuration for Document understanding and enrichment.
DocumentProcessingConfig *DocumentProcessingConfig `protobuf:"bytes,27,opt,name=document_processing_config,json=documentProcessingConfig,proto3" json:"document_processing_config,omitempty"`
// The start schema to use for this
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore] when
// provisioning it. If unset, a default vertical specialized schema will be
// used.
//
// This field is only used by
// [CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore]
// API, and will be ignored if used in other APIs. This field will be omitted
// from all API responses including
// [CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore]
// API. To retrieve a schema of a
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore], use
// [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema]
// API instead.
//
// The provided schema will be validated against certain rules on schema.
// Learn more from [this
// doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
StartingSchema *Schema `protobuf:"bytes,28,opt,name=starting_schema,json=startingSchema,proto3" json:"starting_schema,omitempty"`
// Optional. Configuration for `HEALTHCARE_FHIR` vertical.
HealthcareFhirConfig *HealthcareFhirConfig `protobuf:"bytes,29,opt,name=healthcare_fhir_config,json=healthcareFhirConfig,proto3" json:"healthcare_fhir_config,omitempty"`
// Optional. Stores serving config at DataStore level.
ServingConfigDataStore *DataStore_ServingConfigDataStore `protobuf:"bytes,30,opt,name=serving_config_data_store,json=servingConfigDataStore,proto3" json:"serving_config_data_store,omitempty"`
// Immutable. The fully qualified resource name of the associated
// [IdentityMappingStore][google.cloud.discoveryengine.v1beta.IdentityMappingStore].
// This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or
// `GSUITE` IdP. Format:
// `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
IdentityMappingStore string `protobuf:"bytes,31,opt,name=identity_mapping_store,json=identityMappingStore,proto3" json:"identity_mapping_store,omitempty"`
// Optional. If set, this DataStore is an Infobot FAQ DataStore.
IsInfobotFaqDataStore bool `protobuf:"varint,37,opt,name=is_infobot_faq_data_store,json=isInfobotFaqDataStore,proto3" json:"is_infobot_faq_data_store,omitempty"`
// Optional. If set, this DataStore is a federated search DataStore.
FederatedSearchConfig *DataStore_FederatedSearchConfig `protobuf:"bytes,38,opt,name=federated_search_config,json=federatedSearchConfig,proto3" json:"federated_search_config,omitempty"`
// Optional. Configuration for configurable billing approach. See
ConfigurableBillingApproach DataStore_ConfigurableBillingApproach `protobuf:"varint,45,opt,name=configurable_billing_approach,json=configurableBillingApproach,proto3,enum=google.cloud.discoveryengine.v1beta.DataStore_ConfigurableBillingApproach" json:"configurable_billing_approach,omitempty"`
// Output only. The timestamp when configurable_billing_approach was last
// updated.
ConfigurableBillingApproachUpdateTime *timestamppb.Timestamp `protobuf:"bytes,46,opt,name=configurable_billing_approach_update_time,json=configurableBillingApproachUpdateTime,proto3" json:"configurable_billing_approach_update_time,omitempty"`
// contains filtered or unexported fields
}DataStore captures global settings and configs at the DataStore level.
func (*DataStore) Descriptor
Deprecated: Use DataStore.ProtoReflect.Descriptor instead.
func (*DataStore) GetAclEnabled
func (*DataStore) GetAdvancedSiteSearchConfig
func (x *DataStore) GetAdvancedSiteSearchConfig() *AdvancedSiteSearchConfigfunc (*DataStore) GetBillingEstimation
func (x *DataStore) GetBillingEstimation() *DataStore_BillingEstimationfunc (*DataStore) GetCmekConfig
func (x *DataStore) GetCmekConfig() *CmekConfigfunc (*DataStore) GetConfigurableBillingApproach
func (x *DataStore) GetConfigurableBillingApproach() DataStore_ConfigurableBillingApproachfunc (*DataStore) GetConfigurableBillingApproachUpdateTime
func (x *DataStore) GetConfigurableBillingApproachUpdateTime() *timestamppb.Timestampfunc (*DataStore) GetContentConfig
func (x *DataStore) GetContentConfig() DataStore_ContentConfigfunc (*DataStore) GetCreateTime
func (x *DataStore) GetCreateTime() *timestamppb.Timestampfunc (*DataStore) GetDefaultSchemaId
func (*DataStore) GetDisplayName
func (*DataStore) GetDocumentProcessingConfig
func (x *DataStore) GetDocumentProcessingConfig() *DocumentProcessingConfigfunc (*DataStore) GetFederatedSearchConfig
func (x *DataStore) GetFederatedSearchConfig() *DataStore_FederatedSearchConfigfunc (*DataStore) GetHealthcareFhirConfig
func (x *DataStore) GetHealthcareFhirConfig() *HealthcareFhirConfigfunc (*DataStore) GetIdentityMappingStore
func (*DataStore) GetIndustryVertical
func (x *DataStore) GetIndustryVertical() IndustryVerticalfunc (*DataStore) GetIsInfobotFaqDataStore
func (*DataStore) GetKmsKeyName
func (*DataStore) GetLanguageInfo
func (x *DataStore) GetLanguageInfo() *LanguageInfofunc (*DataStore) GetName
func (*DataStore) GetNaturalLanguageQueryUnderstandingConfig
func (x *DataStore) GetNaturalLanguageQueryUnderstandingConfig() *NaturalLanguageQueryUnderstandingConfigfunc (*DataStore) GetServingConfigDataStore
func (x *DataStore) GetServingConfigDataStore() *DataStore_ServingConfigDataStorefunc (*DataStore) GetSolutionTypes
func (x *DataStore) GetSolutionTypes() []SolutionTypefunc (*DataStore) GetStartingSchema
func (*DataStore) GetWorkspaceConfig
func (x *DataStore) GetWorkspaceConfig() *WorkspaceConfigfunc (*DataStore) ProtoMessage
func (*DataStore) ProtoMessage()func (*DataStore) ProtoReflect
func (x *DataStore) ProtoReflect() protoreflect.Messagefunc (*DataStore) Reset
func (x *DataStore) Reset()func (*DataStore) String
DataStoreServiceClient
type DataStoreServiceClient interface {
// Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
//
// DataStore is for storing
// [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these
// documents for Search, or Recommendation use case, an
// [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be created
// separately.
CreateDataStore(ctx context.Context, in *CreateDataStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
GetDataStore(ctx context.Context, in *GetDataStoreRequest, opts ...grpc.CallOption) (*DataStore, error)
// Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s
// associated with the project.
ListDataStores(ctx context.Context, in *ListDataStoresRequest, opts ...grpc.CallOption) (*ListDataStoresResponse, error)
// Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
DeleteDataStore(ctx context.Context, in *DeleteDataStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]
UpdateDataStore(ctx context.Context, in *UpdateDataStoreRequest, opts ...grpc.CallOption) (*DataStore, error)
}DataStoreServiceClient is the client API for DataStoreService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewDataStoreServiceClient
func NewDataStoreServiceClient(cc grpc.ClientConnInterface) DataStoreServiceClientDataStoreServiceServer
type DataStoreServiceServer interface {
// Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
//
// DataStore is for storing
// [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these
// documents for Search, or Recommendation use case, an
// [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be created
// separately.
CreateDataStore(context.Context, *CreateDataStoreRequest) (*longrunningpb.Operation, error)
// Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
GetDataStore(context.Context, *GetDataStoreRequest) (*DataStore, error)
// Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s
// associated with the project.
ListDataStores(context.Context, *ListDataStoresRequest) (*ListDataStoresResponse, error)
// Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
DeleteDataStore(context.Context, *DeleteDataStoreRequest) (*longrunningpb.Operation, error)
// Updates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]
UpdateDataStore(context.Context, *UpdateDataStoreRequest) (*DataStore, error)
}DataStoreServiceServer is the server API for DataStoreService service. All implementations should embed UnimplementedDataStoreServiceServer for forward compatibility
DataStore_BillingEstimation
type DataStore_BillingEstimation struct {
// Data size for structured data in terms of bytes.
StructuredDataSize int64 `protobuf:"varint,1,opt,name=structured_data_size,json=structuredDataSize,proto3" json:"structured_data_size,omitempty"`
// Data size for unstructured data in terms of bytes.
UnstructuredDataSize int64 `protobuf:"varint,2,opt,name=unstructured_data_size,json=unstructuredDataSize,proto3" json:"unstructured_data_size,omitempty"`
// Data size for websites in terms of bytes.
WebsiteDataSize int64 `protobuf:"varint,3,opt,name=website_data_size,json=websiteDataSize,proto3" json:"website_data_size,omitempty"`
// Last updated timestamp for structured data.
StructuredDataUpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=structured_data_update_time,json=structuredDataUpdateTime,proto3" json:"structured_data_update_time,omitempty"`
// Last updated timestamp for unstructured data.
UnstructuredDataUpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=unstructured_data_update_time,json=unstructuredDataUpdateTime,proto3" json:"unstructured_data_update_time,omitempty"`
// Last updated timestamp for websites.
WebsiteDataUpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=website_data_update_time,json=websiteDataUpdateTime,proto3" json:"website_data_update_time,omitempty"`
// contains filtered or unexported fields
}Estimation of data size per data store.
func (*DataStore_BillingEstimation) Descriptor
func (*DataStore_BillingEstimation) Descriptor() ([]byte, []int)Deprecated: Use DataStore_BillingEstimation.ProtoReflect.Descriptor instead.
func (*DataStore_BillingEstimation) GetStructuredDataSize
func (x *DataStore_BillingEstimation) GetStructuredDataSize() int64func (*DataStore_BillingEstimation) GetStructuredDataUpdateTime
func (x *DataStore_BillingEstimation) GetStructuredDataUpdateTime() *timestamppb.Timestampfunc (*DataStore_BillingEstimation) GetUnstructuredDataSize
func (x *DataStore_BillingEstimation) GetUnstructuredDataSize() int64func (*DataStore_BillingEstimation) GetUnstructuredDataUpdateTime
func (x *DataStore_BillingEstimation) GetUnstructuredDataUpdateTime() *timestamppb.Timestampfunc (*DataStore_BillingEstimation) GetWebsiteDataSize
func (x *DataStore_BillingEstimation) GetWebsiteDataSize() int64func (*DataStore_BillingEstimation) GetWebsiteDataUpdateTime
func (x *DataStore_BillingEstimation) GetWebsiteDataUpdateTime() *timestamppb.Timestampfunc (*DataStore_BillingEstimation) ProtoMessage
func (*DataStore_BillingEstimation) ProtoMessage()func (*DataStore_BillingEstimation) ProtoReflect
func (x *DataStore_BillingEstimation) ProtoReflect() protoreflect.Messagefunc (*DataStore_BillingEstimation) Reset
func (x *DataStore_BillingEstimation) Reset()func (*DataStore_BillingEstimation) String
func (x *DataStore_BillingEstimation) String() stringDataStore_ConfigurableBillingApproach
type DataStore_ConfigurableBillingApproach int32Configuration for configurable billing approach.
DataStore_CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED, DataStore_CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE, DataStore_CONFIGURABLE_CONSUMPTION_EMBEDDING
const (
// Default value. For Spark and non-Spark non-configurable billing approach.
DataStore_CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED DataStore_ConfigurableBillingApproach = 0
// Use the subscription base + overage billing for indexing core for non
// embedding storage.
DataStore_CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE DataStore_ConfigurableBillingApproach = 1
// Use the consumption pay-as-you-go billing for embedding storage add-on.
DataStore_CONFIGURABLE_CONSUMPTION_EMBEDDING DataStore_ConfigurableBillingApproach = 2
)func (DataStore_ConfigurableBillingApproach) Descriptor
func (DataStore_ConfigurableBillingApproach) Descriptor() protoreflect.EnumDescriptorfunc (DataStore_ConfigurableBillingApproach) Enum
func (DataStore_ConfigurableBillingApproach) EnumDescriptor
func (DataStore_ConfigurableBillingApproach) EnumDescriptor() ([]byte, []int)Deprecated: Use DataStore_ConfigurableBillingApproach.Descriptor instead.
func (DataStore_ConfigurableBillingApproach) Number
func (x DataStore_ConfigurableBillingApproach) Number() protoreflect.EnumNumberfunc (DataStore_ConfigurableBillingApproach) String
func (x DataStore_ConfigurableBillingApproach) String() stringfunc (DataStore_ConfigurableBillingApproach) Type
func (DataStore_ConfigurableBillingApproach) Type() protoreflect.EnumTypeDataStore_ContentConfig
type DataStore_ContentConfig int32Content config of the data store.
DataStore_CONTENT_CONFIG_UNSPECIFIED, DataStore_NO_CONTENT, DataStore_CONTENT_REQUIRED, DataStore_PUBLIC_WEBSITE, DataStore_GOOGLE_WORKSPACE
const (
// Default value.
DataStore_CONTENT_CONFIG_UNSPECIFIED DataStore_ContentConfig = 0
// Only contains documents without any
// [Document.content][google.cloud.discoveryengine.v1beta.Document.content].
DataStore_NO_CONTENT DataStore_ContentConfig = 1
// Only contains documents with
// [Document.content][google.cloud.discoveryengine.v1beta.Document.content].
DataStore_CONTENT_REQUIRED DataStore_ContentConfig = 2
// The data store is used for public website search.
DataStore_PUBLIC_WEBSITE DataStore_ContentConfig = 3
// The data store is used for workspace search. Details of workspace
// data store are specified in the
// [WorkspaceConfig][google.cloud.discoveryengine.v1beta.WorkspaceConfig].
DataStore_GOOGLE_WORKSPACE DataStore_ContentConfig = 4
)func (DataStore_ContentConfig) Descriptor
func (DataStore_ContentConfig) Descriptor() protoreflect.EnumDescriptorfunc (DataStore_ContentConfig) Enum
func (x DataStore_ContentConfig) Enum() *DataStore_ContentConfigfunc (DataStore_ContentConfig) EnumDescriptor
func (DataStore_ContentConfig) EnumDescriptor() ([]byte, []int)Deprecated: Use DataStore_ContentConfig.Descriptor instead.
func (DataStore_ContentConfig) Number
func (x DataStore_ContentConfig) Number() protoreflect.EnumNumberfunc (DataStore_ContentConfig) String
func (x DataStore_ContentConfig) String() stringfunc (DataStore_ContentConfig) Type
func (DataStore_ContentConfig) Type() protoreflect.EnumTypeDataStore_FederatedSearchConfig
type DataStore_FederatedSearchConfig struct {
// Configuration for the data source this data store is connected to.
//
// Types that are valid to be assigned to DataSourceConfig:
//
// *DataStore_FederatedSearchConfig_AlloyDbConfig_
// *DataStore_FederatedSearchConfig_ThirdPartyOauthConfig_
// *DataStore_FederatedSearchConfig_NotebooklmConfig_
DataSourceConfig isDataStore_FederatedSearchConfig_DataSourceConfig `protobuf_oneof:"data_source_config"`
// contains filtered or unexported fields
}Stores information for federated search.
func (*DataStore_FederatedSearchConfig) Descriptor
func (*DataStore_FederatedSearchConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStore_FederatedSearchConfig.ProtoReflect.Descriptor instead.
func (*DataStore_FederatedSearchConfig) GetAlloyDbConfig
func (x *DataStore_FederatedSearchConfig) GetAlloyDbConfig() *DataStore_FederatedSearchConfig_AlloyDbConfigfunc (*DataStore_FederatedSearchConfig) GetDataSourceConfig
func (x *DataStore_FederatedSearchConfig) GetDataSourceConfig() isDataStore_FederatedSearchConfig_DataSourceConfigfunc (*DataStore_FederatedSearchConfig) GetNotebooklmConfig
func (x *DataStore_FederatedSearchConfig) GetNotebooklmConfig() *DataStore_FederatedSearchConfig_NotebooklmConfigfunc (*DataStore_FederatedSearchConfig) GetThirdPartyOauthConfig
func (x *DataStore_FederatedSearchConfig) GetThirdPartyOauthConfig() *DataStore_FederatedSearchConfig_ThirdPartyOauthConfigfunc (*DataStore_FederatedSearchConfig) ProtoMessage
func (*DataStore_FederatedSearchConfig) ProtoMessage()func (*DataStore_FederatedSearchConfig) ProtoReflect
func (x *DataStore_FederatedSearchConfig) ProtoReflect() protoreflect.Messagefunc (*DataStore_FederatedSearchConfig) Reset
func (x *DataStore_FederatedSearchConfig) Reset()func (*DataStore_FederatedSearchConfig) String
func (x *DataStore_FederatedSearchConfig) String() stringDataStore_FederatedSearchConfig_AlloyDbConfig
type DataStore_FederatedSearchConfig_AlloyDbConfig struct {
// Required. Configuration for connecting to AlloyDB.
AlloydbConnectionConfig *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig `protobuf:"bytes,1,opt,name=alloydb_connection_config,json=alloydbConnectionConfig,proto3" json:"alloydb_connection_config,omitempty"`
// Optional. Configuration for Magic.
AlloydbAiNlConfig *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig `protobuf:"bytes,2,opt,name=alloydb_ai_nl_config,json=alloydbAiNlConfig,proto3" json:"alloydb_ai_nl_config,omitempty"`
// Optional. Fields to be returned in the search results. If empty, all
// fields will be returned.
ReturnedFields []string `protobuf:"bytes,3,rep,name=returned_fields,json=returnedFields,proto3" json:"returned_fields,omitempty"`
// contains filtered or unexported fields
}Stores information for connecting to AlloyDB.
func (*DataStore_FederatedSearchConfig_AlloyDbConfig) Descriptor
func (*DataStore_FederatedSearchConfig_AlloyDbConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStore_FederatedSearchConfig_AlloyDbConfig.ProtoReflect.Descriptor instead.
func (*DataStore_FederatedSearchConfig_AlloyDbConfig) GetAlloydbAiNlConfig
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig) GetAlloydbAiNlConfig() *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfigfunc (*DataStore_FederatedSearchConfig_AlloyDbConfig) GetAlloydbConnectionConfig
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig) GetAlloydbConnectionConfig() *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfigfunc (*DataStore_FederatedSearchConfig_AlloyDbConfig) GetReturnedFields
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig) GetReturnedFields() []stringfunc (*DataStore_FederatedSearchConfig_AlloyDbConfig) ProtoMessage
func (*DataStore_FederatedSearchConfig_AlloyDbConfig) ProtoMessage()func (*DataStore_FederatedSearchConfig_AlloyDbConfig) ProtoReflect
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig) ProtoReflect() protoreflect.Messagefunc (*DataStore_FederatedSearchConfig_AlloyDbConfig) Reset
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig) Reset()func (*DataStore_FederatedSearchConfig_AlloyDbConfig) String
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig) String() stringDataStore_FederatedSearchConfig_AlloyDbConfig_
type DataStore_FederatedSearchConfig_AlloyDbConfig_ struct {
// AlloyDB config. If set, this DataStore is connected to AlloyDB.
AlloyDbConfig *DataStore_FederatedSearchConfig_AlloyDbConfig `protobuf:"bytes,1,opt,name=alloy_db_config,json=alloyDbConfig,proto3,oneof"`
}DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig
type DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig struct {
// Optional. AlloyDb AI NL config id, i.e. the value that was used for
// calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be
// empty.
NlConfigId string `protobuf:"bytes,1,opt,name=nl_config_id,json=nlConfigId,proto3" json:"nl_config_id,omitempty"`
// contains filtered or unexported fields
}Configuration for AlloyDB AI Natural Language.
func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) Descriptor
func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig.ProtoReflect.Descriptor instead.
func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) GetNlConfigId
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) GetNlConfigId() stringfunc (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) ProtoMessage
func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) ProtoMessage()func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) ProtoReflect
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) ProtoReflect() protoreflect.Messagefunc (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) Reset
func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) String
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbAiNaturalLanguageConfig) String() stringDataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig
type DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig struct {
// Required. The AlloyDB instance to connect to.
Instance string `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
// Required. The AlloyDB database to connect to.
Database string `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`
// Required. Database user.
//
// If auth_mode = END_USER_ACCOUNT, it can be unset. In that case,
// the user will be inferred on the AlloyDB side, based on the
// authenticated user.
User string `protobuf:"bytes,3,opt,name=user,proto3" json:"user,omitempty"`
// Required. Database password.
//
// If auth_mode = END_USER_ACCOUNT, it can be unset. In that case,
// the password will be inferred on the AlloyDB side, based on the
// authenticated user.
Password string `protobuf:"bytes,4,opt,name=password,proto3" json:"password,omitempty"`
// Optional. Auth mode.
AuthMode DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode `protobuf:"varint,5,opt,name=auth_mode,json=authMode,proto3,enum=google.cloud.discoveryengine.v1beta.DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode" json:"auth_mode,omitempty"`
// Optional. If true, enable PSVS for AlloyDB.
EnablePsvs bool `protobuf:"varint,6,opt,name=enable_psvs,json=enablePsvs,proto3" json:"enable_psvs,omitempty"`
// contains filtered or unexported fields
}Configuration for connecting to AlloyDB.
func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) Descriptor
func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig.ProtoReflect.Descriptor instead.
func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetAuthMode
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetAuthMode() DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthModefunc (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetDatabase
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetDatabase() stringfunc (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetEnablePsvs
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetEnablePsvs() boolfunc (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetInstance
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetInstance() stringfunc (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetPassword
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetPassword() stringfunc (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetUser
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) GetUser() stringfunc (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) ProtoMessage
func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) ProtoMessage()func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) ProtoReflect
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) ProtoReflect() protoreflect.Messagefunc (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) Reset
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) Reset()func (*DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) String
func (x *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig) String() stringDataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode
type DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode int32Auth mode.
DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AUTH_MODE_UNSPECIFIED, DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AUTH_MODE_SERVICE_ACCOUNT, DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AUTH_MODE_END_USER_ACCOUNT
const (
DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AUTH_MODE_UNSPECIFIED DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode = 0
// Uses P4SA when VAIS talks to AlloyDB.
DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AUTH_MODE_SERVICE_ACCOUNT DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode = 1
// Uses EUC when VAIS talks to AlloyDB.
DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AUTH_MODE_END_USER_ACCOUNT DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode = 2
)func (DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) Descriptor
func (DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) Descriptor() protoreflect.EnumDescriptorfunc (DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) Enum
func (x DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) Enum() *DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthModefunc (DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) EnumDescriptor
func (DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) EnumDescriptor() ([]byte, []int)Deprecated: Use DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode.Descriptor instead.
func (DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) Number
func (x DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) Number() protoreflect.EnumNumberfunc (DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) String
func (x DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) String() stringfunc (DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) Type
func (DataStore_FederatedSearchConfig_AlloyDbConfig_AlloyDbConnectionConfig_AuthMode) Type() protoreflect.EnumTypeDataStore_FederatedSearchConfig_NotebooklmConfig
type DataStore_FederatedSearchConfig_NotebooklmConfig struct {
// Required. Search config name.
//
// Format: projects/*/locations/global/notebookLmSearchConfigs/*
SearchConfig string `protobuf:"bytes,1,opt,name=search_config,json=searchConfig,proto3" json:"search_config,omitempty"`
// contains filtered or unexported fields
}Config for connecting to NotebookLM Enterprise.
func (*DataStore_FederatedSearchConfig_NotebooklmConfig) Descriptor
func (*DataStore_FederatedSearchConfig_NotebooklmConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStore_FederatedSearchConfig_NotebooklmConfig.ProtoReflect.Descriptor instead.
func (*DataStore_FederatedSearchConfig_NotebooklmConfig) GetSearchConfig
func (x *DataStore_FederatedSearchConfig_NotebooklmConfig) GetSearchConfig() stringfunc (*DataStore_FederatedSearchConfig_NotebooklmConfig) ProtoMessage
func (*DataStore_FederatedSearchConfig_NotebooklmConfig) ProtoMessage()func (*DataStore_FederatedSearchConfig_NotebooklmConfig) ProtoReflect
func (x *DataStore_FederatedSearchConfig_NotebooklmConfig) ProtoReflect() protoreflect.Messagefunc (*DataStore_FederatedSearchConfig_NotebooklmConfig) Reset
func (x *DataStore_FederatedSearchConfig_NotebooklmConfig) Reset()func (*DataStore_FederatedSearchConfig_NotebooklmConfig) String
func (x *DataStore_FederatedSearchConfig_NotebooklmConfig) String() stringDataStore_FederatedSearchConfig_NotebooklmConfig_
type DataStore_FederatedSearchConfig_NotebooklmConfig_ struct {
// NotebookLM config. If set, this DataStore is connected to
// NotebookLM Enterprise.
NotebooklmConfig *DataStore_FederatedSearchConfig_NotebooklmConfig `protobuf:"bytes,3,opt,name=notebooklm_config,json=notebooklmConfig,proto3,oneof"`
}DataStore_FederatedSearchConfig_ThirdPartyOauthConfig
type DataStore_FederatedSearchConfig_ThirdPartyOauthConfig struct {
// Optional. The type of the application. E.g., "jira", "box", etc.
AppName string `protobuf:"bytes,1,opt,name=app_name,json=appName,proto3" json:"app_name,omitempty"`
// Optional. The instance name identifying the 3P app, e.g.,
// "vaissptbots-my". This is different from the instance_uri which is the
// full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com".
InstanceName string `protobuf:"bytes,2,opt,name=instance_name,json=instanceName,proto3" json:"instance_name,omitempty"`
// contains filtered or unexported fields
}Stores information for third party applicationOAuth.
func (*DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) Descriptor
func (*DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStore_FederatedSearchConfig_ThirdPartyOauthConfig.ProtoReflect.Descriptor instead.
func (*DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) GetAppName
func (x *DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) GetAppName() stringfunc (*DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) GetInstanceName
func (x *DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) GetInstanceName() stringfunc (*DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) ProtoMessage
func (*DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) ProtoMessage()func (*DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) ProtoReflect
func (x *DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) ProtoReflect() protoreflect.Messagefunc (*DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) Reset
func (x *DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) Reset()func (*DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) String
func (x *DataStore_FederatedSearchConfig_ThirdPartyOauthConfig) String() stringDataStore_FederatedSearchConfig_ThirdPartyOauthConfig_
type DataStore_FederatedSearchConfig_ThirdPartyOauthConfig_ struct {
// Third Party OAuth config. If set, this DataStore is connected to a
// third party application.
ThirdPartyOauthConfig *DataStore_FederatedSearchConfig_ThirdPartyOauthConfig `protobuf:"bytes,2,opt,name=third_party_oauth_config,json=thirdPartyOauthConfig,proto3,oneof"`
}DataStore_ServingConfigDataStore
type DataStore_ServingConfigDataStore struct {
// Optional. If set true, the DataStore will not be available for serving
// search requests.
DisabledForServing bool `protobuf:"varint,1,opt,name=disabled_for_serving,json=disabledForServing,proto3" json:"disabled_for_serving,omitempty"`
// contains filtered or unexported fields
}Stores information regarding the serving configurations at DataStore level.
func (*DataStore_ServingConfigDataStore) Descriptor
func (*DataStore_ServingConfigDataStore) Descriptor() ([]byte, []int)Deprecated: Use DataStore_ServingConfigDataStore.ProtoReflect.Descriptor instead.
func (*DataStore_ServingConfigDataStore) GetDisabledForServing
func (x *DataStore_ServingConfigDataStore) GetDisabledForServing() boolfunc (*DataStore_ServingConfigDataStore) ProtoMessage
func (*DataStore_ServingConfigDataStore) ProtoMessage()func (*DataStore_ServingConfigDataStore) ProtoReflect
func (x *DataStore_ServingConfigDataStore) ProtoReflect() protoreflect.Messagefunc (*DataStore_ServingConfigDataStore) Reset
func (x *DataStore_ServingConfigDataStore) Reset()func (*DataStore_ServingConfigDataStore) String
func (x *DataStore_ServingConfigDataStore) String() stringDeleteAssistantRequest
type DeleteAssistantRequest struct {
// Required. Resource name of
// [Assistant][google.cloud.discoveryengine.v1beta.Assistant]. Format:
// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
//
// If the caller does not have permission to delete the
// [Assistant][google.cloud.discoveryengine.v1beta.Assistant], regardless of
// whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the [Assistant][google.cloud.discoveryengine.v1beta.Assistant] 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 the [AssistantService.DeleteAssistant][google.cloud.discoveryengine.v1beta.AssistantService.DeleteAssistant] method.
func (*DeleteAssistantRequest) Descriptor
func (*DeleteAssistantRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteAssistantRequest.ProtoReflect.Descriptor instead.
func (*DeleteAssistantRequest) GetName
func (x *DeleteAssistantRequest) GetName() stringfunc (*DeleteAssistantRequest) ProtoMessage
func (*DeleteAssistantRequest) ProtoMessage()func (*DeleteAssistantRequest) ProtoReflect
func (x *DeleteAssistantRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteAssistantRequest) Reset
func (x *DeleteAssistantRequest) Reset()func (*DeleteAssistantRequest) String
func (x *DeleteAssistantRequest) String() stringDeleteCmekConfigMetadata
type DeleteCmekConfigMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1beta.CmekConfigService.DeleteCmekConfig] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*DeleteCmekConfigMetadata) Descriptor
func (*DeleteCmekConfigMetadata) Descriptor() ([]byte, []int)Deprecated: Use DeleteCmekConfigMetadata.ProtoReflect.Descriptor instead.
func (*DeleteCmekConfigMetadata) GetCreateTime
func (x *DeleteCmekConfigMetadata) GetCreateTime() *timestamppb.Timestampfunc (*DeleteCmekConfigMetadata) GetUpdateTime
func (x *DeleteCmekConfigMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*DeleteCmekConfigMetadata) ProtoMessage
func (*DeleteCmekConfigMetadata) ProtoMessage()func (*DeleteCmekConfigMetadata) ProtoReflect
func (x *DeleteCmekConfigMetadata) ProtoReflect() protoreflect.Messagefunc (*DeleteCmekConfigMetadata) Reset
func (x *DeleteCmekConfigMetadata) Reset()func (*DeleteCmekConfigMetadata) String
func (x *DeleteCmekConfigMetadata) String() stringDeleteCmekConfigRequest
type DeleteCmekConfigRequest struct {
// Required. The resource name of the
// [CmekConfig][google.cloud.discoveryengine.v1beta.CmekConfig] to delete,
// such as
// `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1beta.CmekConfigService.DeleteCmekConfig] method.
func (*DeleteCmekConfigRequest) Descriptor
func (*DeleteCmekConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteCmekConfigRequest.ProtoReflect.Descriptor instead.
func (*DeleteCmekConfigRequest) GetName
func (x *DeleteCmekConfigRequest) GetName() stringfunc (*DeleteCmekConfigRequest) ProtoMessage
func (*DeleteCmekConfigRequest) ProtoMessage()func (*DeleteCmekConfigRequest) ProtoReflect
func (x *DeleteCmekConfigRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteCmekConfigRequest) Reset
func (x *DeleteCmekConfigRequest) Reset()func (*DeleteCmekConfigRequest) String
func (x *DeleteCmekConfigRequest) String() stringDeleteControlRequest
type DeleteControlRequest struct {
// Required. The resource name of the Control to delete. Format:
// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for DeleteControl method.
func (*DeleteControlRequest) Descriptor
func (*DeleteControlRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteControlRequest.ProtoReflect.Descriptor instead.
func (*DeleteControlRequest) GetName
func (x *DeleteControlRequest) GetName() stringfunc (*DeleteControlRequest) ProtoMessage
func (*DeleteControlRequest) ProtoMessage()func (*DeleteControlRequest) ProtoReflect
func (x *DeleteControlRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteControlRequest) Reset
func (x *DeleteControlRequest) Reset()func (*DeleteControlRequest) String
func (x *DeleteControlRequest) String() stringDeleteConversationRequest
type DeleteConversationRequest struct {
// Required. The resource name of the Conversation to delete. Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for DeleteConversation method.
func (*DeleteConversationRequest) Descriptor
func (*DeleteConversationRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteConversationRequest.ProtoReflect.Descriptor instead.
func (*DeleteConversationRequest) GetName
func (x *DeleteConversationRequest) GetName() stringfunc (*DeleteConversationRequest) ProtoMessage
func (*DeleteConversationRequest) ProtoMessage()func (*DeleteConversationRequest) ProtoReflect
func (x *DeleteConversationRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteConversationRequest) Reset
func (x *DeleteConversationRequest) Reset()func (*DeleteConversationRequest) String
func (x *DeleteConversationRequest) String() stringDeleteDataStoreMetadata
type DeleteDataStoreMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*DeleteDataStoreMetadata) Descriptor
func (*DeleteDataStoreMetadata) Descriptor() ([]byte, []int)Deprecated: Use DeleteDataStoreMetadata.ProtoReflect.Descriptor instead.
func (*DeleteDataStoreMetadata) GetCreateTime
func (x *DeleteDataStoreMetadata) GetCreateTime() *timestamppb.Timestampfunc (*DeleteDataStoreMetadata) GetUpdateTime
func (x *DeleteDataStoreMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*DeleteDataStoreMetadata) ProtoMessage
func (*DeleteDataStoreMetadata) ProtoMessage()func (*DeleteDataStoreMetadata) ProtoReflect
func (x *DeleteDataStoreMetadata) ProtoReflect() protoreflect.Messagefunc (*DeleteDataStoreMetadata) Reset
func (x *DeleteDataStoreMetadata) Reset()func (*DeleteDataStoreMetadata) String
func (x *DeleteDataStoreMetadata) String() stringDeleteDataStoreRequest
type DeleteDataStoreRequest struct {
// Required. Full resource name of
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as
// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
//
// If the caller does not have permission to delete the
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore], regardless of
// whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to delete
// does not exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore] method.
func (*DeleteDataStoreRequest) Descriptor
func (*DeleteDataStoreRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteDataStoreRequest.ProtoReflect.Descriptor instead.
func (*DeleteDataStoreRequest) GetName
func (x *DeleteDataStoreRequest) GetName() stringfunc (*DeleteDataStoreRequest) ProtoMessage
func (*DeleteDataStoreRequest) ProtoMessage()func (*DeleteDataStoreRequest) ProtoReflect
func (x *DeleteDataStoreRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteDataStoreRequest) Reset
func (x *DeleteDataStoreRequest) Reset()func (*DeleteDataStoreRequest) String
func (x *DeleteDataStoreRequest) String() stringDeleteDocumentRequest
type DeleteDocumentRequest struct {
// Required. Full resource name of
// [Document][google.cloud.discoveryengine.v1beta.Document], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
//
// If the caller does not have permission to delete the
// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
// whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// If the [Document][google.cloud.discoveryengine.v1beta.Document] to delete
// does not exist, a `NOT_FOUND` error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument] method.
func (*DeleteDocumentRequest) Descriptor
func (*DeleteDocumentRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.
func (*DeleteDocumentRequest) GetName
func (x *DeleteDocumentRequest) GetName() stringfunc (*DeleteDocumentRequest) ProtoMessage
func (*DeleteDocumentRequest) ProtoMessage()func (*DeleteDocumentRequest) ProtoReflect
func (x *DeleteDocumentRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteDocumentRequest) Reset
func (x *DeleteDocumentRequest) Reset()func (*DeleteDocumentRequest) String
func (x *DeleteDocumentRequest) String() stringDeleteEngineMetadata
type DeleteEngineMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [EngineService.DeleteEngine][google.cloud.discoveryengine.v1beta.EngineService.DeleteEngine] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*DeleteEngineMetadata) Descriptor
func (*DeleteEngineMetadata) Descriptor() ([]byte, []int)Deprecated: Use DeleteEngineMetadata.ProtoReflect.Descriptor instead.
func (*DeleteEngineMetadata) GetCreateTime
func (x *DeleteEngineMetadata) GetCreateTime() *timestamppb.Timestampfunc (*DeleteEngineMetadata) GetUpdateTime
func (x *DeleteEngineMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*DeleteEngineMetadata) ProtoMessage
func (*DeleteEngineMetadata) ProtoMessage()func (*DeleteEngineMetadata) ProtoReflect
func (x *DeleteEngineMetadata) ProtoReflect() protoreflect.Messagefunc (*DeleteEngineMetadata) Reset
func (x *DeleteEngineMetadata) Reset()func (*DeleteEngineMetadata) String
func (x *DeleteEngineMetadata) String() stringDeleteEngineRequest
type DeleteEngineRequest struct {
// Required. Full resource name of
// [Engine][google.cloud.discoveryengine.v1beta.Engine], such as
// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
//
// If the caller does not have permission to delete the
// [Engine][google.cloud.discoveryengine.v1beta.Engine], regardless of whether
// or not it exists, a PERMISSION_DENIED error is returned.
//
// If the [Engine][google.cloud.discoveryengine.v1beta.Engine] to delete does
// not exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [EngineService.DeleteEngine][google.cloud.discoveryengine.v1beta.EngineService.DeleteEngine] method.
func (*DeleteEngineRequest) Descriptor
func (*DeleteEngineRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteEngineRequest.ProtoReflect.Descriptor instead.
func (*DeleteEngineRequest) GetName
func (x *DeleteEngineRequest) GetName() stringfunc (*DeleteEngineRequest) ProtoMessage
func (*DeleteEngineRequest) ProtoMessage()func (*DeleteEngineRequest) ProtoReflect
func (x *DeleteEngineRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteEngineRequest) Reset
func (x *DeleteEngineRequest) Reset()func (*DeleteEngineRequest) String
func (x *DeleteEngineRequest) String() stringDeleteIdentityMappingStoreMetadata
type DeleteIdentityMappingStoreMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1beta.IdentityMappingStoreService.DeleteIdentityMappingStore] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*DeleteIdentityMappingStoreMetadata) Descriptor
func (*DeleteIdentityMappingStoreMetadata) Descriptor() ([]byte, []int)Deprecated: Use DeleteIdentityMappingStoreMetadata.ProtoReflect.Descriptor instead.
func (*DeleteIdentityMappingStoreMetadata) GetCreateTime
func (x *DeleteIdentityMappingStoreMetadata) GetCreateTime() *timestamppb.Timestampfunc (*DeleteIdentityMappingStoreMetadata) GetUpdateTime
func (x *DeleteIdentityMappingStoreMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*DeleteIdentityMappingStoreMetadata) ProtoMessage
func (*DeleteIdentityMappingStoreMetadata) ProtoMessage()func (*DeleteIdentityMappingStoreMetadata) ProtoReflect
func (x *DeleteIdentityMappingStoreMetadata) ProtoReflect() protoreflect.Messagefunc (*DeleteIdentityMappingStoreMetadata) Reset
func (x *DeleteIdentityMappingStoreMetadata) Reset()func (*DeleteIdentityMappingStoreMetadata) String
func (x *DeleteIdentityMappingStoreMetadata) String() stringDeleteIdentityMappingStoreRequest
type DeleteIdentityMappingStoreRequest struct {
// Required. The name of the Identity Mapping Store to delete.
// Format:
// `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1beta.IdentityMappingStoreService.DeleteIdentityMappingStore]
func (*DeleteIdentityMappingStoreRequest) Descriptor
func (*DeleteIdentityMappingStoreRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteIdentityMappingStoreRequest.ProtoReflect.Descriptor instead.
func (*DeleteIdentityMappingStoreRequest) GetName
func (x *DeleteIdentityMappingStoreRequest) GetName() stringfunc (*DeleteIdentityMappingStoreRequest) ProtoMessage
func (*DeleteIdentityMappingStoreRequest) ProtoMessage()func (*DeleteIdentityMappingStoreRequest) ProtoReflect
func (x *DeleteIdentityMappingStoreRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteIdentityMappingStoreRequest) Reset
func (x *DeleteIdentityMappingStoreRequest) Reset()func (*DeleteIdentityMappingStoreRequest) String
func (x *DeleteIdentityMappingStoreRequest) String() stringDeleteSampleQueryRequest
type DeleteSampleQueryRequest struct {
// Required. Full resource name of
// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], such as
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
//
// If the caller does not have permission to delete the
// [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], regardless
// of whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// If the [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] to
// delete does not exist, a `NOT_FOUND` error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.DeleteSampleQuery] method.
func (*DeleteSampleQueryRequest) Descriptor
func (*DeleteSampleQueryRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSampleQueryRequest.ProtoReflect.Descriptor instead.
func (*DeleteSampleQueryRequest) GetName
func (x *DeleteSampleQueryRequest) GetName() stringfunc (*DeleteSampleQueryRequest) ProtoMessage
func (*DeleteSampleQueryRequest) ProtoMessage()func (*DeleteSampleQueryRequest) ProtoReflect
func (x *DeleteSampleQueryRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSampleQueryRequest) Reset
func (x *DeleteSampleQueryRequest) Reset()func (*DeleteSampleQueryRequest) String
func (x *DeleteSampleQueryRequest) String() stringDeleteSampleQuerySetRequest
type DeleteSampleQuerySetRequest struct {
// Required. Full resource name of
// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such
// as
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
//
// If the caller does not have permission to delete the
// [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet],
// regardless of whether or not it exists, a `PERMISSION_DENIED` error is
// returned.
//
// If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]
// to delete does not exist, a `NOT_FOUND` error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.DeleteSampleQuerySet] method.
func (*DeleteSampleQuerySetRequest) Descriptor
func (*DeleteSampleQuerySetRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSampleQuerySetRequest.ProtoReflect.Descriptor instead.
func (*DeleteSampleQuerySetRequest) GetName
func (x *DeleteSampleQuerySetRequest) GetName() stringfunc (*DeleteSampleQuerySetRequest) ProtoMessage
func (*DeleteSampleQuerySetRequest) ProtoMessage()func (*DeleteSampleQuerySetRequest) ProtoReflect
func (x *DeleteSampleQuerySetRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSampleQuerySetRequest) Reset
func (x *DeleteSampleQuerySetRequest) Reset()func (*DeleteSampleQuerySetRequest) String
func (x *DeleteSampleQuerySetRequest) String() stringDeleteSchemaMetadata
type DeleteSchemaMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata for DeleteSchema LRO.
func (*DeleteSchemaMetadata) Descriptor
func (*DeleteSchemaMetadata) Descriptor() ([]byte, []int)Deprecated: Use DeleteSchemaMetadata.ProtoReflect.Descriptor instead.
func (*DeleteSchemaMetadata) GetCreateTime
func (x *DeleteSchemaMetadata) GetCreateTime() *timestamppb.Timestampfunc (*DeleteSchemaMetadata) GetUpdateTime
func (x *DeleteSchemaMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*DeleteSchemaMetadata) ProtoMessage
func (*DeleteSchemaMetadata) ProtoMessage()func (*DeleteSchemaMetadata) ProtoReflect
func (x *DeleteSchemaMetadata) ProtoReflect() protoreflect.Messagefunc (*DeleteSchemaMetadata) Reset
func (x *DeleteSchemaMetadata) Reset()func (*DeleteSchemaMetadata) String
func (x *DeleteSchemaMetadata) String() stringDeleteSchemaRequest
type DeleteSchemaRequest struct {
// Required. The full resource name of the schema, in the format of
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema] method.
func (*DeleteSchemaRequest) Descriptor
func (*DeleteSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSchemaRequest.ProtoReflect.Descriptor instead.
func (*DeleteSchemaRequest) GetName
func (x *DeleteSchemaRequest) GetName() stringfunc (*DeleteSchemaRequest) ProtoMessage
func (*DeleteSchemaRequest) ProtoMessage()func (*DeleteSchemaRequest) ProtoReflect
func (x *DeleteSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSchemaRequest) Reset
func (x *DeleteSchemaRequest) Reset()func (*DeleteSchemaRequest) String
func (x *DeleteSchemaRequest) String() stringDeleteServingConfigRequest
type DeleteServingConfigRequest struct {
// Required. The resource name of the ServingConfig to delete. Format:
// `projects/{project}/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 DeleteServingConfig method.
func (*DeleteServingConfigRequest) Descriptor
func (*DeleteServingConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteServingConfigRequest.ProtoReflect.Descriptor instead.
func (*DeleteServingConfigRequest) GetName
func (x *DeleteServingConfigRequest) GetName() stringfunc (*DeleteServingConfigRequest) ProtoMessage
func (*DeleteServingConfigRequest) ProtoMessage()func (*DeleteServingConfigRequest) ProtoReflect
func (x *DeleteServingConfigRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteServingConfigRequest) Reset
func (x *DeleteServingConfigRequest) Reset()func (*DeleteServingConfigRequest) String
func (x *DeleteServingConfigRequest) String() stringDeleteSessionRequest
type DeleteSessionRequest struct {
// Required. The resource name of the Session to delete. Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for DeleteSession method.
func (*DeleteSessionRequest) Descriptor
func (*DeleteSessionRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSessionRequest.ProtoReflect.Descriptor instead.
func (*DeleteSessionRequest) GetName
func (x *DeleteSessionRequest) GetName() stringfunc (*DeleteSessionRequest) ProtoMessage
func (*DeleteSessionRequest) ProtoMessage()func (*DeleteSessionRequest) ProtoReflect
func (x *DeleteSessionRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSessionRequest) Reset
func (x *DeleteSessionRequest) Reset()func (*DeleteSessionRequest) String
func (x *DeleteSessionRequest) String() stringDeleteSitemapMetadata
type DeleteSitemapMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteSitemap] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*DeleteSitemapMetadata) Descriptor
func (*DeleteSitemapMetadata) Descriptor() ([]byte, []int)Deprecated: Use DeleteSitemapMetadata.ProtoReflect.Descriptor instead.
func (*DeleteSitemapMetadata) GetCreateTime
func (x *DeleteSitemapMetadata) GetCreateTime() *timestamppb.Timestampfunc (*DeleteSitemapMetadata) GetUpdateTime
func (x *DeleteSitemapMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*DeleteSitemapMetadata) ProtoMessage
func (*DeleteSitemapMetadata) ProtoMessage()func (*DeleteSitemapMetadata) ProtoReflect
func (x *DeleteSitemapMetadata) ProtoReflect() protoreflect.Messagefunc (*DeleteSitemapMetadata) Reset
func (x *DeleteSitemapMetadata) Reset()func (*DeleteSitemapMetadata) String
func (x *DeleteSitemapMetadata) String() stringDeleteSitemapRequest
type DeleteSitemapRequest struct {
// Required. Full resource name of
// [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`.
//
// If the caller does not have permission to access the
// [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap], regardless of
// whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the requested [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]
// does not exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteSitemap] method.
func (*DeleteSitemapRequest) Descriptor
func (*DeleteSitemapRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSitemapRequest.ProtoReflect.Descriptor instead.
func (*DeleteSitemapRequest) GetName
func (x *DeleteSitemapRequest) GetName() stringfunc (*DeleteSitemapRequest) ProtoMessage
func (*DeleteSitemapRequest) ProtoMessage()func (*DeleteSitemapRequest) ProtoReflect
func (x *DeleteSitemapRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSitemapRequest) Reset
func (x *DeleteSitemapRequest) Reset()func (*DeleteSitemapRequest) String
func (x *DeleteSitemapRequest) String() stringDeleteTargetSiteMetadata
type DeleteTargetSiteMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*DeleteTargetSiteMetadata) Descriptor
func (*DeleteTargetSiteMetadata) Descriptor() ([]byte, []int)Deprecated: Use DeleteTargetSiteMetadata.ProtoReflect.Descriptor instead.
func (*DeleteTargetSiteMetadata) GetCreateTime
func (x *DeleteTargetSiteMetadata) GetCreateTime() *timestamppb.Timestampfunc (*DeleteTargetSiteMetadata) GetUpdateTime
func (x *DeleteTargetSiteMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*DeleteTargetSiteMetadata) ProtoMessage
func (*DeleteTargetSiteMetadata) ProtoMessage()func (*DeleteTargetSiteMetadata) ProtoReflect
func (x *DeleteTargetSiteMetadata) ProtoReflect() protoreflect.Messagefunc (*DeleteTargetSiteMetadata) Reset
func (x *DeleteTargetSiteMetadata) Reset()func (*DeleteTargetSiteMetadata) String
func (x *DeleteTargetSiteMetadata) String() stringDeleteTargetSiteRequest
type DeleteTargetSiteRequest struct {
// Required. Full resource name of
// [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
//
// If the caller does not have permission to access the
// [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of
// whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the requested
// [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] does not
// exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteTargetSite] method.
func (*DeleteTargetSiteRequest) Descriptor
func (*DeleteTargetSiteRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteTargetSiteRequest.ProtoReflect.Descriptor instead.
func (*DeleteTargetSiteRequest) GetName
func (x *DeleteTargetSiteRequest) GetName() stringfunc (*DeleteTargetSiteRequest) ProtoMessage
func (*DeleteTargetSiteRequest) ProtoMessage()func (*DeleteTargetSiteRequest) ProtoReflect
func (x *DeleteTargetSiteRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteTargetSiteRequest) Reset
func (x *DeleteTargetSiteRequest) Reset()func (*DeleteTargetSiteRequest) String
func (x *DeleteTargetSiteRequest) String() stringDisableAdvancedSiteSearchMetadata
type DisableAdvancedSiteSearchMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*DisableAdvancedSiteSearchMetadata) Descriptor
func (*DisableAdvancedSiteSearchMetadata) Descriptor() ([]byte, []int)Deprecated: Use DisableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.
func (*DisableAdvancedSiteSearchMetadata) GetCreateTime
func (x *DisableAdvancedSiteSearchMetadata) GetCreateTime() *timestamppb.Timestampfunc (*DisableAdvancedSiteSearchMetadata) GetUpdateTime
func (x *DisableAdvancedSiteSearchMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*DisableAdvancedSiteSearchMetadata) ProtoMessage
func (*DisableAdvancedSiteSearchMetadata) ProtoMessage()func (*DisableAdvancedSiteSearchMetadata) ProtoReflect
func (x *DisableAdvancedSiteSearchMetadata) ProtoReflect() protoreflect.Messagefunc (*DisableAdvancedSiteSearchMetadata) Reset
func (x *DisableAdvancedSiteSearchMetadata) Reset()func (*DisableAdvancedSiteSearchMetadata) String
func (x *DisableAdvancedSiteSearchMetadata) String() stringDisableAdvancedSiteSearchRequest
type DisableAdvancedSiteSearchRequest struct {
// Required. Full resource name of the
// [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine],
// such as
// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] method.
func (*DisableAdvancedSiteSearchRequest) Descriptor
func (*DisableAdvancedSiteSearchRequest) Descriptor() ([]byte, []int)Deprecated: Use DisableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.
func (*DisableAdvancedSiteSearchRequest) GetSiteSearchEngine
func (x *DisableAdvancedSiteSearchRequest) GetSiteSearchEngine() stringfunc (*DisableAdvancedSiteSearchRequest) ProtoMessage
func (*DisableAdvancedSiteSearchRequest) ProtoMessage()func (*DisableAdvancedSiteSearchRequest) ProtoReflect
func (x *DisableAdvancedSiteSearchRequest) ProtoReflect() protoreflect.Messagefunc (*DisableAdvancedSiteSearchRequest) Reset
func (x *DisableAdvancedSiteSearchRequest) Reset()func (*DisableAdvancedSiteSearchRequest) String
func (x *DisableAdvancedSiteSearchRequest) String() stringDisableAdvancedSiteSearchResponse
type DisableAdvancedSiteSearchResponse struct {
// contains filtered or unexported fields
}Response message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] method.
func (*DisableAdvancedSiteSearchResponse) Descriptor
func (*DisableAdvancedSiteSearchResponse) Descriptor() ([]byte, []int)Deprecated: Use DisableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.
func (*DisableAdvancedSiteSearchResponse) ProtoMessage
func (*DisableAdvancedSiteSearchResponse) ProtoMessage()func (*DisableAdvancedSiteSearchResponse) ProtoReflect
func (x *DisableAdvancedSiteSearchResponse) ProtoReflect() protoreflect.Messagefunc (*DisableAdvancedSiteSearchResponse) Reset
func (x *DisableAdvancedSiteSearchResponse) Reset()func (*DisableAdvancedSiteSearchResponse) String
func (x *DisableAdvancedSiteSearchResponse) String() stringDistributeLicenseConfigRequest
type DistributeLicenseConfigRequest struct {
// Required. Full resource name of [BillingAccountLicenseConfig][].
//
// Format:
// `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.
BillingAccountLicenseConfig string `protobuf:"bytes,1,opt,name=billing_account_license_config,json=billingAccountLicenseConfig,proto3" json:"billing_account_license_config,omitempty"`
// Required. The target GCP project number to distribute the license config
// to.
ProjectNumber int64 `protobuf:"varint,2,opt,name=project_number,json=projectNumber,proto3" json:"project_number,omitempty"`
// Required. The target GCP project region to distribute the license config
// to.
Location string `protobuf:"bytes,3,opt,name=location,proto3" json:"location,omitempty"`
// Required. The number of licenses to distribute.
LicenseCount int64 `protobuf:"varint,4,opt,name=license_count,json=licenseCount,proto3" json:"license_count,omitempty"`
// Optional. Distribute seats to this license config instead of creating a new
// one. If not specified, a new license config will be created from the
// billing account license config.
LicenseConfigId string `protobuf:"bytes,5,opt,name=license_config_id,json=licenseConfigId,proto3" json:"license_config_id,omitempty"`
// contains filtered or unexported fields
}Request message for [LicenseConfigService.DistributeLicenseConfig][google.cloud.discoveryengine.v1beta.LicenseConfigService.DistributeLicenseConfig] method.
func (*DistributeLicenseConfigRequest) Descriptor
func (*DistributeLicenseConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use DistributeLicenseConfigRequest.ProtoReflect.Descriptor instead.
func (*DistributeLicenseConfigRequest) GetBillingAccountLicenseConfig
func (x *DistributeLicenseConfigRequest) GetBillingAccountLicenseConfig() stringfunc (*DistributeLicenseConfigRequest) GetLicenseConfigId
func (x *DistributeLicenseConfigRequest) GetLicenseConfigId() stringfunc (*DistributeLicenseConfigRequest) GetLicenseCount
func (x *DistributeLicenseConfigRequest) GetLicenseCount() int64func (*DistributeLicenseConfigRequest) GetLocation
func (x *DistributeLicenseConfigRequest) GetLocation() stringfunc (*DistributeLicenseConfigRequest) GetProjectNumber
func (x *DistributeLicenseConfigRequest) GetProjectNumber() int64func (*DistributeLicenseConfigRequest) ProtoMessage
func (*DistributeLicenseConfigRequest) ProtoMessage()func (*DistributeLicenseConfigRequest) ProtoReflect
func (x *DistributeLicenseConfigRequest) ProtoReflect() protoreflect.Messagefunc (*DistributeLicenseConfigRequest) Reset
func (x *DistributeLicenseConfigRequest) Reset()func (*DistributeLicenseConfigRequest) String
func (x *DistributeLicenseConfigRequest) String() stringDistributeLicenseConfigResponse
type DistributeLicenseConfigResponse struct {
// The updated or created LicenseConfig.
LicenseConfig *LicenseConfig `protobuf:"bytes,1,opt,name=license_config,json=licenseConfig,proto3" json:"license_config,omitempty"`
// contains filtered or unexported fields
}Response message for [LicenseConfigService.DistributeLicenseConfig][google.cloud.discoveryengine.v1beta.LicenseConfigService.DistributeLicenseConfig] method.
func (*DistributeLicenseConfigResponse) Descriptor
func (*DistributeLicenseConfigResponse) Descriptor() ([]byte, []int)Deprecated: Use DistributeLicenseConfigResponse.ProtoReflect.Descriptor instead.
func (*DistributeLicenseConfigResponse) GetLicenseConfig
func (x *DistributeLicenseConfigResponse) GetLicenseConfig() *LicenseConfigfunc (*DistributeLicenseConfigResponse) ProtoMessage
func (*DistributeLicenseConfigResponse) ProtoMessage()func (*DistributeLicenseConfigResponse) ProtoReflect
func (x *DistributeLicenseConfigResponse) ProtoReflect() protoreflect.Messagefunc (*DistributeLicenseConfigResponse) Reset
func (x *DistributeLicenseConfigResponse) Reset()func (*DistributeLicenseConfigResponse) String
func (x *DistributeLicenseConfigResponse) String() stringDocument
type Document struct {
// Data representation. One of
// [struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data] or
// [json_data][google.cloud.discoveryengine.v1beta.Document.json_data] should
// be provided otherwise an `INVALID_ARGUMENT` error is thrown.
//
// Types that are valid to be assigned to Data:
//
// *Document_StructData
// *Document_JsonData
Data isDocument_Data `protobuf_oneof:"data"`
// Immutable. The full resource name of the document.
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Immutable. The identifier of the document.
//
// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 128 characters.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// The identifier of the schema located in the same data store.
SchemaId string `protobuf:"bytes,3,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
// The unstructured data linked to this document. Content can only be set
// and must be set if this document is under a `CONTENT_REQUIRED` data store.
Content *Document_Content `protobuf:"bytes,10,opt,name=content,proto3" json:"content,omitempty"`
// The identifier of the parent document. Currently supports at most two level
// document hierarchy.
//
// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters.
ParentDocumentId string `protobuf:"bytes,7,opt,name=parent_document_id,json=parentDocumentId,proto3" json:"parent_document_id,omitempty"`
// Output only. This field is OUTPUT_ONLY.
// It contains derived data that are not in the original input document.
DerivedStructData *structpb.Struct `protobuf:"bytes,6,opt,name=derived_struct_data,json=derivedStructData,proto3" json:"derived_struct_data,omitempty"`
// Access control information for the document.
AclInfo *Document_AclInfo `protobuf:"bytes,11,opt,name=acl_info,json=aclInfo,proto3" json:"acl_info,omitempty"`
// Output only. The time when the document was last indexed.
//
// If this field is populated, it means the document has been indexed.
// While documents typically become searchable within seconds of indexing,
// it can sometimes take up to a few hours.
//
// If this field is not populated, it means the document has never been
// indexed.
IndexTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=index_time,json=indexTime,proto3" json:"index_time,omitempty"`
// Output only. The index status of the document.
//
// - If document is indexed successfully, the index_time field is populated.
// - Otherwise, if document is not indexed due to errors, the error_samples
// field is populated.
// - Otherwise, if document's index is in progress, the pending_message field
// is populated.
IndexStatus *Document_IndexStatus `protobuf:"bytes,15,opt,name=index_status,json=indexStatus,proto3" json:"index_status,omitempty"`
// contains filtered or unexported fields
}Document captures all raw metadata information of items to be recommended or searched.
func (*Document) Descriptor
Deprecated: Use Document.ProtoReflect.Descriptor instead.
func (*Document) GetAclInfo
func (x *Document) GetAclInfo() *Document_AclInfofunc (*Document) GetContent
func (x *Document) GetContent() *Document_Contentfunc (*Document) GetData
func (x *Document) GetData() isDocument_Datafunc (*Document) GetDerivedStructData
func (*Document) GetId
func (*Document) GetIndexStatus
func (x *Document) GetIndexStatus() *Document_IndexStatusfunc (*Document) GetIndexTime
func (x *Document) GetIndexTime() *timestamppb.Timestampfunc (*Document) GetJsonData
func (*Document) GetName
func (*Document) GetParentDocumentId
func (*Document) GetSchemaId
func (*Document) GetStructData
func (*Document) ProtoMessage
func (*Document) ProtoMessage()func (*Document) ProtoReflect
func (x *Document) ProtoReflect() protoreflect.Messagefunc (*Document) Reset
func (x *Document) Reset()func (*Document) String
DocumentInfo
type DocumentInfo struct {
// A required descriptor of the associated
// [Document][google.cloud.discoveryengine.v1beta.Document].
//
// * If [id][google.cloud.discoveryengine.v1beta.DocumentInfo.id] is
// specified, then the default values for
// `{location}`, `{collection_id}`, `{data_store_id}`, and `{branch_id}` are
// used when annotating with the stored Document.
//
// * If [name][google.cloud.discoveryengine.v1beta.DocumentInfo.name] is
// specified, then the provided values (default values allowed) for
// `{location}`, `{collection_id}`, `{data_store_id}`, and
// `{branch_id}` are used when annotating with the stored Document.
//
// Types that are valid to be assigned to DocumentDescriptor:
//
// *DocumentInfo_Id
// *DocumentInfo_Name
// *DocumentInfo_Uri
DocumentDescriptor isDocumentInfo_DocumentDescriptor `protobuf_oneof:"document_descriptor"`
// Quantity of the Document associated with the user event. Defaults to 1.
//
// For example, this field is 2 if two quantities of the same Document
// are involved in a `add-to-cart` event.
//
// Required for events of the following event types:
//
// * `add-to-cart`
// * `purchase`
Quantity *int32 `protobuf:"varint,3,opt,name=quantity,proto3,oneof" json:"quantity,omitempty"`
// The promotion IDs associated with this Document.
// Currently, this field is restricted to at most one ID.
PromotionIds []string `protobuf:"bytes,4,rep,name=promotion_ids,json=promotionIds,proto3" json:"promotion_ids,omitempty"`
// Output only. Whether the referenced Document can be found in the data
// store.
Joined bool `protobuf:"varint,5,opt,name=joined,proto3" json:"joined,omitempty"`
// Optional. The conversion value associated with this Document.
// Must be set if
// [UserEvent.event_type][google.cloud.discoveryengine.v1beta.UserEvent.event_type]
// is "conversion".
//
// For example, a value of 1000 signifies that 1000 seconds were spent viewing
// a Document for the `watch` conversion type.
ConversionValue *float32 `protobuf:"fixed32,7,opt,name=conversion_value,json=conversionValue,proto3,oneof" json:"conversion_value,omitempty"`
// contains filtered or unexported fields
}Detailed document information associated with a user event.
func (*DocumentInfo) Descriptor
func (*DocumentInfo) Descriptor() ([]byte, []int)Deprecated: Use DocumentInfo.ProtoReflect.Descriptor instead.
func (*DocumentInfo) GetConversionValue
func (x *DocumentInfo) GetConversionValue() float32func (*DocumentInfo) GetDocumentDescriptor
func (x *DocumentInfo) GetDocumentDescriptor() isDocumentInfo_DocumentDescriptorfunc (*DocumentInfo) GetId
func (x *DocumentInfo) GetId() stringfunc (*DocumentInfo) GetJoined
func (x *DocumentInfo) GetJoined() boolfunc (*DocumentInfo) GetName
func (x *DocumentInfo) GetName() stringfunc (*DocumentInfo) GetPromotionIds
func (x *DocumentInfo) GetPromotionIds() []stringfunc (*DocumentInfo) GetQuantity
func (x *DocumentInfo) GetQuantity() int32func (*DocumentInfo) GetUri
func (x *DocumentInfo) GetUri() stringfunc (*DocumentInfo) ProtoMessage
func (*DocumentInfo) ProtoMessage()func (*DocumentInfo) ProtoReflect
func (x *DocumentInfo) ProtoReflect() protoreflect.Messagefunc (*DocumentInfo) Reset
func (x *DocumentInfo) Reset()func (*DocumentInfo) String
func (x *DocumentInfo) String() stringDocumentInfo_Id
type DocumentInfo_Id struct {
// The [Document][google.cloud.discoveryengine.v1beta.Document] resource ID.
Id string `protobuf:"bytes,1,opt,name=id,proto3,oneof"`
}DocumentInfo_Name
type DocumentInfo_Name struct {
// The [Document][google.cloud.discoveryengine.v1beta.Document] resource
// full name, of the form:
// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
Name string `protobuf:"bytes,2,opt,name=name,proto3,oneof"`
}DocumentInfo_Uri
type DocumentInfo_Uri struct {
// The [Document][google.cloud.discoveryengine.v1beta.Document] URI - only
// allowed for website data stores.
Uri string `protobuf:"bytes,6,opt,name=uri,proto3,oneof"`
}DocumentProcessingConfig
type DocumentProcessingConfig struct {
// The full resource name of the Document Processing Config.
// Format:
// `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Whether chunking mode is enabled.
ChunkingConfig *DocumentProcessingConfig_ChunkingConfig `protobuf:"bytes,3,opt,name=chunking_config,json=chunkingConfig,proto3" json:"chunking_config,omitempty"`
// Configurations for default Document parser.
// If not specified, we will configure it as default DigitalParsingConfig, and
// the default parsing config will be applied to all file types for Document
// parsing.
DefaultParsingConfig *DocumentProcessingConfig_ParsingConfig `protobuf:"bytes,4,opt,name=default_parsing_config,json=defaultParsingConfig,proto3" json:"default_parsing_config,omitempty"`
// Map from file type to override the default parsing configuration based on
// the file type. Supported keys:
//
// * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
// parsing or layout parsing is supported.
// * `html`: Override parsing config for HTML files, only digital parsing and
// layout parsing are supported.
// * `docx`: Override parsing config for DOCX files, only digital parsing and
// layout parsing are supported.
// * `pptx`: Override parsing config for PPTX files, only digital parsing and
// layout parsing are supported.
// * `xlsm`: Override parsing config for XLSM files, only digital parsing and
// layout parsing are supported.
// * `xlsx`: Override parsing config for XLSX files, only digital parsing and
// layout parsing are supported.
ParsingConfigOverrides map[string]*DocumentProcessingConfig_ParsingConfig `protobuf:"bytes,5,rep,name=parsing_config_overrides,json=parsingConfigOverrides,proto3" json:"parsing_config_overrides,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}A singleton resource of [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. If it's empty when [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is created and [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED], the default parser will default to digital parser.
func (*DocumentProcessingConfig) Descriptor
func (*DocumentProcessingConfig) Descriptor() ([]byte, []int)Deprecated: Use DocumentProcessingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig) GetChunkingConfig
func (x *DocumentProcessingConfig) GetChunkingConfig() *DocumentProcessingConfig_ChunkingConfigfunc (*DocumentProcessingConfig) GetDefaultParsingConfig
func (x *DocumentProcessingConfig) GetDefaultParsingConfig() *DocumentProcessingConfig_ParsingConfigfunc (*DocumentProcessingConfig) GetName
func (x *DocumentProcessingConfig) GetName() stringfunc (*DocumentProcessingConfig) GetParsingConfigOverrides
func (x *DocumentProcessingConfig) GetParsingConfigOverrides() map[string]*DocumentProcessingConfig_ParsingConfigfunc (*DocumentProcessingConfig) ProtoMessage
func (*DocumentProcessingConfig) ProtoMessage()func (*DocumentProcessingConfig) ProtoReflect
func (x *DocumentProcessingConfig) ProtoReflect() protoreflect.Messagefunc (*DocumentProcessingConfig) Reset
func (x *DocumentProcessingConfig) Reset()func (*DocumentProcessingConfig) String
func (x *DocumentProcessingConfig) String() stringDocumentProcessingConfig_ChunkingConfig
type DocumentProcessingConfig_ChunkingConfig struct {
// Additional configs that defines the behavior of the chunking.
//
// Types that are valid to be assigned to ChunkMode:
//
// *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig_
ChunkMode isDocumentProcessingConfig_ChunkingConfig_ChunkMode `protobuf_oneof:"chunk_mode"`
// contains filtered or unexported fields
}Configuration for chunking config.
func (*DocumentProcessingConfig_ChunkingConfig) Descriptor
func (*DocumentProcessingConfig_ChunkingConfig) Descriptor() ([]byte, []int)Deprecated: Use DocumentProcessingConfig_ChunkingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig_ChunkingConfig) GetChunkMode
func (x *DocumentProcessingConfig_ChunkingConfig) GetChunkMode() isDocumentProcessingConfig_ChunkingConfig_ChunkModefunc (*DocumentProcessingConfig_ChunkingConfig) GetLayoutBasedChunkingConfig
func (x *DocumentProcessingConfig_ChunkingConfig) GetLayoutBasedChunkingConfig() *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfigfunc (*DocumentProcessingConfig_ChunkingConfig) ProtoMessage
func (*DocumentProcessingConfig_ChunkingConfig) ProtoMessage()func (*DocumentProcessingConfig_ChunkingConfig) ProtoReflect
func (x *DocumentProcessingConfig_ChunkingConfig) ProtoReflect() protoreflect.Messagefunc (*DocumentProcessingConfig_ChunkingConfig) Reset
func (x *DocumentProcessingConfig_ChunkingConfig) Reset()func (*DocumentProcessingConfig_ChunkingConfig) String
func (x *DocumentProcessingConfig_ChunkingConfig) String() stringDocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig
type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig struct {
// The token size limit for each chunk.
//
// Supported values: 100-500 (inclusive).
// Default value: 500.
ChunkSize int32 `protobuf:"varint,1,opt,name=chunk_size,json=chunkSize,proto3" json:"chunk_size,omitempty"`
// Whether to include appending different levels of headings to chunks
// from the middle of the document to prevent context loss.
//
// Default value: False.
IncludeAncestorHeadings bool `protobuf:"varint,2,opt,name=include_ancestor_headings,json=includeAncestorHeadings,proto3" json:"include_ancestor_headings,omitempty"`
// contains filtered or unexported fields
}Configuration for the layout based chunking.
func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Descriptor
func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Descriptor() ([]byte, []int)Deprecated: Use DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetChunkSize
func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetChunkSize() int32func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetIncludeAncestorHeadings
func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) GetIncludeAncestorHeadings() boolfunc (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoMessage
func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoMessage()func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoReflect
func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) ProtoReflect() protoreflect.Messagefunc (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Reset
func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) Reset()func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) String
func (x *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) String() stringDocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig_
type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig_ struct {
// Configuration for the layout based chunking.
LayoutBasedChunkingConfig *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig `protobuf:"bytes,1,opt,name=layout_based_chunking_config,json=layoutBasedChunkingConfig,proto3,oneof"`
}DocumentProcessingConfig_ParsingConfig
type DocumentProcessingConfig_ParsingConfig struct {
// Configs for document processing types.
//
// Types that are valid to be assigned to TypeDedicatedConfig:
//
// *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig_
// *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig_
// *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig_
TypeDedicatedConfig isDocumentProcessingConfig_ParsingConfig_TypeDedicatedConfig `protobuf_oneof:"type_dedicated_config"`
// contains filtered or unexported fields
}Related configurations applied to a specific type of document parser.
func (*DocumentProcessingConfig_ParsingConfig) Descriptor
func (*DocumentProcessingConfig_ParsingConfig) Descriptor() ([]byte, []int)Deprecated: Use DocumentProcessingConfig_ParsingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig
func (x *DocumentProcessingConfig_ParsingConfig) GetDigitalParsingConfig() *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfigfunc (*DocumentProcessingConfig_ParsingConfig) GetLayoutParsingConfig
func (x *DocumentProcessingConfig_ParsingConfig) GetLayoutParsingConfig() *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfigfunc (*DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig
func (x *DocumentProcessingConfig_ParsingConfig) GetOcrParsingConfig() *DocumentProcessingConfig_ParsingConfig_OcrParsingConfigfunc (*DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig
func (x *DocumentProcessingConfig_ParsingConfig) GetTypeDedicatedConfig() isDocumentProcessingConfig_ParsingConfig_TypeDedicatedConfigfunc (*DocumentProcessingConfig_ParsingConfig) ProtoMessage
func (*DocumentProcessingConfig_ParsingConfig) ProtoMessage()func (*DocumentProcessingConfig_ParsingConfig) ProtoReflect
func (x *DocumentProcessingConfig_ParsingConfig) ProtoReflect() protoreflect.Messagefunc (*DocumentProcessingConfig_ParsingConfig) Reset
func (x *DocumentProcessingConfig_ParsingConfig) Reset()func (*DocumentProcessingConfig_ParsingConfig) String
func (x *DocumentProcessingConfig_ParsingConfig) String() stringDocumentProcessingConfig_ParsingConfig_DigitalParsingConfig
type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig struct {
// contains filtered or unexported fields
}The digital parsing configurations for documents.
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Descriptor
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Descriptor() ([]byte, []int)Deprecated: Use DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage
func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoMessage()func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoReflect
func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) ProtoReflect() protoreflect.Messagefunc (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset
func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) Reset()func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String
func (x *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) String() stringDocumentProcessingConfig_ParsingConfig_DigitalParsingConfig_
type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig_ struct {
// Configurations applied to digital parser.
DigitalParsingConfig *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig `protobuf:"bytes,1,opt,name=digital_parsing_config,json=digitalParsingConfig,proto3,oneof"`
}DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig
type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig struct {
// Optional. If true, the LLM based annotation is added to the table
// during parsing.
EnableTableAnnotation bool `protobuf:"varint,1,opt,name=enable_table_annotation,json=enableTableAnnotation,proto3" json:"enable_table_annotation,omitempty"`
// Optional. If true, the LLM based annotation is added to the image
// during parsing.
EnableImageAnnotation bool `protobuf:"varint,2,opt,name=enable_image_annotation,json=enableImageAnnotation,proto3" json:"enable_image_annotation,omitempty"`
// Optional. If true, the pdf layout will be refined using an LLM.
EnableLlmLayoutParsing bool `protobuf:"varint,5,opt,name=enable_llm_layout_parsing,json=enableLlmLayoutParsing,proto3" json:"enable_llm_layout_parsing,omitempty"`
// Optional. Contains the required structure types to extract from the
// document. Supported values:
//
// * `shareholder-structure`
StructuredContentTypes []string `protobuf:"bytes,9,rep,name=structured_content_types,json=structuredContentTypes,proto3" json:"structured_content_types,omitempty"`
// Optional. List of HTML elements to exclude from the parsed content.
ExcludeHtmlElements []string `protobuf:"bytes,10,rep,name=exclude_html_elements,json=excludeHtmlElements,proto3" json:"exclude_html_elements,omitempty"`
// Optional. List of HTML classes to exclude from the parsed content.
ExcludeHtmlClasses []string `protobuf:"bytes,11,rep,name=exclude_html_classes,json=excludeHtmlClasses,proto3" json:"exclude_html_classes,omitempty"`
// Optional. List of HTML ids to exclude from the parsed content.
ExcludeHtmlIds []string `protobuf:"bytes,12,rep,name=exclude_html_ids,json=excludeHtmlIds,proto3" json:"exclude_html_ids,omitempty"`
// Optional. If true, the processed document will be made available for
// the GetProcessedDocument API.
EnableGetProcessedDocument bool `protobuf:"varint,14,opt,name=enable_get_processed_document,json=enableGetProcessedDocument,proto3" json:"enable_get_processed_document,omitempty"`
// contains filtered or unexported fields
}The layout parsing configurations for documents.
func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Descriptor
func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Descriptor() ([]byte, []int)Deprecated: Use DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableGetProcessedDocument
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableGetProcessedDocument() boolfunc (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableImageAnnotation
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableImageAnnotation() boolfunc (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableLlmLayoutParsing
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableLlmLayoutParsing() boolfunc (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableTableAnnotation
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetEnableTableAnnotation() boolfunc (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlClasses
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlClasses() []stringfunc (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlElements
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlElements() []stringfunc (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlIds
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetExcludeHtmlIds() []stringfunc (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetStructuredContentTypes
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) GetStructuredContentTypes() []stringfunc (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoMessage
func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoMessage()func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoReflect
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) ProtoReflect() protoreflect.Messagefunc (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Reset
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) Reset()func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) String
func (x *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) String() stringDocumentProcessingConfig_ParsingConfig_LayoutParsingConfig_
type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig_ struct {
// Configurations applied to layout parser.
LayoutParsingConfig *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig `protobuf:"bytes,3,opt,name=layout_parsing_config,json=layoutParsingConfig,proto3,oneof"`
}DocumentProcessingConfig_ParsingConfig_OcrParsingConfig
type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig struct {
// [DEPRECATED] This field is deprecated. To use the additional enhanced
// document elements processing, please switch to `layout_parsing_config`.
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/document_processing_config.proto.
EnhancedDocumentElements []string `protobuf:"bytes,1,rep,name=enhanced_document_elements,json=enhancedDocumentElements,proto3" json:"enhanced_document_elements,omitempty"`
// If true, will use native text instead of OCR text on pages containing
// native text.
UseNativeText bool `protobuf:"varint,2,opt,name=use_native_text,json=useNativeText,proto3" json:"use_native_text,omitempty"`
// contains filtered or unexported fields
}The OCR parsing configurations for documents.
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Descriptor
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Descriptor() ([]byte, []int)Deprecated: Use DocumentProcessingConfig_ParsingConfig_OcrParsingConfig.ProtoReflect.Descriptor instead.
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetEnhancedDocumentElements
func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetEnhancedDocumentElements() []stringDeprecated: Marked as deprecated in google/cloud/discoveryengine/v1beta/document_processing_config.proto.
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetUseNativeText
func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) GetUseNativeText() boolfunc (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage
func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoMessage()func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoReflect
func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) ProtoReflect() protoreflect.Messagefunc (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset
func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) Reset()func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String
func (x *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) String() stringDocumentProcessingConfig_ParsingConfig_OcrParsingConfig_
type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig_ struct {
// Configurations applied to OCR parser. Currently it only applies to
// PDFs.
OcrParsingConfig *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig `protobuf:"bytes,2,opt,name=ocr_parsing_config,json=ocrParsingConfig,proto3,oneof"`
}DocumentServiceClient
type DocumentServiceClient interface {
// Gets a [Document][google.cloud.discoveryengine.v1beta.Document].
GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Gets a list of [Document][google.cloud.discoveryengine.v1beta.Document]s.
ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...grpc.CallOption) (*ListDocumentsResponse, error)
// Creates a [Document][google.cloud.discoveryengine.v1beta.Document].
CreateDocument(ctx context.Context, in *CreateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Updates a [Document][google.cloud.discoveryengine.v1beta.Document].
UpdateDocument(ctx context.Context, in *UpdateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Deletes a [Document][google.cloud.discoveryengine.v1beta.Document].
DeleteDocument(ctx context.Context, in *DeleteDocumentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Bulk import of multiple
// [Document][google.cloud.discoveryengine.v1beta.Document]s. Request
// processing may be synchronous. Non-existing items are created.
//
// Note: It is possible for a subset of the
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be
// successfully updated.
ImportDocuments(ctx context.Context, in *ImportDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Permanently deletes all selected
// [Document][google.cloud.discoveryengine.v1beta.Document]s in a branch.
//
// This process is asynchronous. Depending on the number of
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
// this operation can take hours to complete. Before the delete operation
// completes, some [Document][google.cloud.discoveryengine.v1beta.Document]s
// might still be returned by
// [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
// or
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments].
//
// To get a list of the
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
// set
// [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force]
// to false.
PurgeDocuments(ctx context.Context, in *PurgeDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets index freshness metadata for
// [Document][google.cloud.discoveryengine.v1beta.Document]s. Supported for
// website search only.
BatchGetDocumentsMetadata(ctx context.Context, in *BatchGetDocumentsMetadataRequest, opts ...grpc.CallOption) (*BatchGetDocumentsMetadataResponse, error)
}DocumentServiceClient is the client API for DocumentService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewDocumentServiceClient
func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClientDocumentServiceServer
type DocumentServiceServer interface {
// Gets a [Document][google.cloud.discoveryengine.v1beta.Document].
GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
// Gets a list of [Document][google.cloud.discoveryengine.v1beta.Document]s.
ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
// Creates a [Document][google.cloud.discoveryengine.v1beta.Document].
CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
// Updates a [Document][google.cloud.discoveryengine.v1beta.Document].
UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)
// Deletes a [Document][google.cloud.discoveryengine.v1beta.Document].
DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
// Bulk import of multiple
// [Document][google.cloud.discoveryengine.v1beta.Document]s. Request
// processing may be synchronous. Non-existing items are created.
//
// Note: It is possible for a subset of the
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be
// successfully updated.
ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)
// Permanently deletes all selected
// [Document][google.cloud.discoveryengine.v1beta.Document]s in a branch.
//
// This process is asynchronous. Depending on the number of
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
// this operation can take hours to complete. Before the delete operation
// completes, some [Document][google.cloud.discoveryengine.v1beta.Document]s
// might still be returned by
// [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
// or
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments].
//
// To get a list of the
// [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
// set
// [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force]
// to false.
PurgeDocuments(context.Context, *PurgeDocumentsRequest) (*longrunningpb.Operation, error)
// Gets index freshness metadata for
// [Document][google.cloud.discoveryengine.v1beta.Document]s. Supported for
// website search only.
BatchGetDocumentsMetadata(context.Context, *BatchGetDocumentsMetadataRequest) (*BatchGetDocumentsMetadataResponse, error)
}DocumentServiceServer is the server API for DocumentService service. All implementations should embed UnimplementedDocumentServiceServer for forward compatibility
Document_AclInfo
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
func (*Document_AclInfo) Descriptor() ([]byte, []int)Deprecated: Use Document_AclInfo.ProtoReflect.Descriptor instead.
func (*Document_AclInfo) GetReaders
func (x *Document_AclInfo) GetReaders() []*Document_AclInfo_AccessRestrictionfunc (*Document_AclInfo) ProtoMessage
func (*Document_AclInfo) ProtoMessage()func (*Document_AclInfo) ProtoReflect
func (x *Document_AclInfo) ProtoReflect() protoreflect.Messagefunc (*Document_AclInfo) Reset
func (x *Document_AclInfo) Reset()func (*Document_AclInfo) String
func (x *Document_AclInfo) String() stringDocument_AclInfo_AccessRestriction
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
func (*Document_AclInfo_AccessRestriction) Descriptor() ([]byte, []int)Deprecated: Use Document_AclInfo_AccessRestriction.ProtoReflect.Descriptor instead.
func (*Document_AclInfo_AccessRestriction) GetIdpWide
func (x *Document_AclInfo_AccessRestriction) GetIdpWide() boolfunc (*Document_AclInfo_AccessRestriction) GetPrincipals
func (x *Document_AclInfo_AccessRestriction) GetPrincipals() []*Principalfunc (*Document_AclInfo_AccessRestriction) ProtoMessage
func (*Document_AclInfo_AccessRestriction) ProtoMessage()func (*Document_AclInfo_AccessRestriction) ProtoReflect
func (x *Document_AclInfo_AccessRestriction) ProtoReflect() protoreflect.Messagefunc (*Document_AclInfo_AccessRestriction) Reset
func (x *Document_AclInfo_AccessRestriction) Reset()func (*Document_AclInfo_AccessRestriction) String
func (x *Document_AclInfo_AccessRestriction) String() stringDocument_Content
type Document_Content struct {
// The content of the unstructured document.
//
// Types that are valid to be assigned to Content:
//
// *Document_Content_RawBytes
// *Document_Content_Uri
Content isDocument_Content_Content `protobuf_oneof:"content"`
// The MIME type of the content. Supported types:
//
// * `application/pdf` (PDF, only native PDFs are supported for now)
// * `text/html` (HTML)
// * `text/plain` (TXT)
// * `application/xml` or `text/xml` (XML)
// * `application/json` (JSON)
// * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
// * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
// * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
// (XLSX)
// * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM)
//
// The following types are supported only if layout parser is enabled in the
// data store:
//
// * `image/bmp` (BMP)
// * `image/gif` (GIF)
// * `image/jpeg` (JPEG)
// * `image/png` (PNG)
// * `image/tiff` (TIFF)
//
// See https://www.iana.org/assignments/media-types/media-types.xhtml.
MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// contains filtered or unexported fields
}Unstructured data linked to this document.
func (*Document_Content) Descriptor
func (*Document_Content) Descriptor() ([]byte, []int)Deprecated: Use Document_Content.ProtoReflect.Descriptor instead.
func (*Document_Content) GetContent
func (x *Document_Content) GetContent() isDocument_Content_Contentfunc (*Document_Content) GetMimeType
func (x *Document_Content) GetMimeType() stringfunc (*Document_Content) GetRawBytes
func (x *Document_Content) GetRawBytes() []bytefunc (*Document_Content) GetUri
func (x *Document_Content) GetUri() stringfunc (*Document_Content) ProtoMessage
func (*Document_Content) ProtoMessage()func (*Document_Content) ProtoReflect
func (x *Document_Content) ProtoReflect() protoreflect.Messagefunc (*Document_Content) Reset
func (x *Document_Content) Reset()func (*Document_Content) String
func (x *Document_Content) String() stringDocument_Content_RawBytes
type Document_Content_RawBytes struct {
// The content represented as a stream of bytes. The maximum length is
// 1,000,000 bytes (1 MB / ~0.95 MiB).
//
// Note: As with all `bytes` fields, this field is represented as pure
// binary in Protocol Buffers and base64-encoded string in JSON. For
// example, `abc123!?$*&()'-=@~` should be represented as
// `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See
// https://developers.google.com/protocol-buffers/docs/proto3#json.
RawBytes []byte `protobuf:"bytes,2,opt,name=raw_bytes,json=rawBytes,proto3,oneof"`
}Document_Content_Uri
type Document_Content_Uri struct {
// The URI of the content. Only Cloud Storage URIs (e.g.
// `gs://bucket-name/path/to/file`) are supported. The maximum file size
// is 2.5 MB for text-based formats, 200 MB for other formats.
Uri string `protobuf:"bytes,3,opt,name=uri,proto3,oneof"`
}Document_IndexStatus
type Document_IndexStatus struct {
// The time when the document was indexed.
// If this field is populated, it means the document has been indexed.
// While documents typically become searchable within seconds of indexing,
// it can sometimes take up to a few hours.
IndexTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=index_time,json=indexTime,proto3" json:"index_time,omitempty"`
// A sample of errors encountered while indexing the document.
// If this field is populated, the document is not indexed due to errors.
ErrorSamples []*status.Status `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// Immutable. The message indicates the document index is in progress.
// If this field is populated, the document index is pending.
PendingMessage string `protobuf:"bytes,3,opt,name=pending_message,json=pendingMessage,proto3" json:"pending_message,omitempty"`
// contains filtered or unexported fields
}Index status of the document.
func (*Document_IndexStatus) Descriptor
func (*Document_IndexStatus) Descriptor() ([]byte, []int)Deprecated: Use Document_IndexStatus.ProtoReflect.Descriptor instead.
func (*Document_IndexStatus) GetErrorSamples
func (x *Document_IndexStatus) GetErrorSamples() []*status.Statusfunc (*Document_IndexStatus) GetIndexTime
func (x *Document_IndexStatus) GetIndexTime() *timestamppb.Timestampfunc (*Document_IndexStatus) GetPendingMessage
func (x *Document_IndexStatus) GetPendingMessage() stringfunc (*Document_IndexStatus) ProtoMessage
func (*Document_IndexStatus) ProtoMessage()func (*Document_IndexStatus) ProtoReflect
func (x *Document_IndexStatus) ProtoReflect() protoreflect.Messagefunc (*Document_IndexStatus) Reset
func (x *Document_IndexStatus) Reset()func (*Document_IndexStatus) String
func (x *Document_IndexStatus) String() stringDocument_JsonData
type Document_JsonData struct {
// The JSON string representation of the document. It should conform to the
// registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
// `INVALID_ARGUMENT` error is thrown.
JsonData string `protobuf:"bytes,5,opt,name=json_data,json=jsonData,proto3,oneof"`
}Document_StructData
type Document_StructData struct {
// The structured JSON data for the document. It should conform to the
// registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
// `INVALID_ARGUMENT` error is thrown.
StructData *structpb.Struct `protobuf:"bytes,4,opt,name=struct_data,json=structData,proto3,oneof"`
}DoubleList
type DoubleList struct {
// Double values.
Values []float64 `protobuf:"fixed64,1,rep,packed,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}Double list.
func (*DoubleList) Descriptor
func (*DoubleList) Descriptor() ([]byte, []int)Deprecated: Use DoubleList.ProtoReflect.Descriptor instead.
func (*DoubleList) GetValues
func (x *DoubleList) GetValues() []float64func (*DoubleList) ProtoMessage
func (*DoubleList) ProtoMessage()func (*DoubleList) ProtoReflect
func (x *DoubleList) ProtoReflect() protoreflect.Messagefunc (*DoubleList) Reset
func (x *DoubleList) Reset()func (*DoubleList) String
func (x *DoubleList) String() stringEmbeddingConfig
type EmbeddingConfig struct {
// Full field path in the schema mapped as embedding field.
FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
// contains filtered or unexported fields
}Defines embedding config, used for bring your own embeddings feature.
func (*EmbeddingConfig) Descriptor
func (*EmbeddingConfig) Descriptor() ([]byte, []int)Deprecated: Use EmbeddingConfig.ProtoReflect.Descriptor instead.
func (*EmbeddingConfig) GetFieldPath
func (x *EmbeddingConfig) GetFieldPath() stringfunc (*EmbeddingConfig) ProtoMessage
func (*EmbeddingConfig) ProtoMessage()func (*EmbeddingConfig) ProtoReflect
func (x *EmbeddingConfig) ProtoReflect() protoreflect.Messagefunc (*EmbeddingConfig) Reset
func (x *EmbeddingConfig) Reset()func (*EmbeddingConfig) String
func (x *EmbeddingConfig) String() stringEnableAdvancedSiteSearchMetadata
type EnableAdvancedSiteSearchMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*EnableAdvancedSiteSearchMetadata) Descriptor
func (*EnableAdvancedSiteSearchMetadata) Descriptor() ([]byte, []int)Deprecated: Use EnableAdvancedSiteSearchMetadata.ProtoReflect.Descriptor instead.
func (*EnableAdvancedSiteSearchMetadata) GetCreateTime
func (x *EnableAdvancedSiteSearchMetadata) GetCreateTime() *timestamppb.Timestampfunc (*EnableAdvancedSiteSearchMetadata) GetUpdateTime
func (x *EnableAdvancedSiteSearchMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*EnableAdvancedSiteSearchMetadata) ProtoMessage
func (*EnableAdvancedSiteSearchMetadata) ProtoMessage()func (*EnableAdvancedSiteSearchMetadata) ProtoReflect
func (x *EnableAdvancedSiteSearchMetadata) ProtoReflect() protoreflect.Messagefunc (*EnableAdvancedSiteSearchMetadata) Reset
func (x *EnableAdvancedSiteSearchMetadata) Reset()func (*EnableAdvancedSiteSearchMetadata) String
func (x *EnableAdvancedSiteSearchMetadata) String() stringEnableAdvancedSiteSearchRequest
type EnableAdvancedSiteSearchRequest struct {
// Required. Full resource name of the
// [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine],
// such as
// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] method.
func (*EnableAdvancedSiteSearchRequest) Descriptor
func (*EnableAdvancedSiteSearchRequest) Descriptor() ([]byte, []int)Deprecated: Use EnableAdvancedSiteSearchRequest.ProtoReflect.Descriptor instead.
func (*EnableAdvancedSiteSearchRequest) GetSiteSearchEngine
func (x *EnableAdvancedSiteSearchRequest) GetSiteSearchEngine() stringfunc (*EnableAdvancedSiteSearchRequest) ProtoMessage
func (*EnableAdvancedSiteSearchRequest) ProtoMessage()func (*EnableAdvancedSiteSearchRequest) ProtoReflect
func (x *EnableAdvancedSiteSearchRequest) ProtoReflect() protoreflect.Messagefunc (*EnableAdvancedSiteSearchRequest) Reset
func (x *EnableAdvancedSiteSearchRequest) Reset()func (*EnableAdvancedSiteSearchRequest) String
func (x *EnableAdvancedSiteSearchRequest) String() stringEnableAdvancedSiteSearchResponse
type EnableAdvancedSiteSearchResponse struct {
// contains filtered or unexported fields
}Response message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] method.
func (*EnableAdvancedSiteSearchResponse) Descriptor
func (*EnableAdvancedSiteSearchResponse) Descriptor() ([]byte, []int)Deprecated: Use EnableAdvancedSiteSearchResponse.ProtoReflect.Descriptor instead.
func (*EnableAdvancedSiteSearchResponse) ProtoMessage
func (*EnableAdvancedSiteSearchResponse) ProtoMessage()func (*EnableAdvancedSiteSearchResponse) ProtoReflect
func (x *EnableAdvancedSiteSearchResponse) ProtoReflect() protoreflect.Messagefunc (*EnableAdvancedSiteSearchResponse) Reset
func (x *EnableAdvancedSiteSearchResponse) Reset()func (*EnableAdvancedSiteSearchResponse) String
func (x *EnableAdvancedSiteSearchResponse) String() stringEngine
type Engine struct {
// Additional config specs that defines the behavior of the engine.
//
// Types that are valid to be assigned to EngineConfig:
//
// *Engine_ChatEngineConfig_
// *Engine_SearchEngineConfig_
// *Engine_MediaRecommendationEngineConfig_
EngineConfig isEngine_EngineConfig `protobuf_oneof:"engine_config"`
// Engine metadata to monitor the status of the engine.
//
// Types that are valid to be assigned to EngineMetadata:
//
// *Engine_ChatEngineMetadata_
EngineMetadata isEngine_EngineMetadata `protobuf_oneof:"engine_metadata"`
// Immutable. Identifier. The fully qualified resource name of the engine.
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
//
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
// engine should be 1-63 characters, and valid characters are
// /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The display name of the engine. Should be human readable. UTF-8
// encoded string with limit of 1024 characters.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. Timestamp the Recommendation Engine was created at.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp the Recommendation Engine was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. The data stores associated with this engine.
//
// For
// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
// and
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
// type of engines, they can only associate with at most one data store.
//
// If
// [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
// is
// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
// multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
// same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
// associated here.
//
// Note that when used in
// [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
// one DataStore id must be provided as the system will use it for necessary
// initializations.
DataStoreIds []string `protobuf:"bytes,5,rep,name=data_store_ids,json=dataStoreIds,proto3" json:"data_store_ids,omitempty"`
// Required. The solutions of the engine.
SolutionType SolutionType `protobuf:"varint,6,opt,name=solution_type,json=solutionType,proto3,enum=google.cloud.discoveryengine.v1beta.SolutionType" json:"solution_type,omitempty"`
// Optional. The industry vertical that the engine registers.
// The restriction of the Engine industry vertical is based on
// [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: Vertical on
// Engine has to match vertical of the DataStore linked to the engine.
IndustryVertical IndustryVertical `protobuf:"varint,16,opt,name=industry_vertical,json=industryVertical,proto3,enum=google.cloud.discoveryengine.v1beta.IndustryVertical" json:"industry_vertical,omitempty"`
// Common config spec that specifies the metadata of the engine.
CommonConfig *Engine_CommonConfig `protobuf:"bytes,15,opt,name=common_config,json=commonConfig,proto3" json:"common_config,omitempty"`
// Optional. Configurations for the Knowledge Graph. Only applicable if
// [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
// is
// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
KnowledgeGraphConfig *Engine_KnowledgeGraphConfig `protobuf:"bytes,23,opt,name=knowledge_graph_config,json=knowledgeGraphConfig,proto3" json:"knowledge_graph_config,omitempty"`
// Optional. Immutable. This the application type which this engine resource
// represents. NOTE: this is a new concept independ of existing industry
// vertical or solution type.
AppType Engine_AppType `protobuf:"varint,24,opt,name=app_type,json=appType,proto3,enum=google.cloud.discoveryengine.v1beta.Engine_AppType" json:"app_type,omitempty"`
// Optional. Whether to disable analytics for searches performed on this
// engine.
DisableAnalytics bool `protobuf:"varint,26,opt,name=disable_analytics,json=disableAnalytics,proto3" json:"disable_analytics,omitempty"`
// Optional. Feature config for the engine to opt in or opt out of features.
// Supported keys:
//
// - `*`: all features, if it's present, all other feature state settings are
// ignored.
// - `agent-gallery`
// - `no-code-agent-builder`
// - `prompt-gallery`
// - `model-selector`
// - `notebook-lm`
// - `people-search`
// - `people-search-org-chart`
// - `bi-directional-audio`
// - `feedback`
// - `session-sharing`
// - `personalization-memory`
// - `personalization-suggested-highlights`
// - `mobile-app-access`
// - `disable-agent-sharing`
// - `disable-image-generation`
// - `disable-video-generation`
// - `disable-onedrive-upload`
// - `disable-talk-to-content`
// - `disable-google-drive-upload`
// - `disable-welcome-emails`
// - `disable-canvas`
// - `disable-canvas-workspace`
// - `disable-skills`
// - `enable-end-user-sharing-with-groups`
// - `single-agent-orchestration`
// - `multi-agent-orchestration`
// - `cross-product-intelligence`
Features map[string]Engine_FeatureState `protobuf:"bytes,30,rep,name=features,proto3" json:"features,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=google.cloud.discoveryengine.v1beta.Engine_FeatureState"`
// Output only. CMEK-related information for the Engine.
CmekConfig *CmekConfig `protobuf:"bytes,32,opt,name=cmek_config,json=cmekConfig,proto3" json:"cmek_config,omitempty"`
// Optional. Configuration for configurable billing approach.
ConfigurableBillingApproach Engine_ConfigurableBillingApproach `protobuf:"varint,36,opt,name=configurable_billing_approach,json=configurableBillingApproach,proto3,enum=google.cloud.discoveryengine.v1beta.Engine_ConfigurableBillingApproach" json:"configurable_billing_approach,omitempty"`
// Optional. Maps a model name to its specific configuration for this engine.
// This allows admin users to turn on/off individual models. This only stores
// models whose states are overridden by the admin.
//
// When the state is unspecified, or model_configs is empty for this
// model, the system will decide if this model should be available or not
// based on the default configuration. For example, a preview model
// should be disabled by default if the admin has not chosen to enable it.
ModelConfigs map[string]Engine_ModelState `protobuf:"bytes,37,rep,name=model_configs,json=modelConfigs,proto3" json:"model_configs,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=google.cloud.discoveryengine.v1beta.Engine_ModelState"`
// Optional. Observability config for the engine.
ObservabilityConfig *ObservabilityConfig `protobuf:"bytes,39,opt,name=observability_config,json=observabilityConfig,proto3" json:"observability_config,omitempty"`
// Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to
// tenant-specific information required for that connector. The structure of
// the tenant information string is connector-dependent.
ConnectorTenantInfo map[string]string `protobuf:"bytes,42,rep,name=connector_tenant_info,json=connectorTenantInfo,proto3" json:"connector_tenant_info,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. The agent gateway setting for the engine.
AgentGatewaySetting *AgentGatewaySetting `protobuf:"bytes,43,opt,name=agent_gateway_setting,json=agentGatewaySetting,proto3" json:"agent_gateway_setting,omitempty"`
// Optional. The visibility of marketplace agents in the agent gallery.
MarketplaceAgentVisibility Engine_MarketplaceAgentVisibility `protobuf:"varint,44,opt,name=marketplace_agent_visibility,json=marketplaceAgentVisibility,proto3,enum=google.cloud.discoveryengine.v1beta.Engine_MarketplaceAgentVisibility" json:"marketplace_agent_visibility,omitempty"`
// Optional. The emails of the procurement contacts.
ProcurementContactEmails []string `protobuf:"bytes,45,rep,name=procurement_contact_emails,json=procurementContactEmails,proto3" json:"procurement_contact_emails,omitempty"`
// contains filtered or unexported fields
}Metadata that describes the training and serving parameters of an [Engine][google.cloud.discoveryengine.v1beta.Engine].
func (*Engine) Descriptor
Deprecated: Use Engine.ProtoReflect.Descriptor instead.
func (*Engine) GetAgentGatewaySetting
func (x *Engine) GetAgentGatewaySetting() *AgentGatewaySettingfunc (*Engine) GetAppType
func (x *Engine) GetAppType() Engine_AppTypefunc (*Engine) GetChatEngineConfig
func (x *Engine) GetChatEngineConfig() *Engine_ChatEngineConfigfunc (*Engine) GetChatEngineMetadata
func (x *Engine) GetChatEngineMetadata() *Engine_ChatEngineMetadatafunc (*Engine) GetCmekConfig
func (x *Engine) GetCmekConfig() *CmekConfigfunc (*Engine) GetCommonConfig
func (x *Engine) GetCommonConfig() *Engine_CommonConfigfunc (*Engine) GetConfigurableBillingApproach
func (x *Engine) GetConfigurableBillingApproach() Engine_ConfigurableBillingApproachfunc (*Engine) GetConnectorTenantInfo
func (*Engine) GetCreateTime
func (x *Engine) GetCreateTime() *timestamppb.Timestampfunc (*Engine) GetDataStoreIds
func (*Engine) GetDisableAnalytics
func (*Engine) GetDisplayName
func (*Engine) GetEngineConfig
func (x *Engine) GetEngineConfig() isEngine_EngineConfigfunc (*Engine) GetEngineMetadata
func (x *Engine) GetEngineMetadata() isEngine_EngineMetadatafunc (*Engine) GetFeatures
func (x *Engine) GetFeatures() map[string]Engine_FeatureStatefunc (*Engine) GetIndustryVertical
func (x *Engine) GetIndustryVertical() IndustryVerticalfunc (*Engine) GetKnowledgeGraphConfig
func (x *Engine) GetKnowledgeGraphConfig() *Engine_KnowledgeGraphConfigfunc (*Engine) GetMarketplaceAgentVisibility
func (x *Engine) GetMarketplaceAgentVisibility() Engine_MarketplaceAgentVisibilityfunc (*Engine) GetMediaRecommendationEngineConfig
func (x *Engine) GetMediaRecommendationEngineConfig() *Engine_MediaRecommendationEngineConfigfunc (*Engine) GetModelConfigs
func (x *Engine) GetModelConfigs() map[string]Engine_ModelStatefunc (*Engine) GetName
func (*Engine) GetObservabilityConfig
func (x *Engine) GetObservabilityConfig() *ObservabilityConfigfunc (*Engine) GetProcurementContactEmails
func (*Engine) GetSearchEngineConfig
func (x *Engine) GetSearchEngineConfig() *Engine_SearchEngineConfigfunc (*Engine) GetSolutionType
func (x *Engine) GetSolutionType() SolutionTypefunc (*Engine) GetUpdateTime
func (x</