Constants
AclConfigService_UpdateAclConfig_FullMethodName, AclConfigService_GetAclConfig_FullMethodName
const (
AclConfigService_UpdateAclConfig_FullMethodName = "/google.cloud.discoveryengine.v1alpha.AclConfigService/UpdateAclConfig"
AclConfigService_GetAclConfig_FullMethodName = "/google.cloud.discoveryengine.v1alpha.AclConfigService/GetAclConfig"
)ChunkService_GetChunk_FullMethodName, ChunkService_ListChunks_FullMethodName
const (
ChunkService_GetChunk_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ChunkService/GetChunk"
ChunkService_ListChunks_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ChunkService/ListChunks"
)CompletionService_CompleteQuery_FullMethodName, CompletionService_ImportSuggestionDenyListEntries_FullMethodName, CompletionService_PurgeSuggestionDenyListEntries_FullMethodName, CompletionService_ImportCompletionSuggestions_FullMethodName, CompletionService_PurgeCompletionSuggestions_FullMethodName
const (
CompletionService_CompleteQuery_FullMethodName = "/google.cloud.discoveryengine.v1alpha.CompletionService/CompleteQuery"
CompletionService_ImportSuggestionDenyListEntries_FullMethodName = "/google.cloud.discoveryengine.v1alpha.CompletionService/ImportSuggestionDenyListEntries"
CompletionService_PurgeSuggestionDenyListEntries_FullMethodName = "/google.cloud.discoveryengine.v1alpha.CompletionService/PurgeSuggestionDenyListEntries"
CompletionService_ImportCompletionSuggestions_FullMethodName = "/google.cloud.discoveryengine.v1alpha.CompletionService/ImportCompletionSuggestions"
CompletionService_PurgeCompletionSuggestions_FullMethodName = "/google.cloud.discoveryengine.v1alpha.CompletionService/PurgeCompletionSuggestions"
)ControlService_CreateControl_FullMethodName, ControlService_DeleteControl_FullMethodName, ControlService_UpdateControl_FullMethodName, ControlService_GetControl_FullMethodName, ControlService_ListControls_FullMethodName
const (
ControlService_CreateControl_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ControlService/CreateControl"
ControlService_DeleteControl_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ControlService/DeleteControl"
ControlService_UpdateControl_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ControlService/UpdateControl"
ControlService_GetControl_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ControlService/GetControl"
ControlService_ListControls_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ControlService/ListControls"
)ConversationalSearchService_ConverseConversation_FullMethodName, ConversationalSearchService_CreateConversation_FullMethodName, ConversationalSearchService_DeleteConversation_FullMethodName, ConversationalSearchService_UpdateConversation_FullMethodName, ConversationalSearchService_GetConversation_FullMethodName, ConversationalSearchService_ListConversations_FullMethodName, ConversationalSearchService_AnswerQuery_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.v1alpha.ConversationalSearchService/ConverseConversation"
ConversationalSearchService_CreateConversation_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/CreateConversation"
ConversationalSearchService_DeleteConversation_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/DeleteConversation"
ConversationalSearchService_UpdateConversation_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/UpdateConversation"
ConversationalSearchService_GetConversation_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/GetConversation"
ConversationalSearchService_ListConversations_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/ListConversations"
ConversationalSearchService_AnswerQuery_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/AnswerQuery"
ConversationalSearchService_GetAnswer_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/GetAnswer"
ConversationalSearchService_CreateSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/CreateSession"
ConversationalSearchService_DeleteSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/DeleteSession"
ConversationalSearchService_UpdateSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/UpdateSession"
ConversationalSearchService_GetSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/GetSession"
ConversationalSearchService_ListSessions_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ConversationalSearchService/ListSessions"
)DataStoreService_CreateDataStore_FullMethodName, DataStoreService_GetDataStore_FullMethodName, DataStoreService_ListDataStores_FullMethodName, DataStoreService_DeleteDataStore_FullMethodName, DataStoreService_UpdateDataStore_FullMethodName, DataStoreService_GetDocumentProcessingConfig_FullMethodName, DataStoreService_UpdateDocumentProcessingConfig_FullMethodName
const (
DataStoreService_CreateDataStore_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DataStoreService/CreateDataStore"
DataStoreService_GetDataStore_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DataStoreService/GetDataStore"
DataStoreService_ListDataStores_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DataStoreService/ListDataStores"
DataStoreService_DeleteDataStore_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DataStoreService/DeleteDataStore"
DataStoreService_UpdateDataStore_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DataStoreService/UpdateDataStore"
DataStoreService_GetDocumentProcessingConfig_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DataStoreService/GetDocumentProcessingConfig"
DataStoreService_UpdateDocumentProcessingConfig_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DataStoreService/UpdateDocumentProcessingConfig"
)DocumentService_GetDocument_FullMethodName, DocumentService_ListDocuments_FullMethodName, DocumentService_CreateDocument_FullMethodName, DocumentService_UpdateDocument_FullMethodName, DocumentService_DeleteDocument_FullMethodName, DocumentService_ImportDocuments_FullMethodName, DocumentService_PurgeDocuments_FullMethodName, DocumentService_GetProcessedDocument_FullMethodName, DocumentService_BatchGetDocumentsMetadata_FullMethodName
const (
DocumentService_GetDocument_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DocumentService/GetDocument"
DocumentService_ListDocuments_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DocumentService/ListDocuments"
DocumentService_CreateDocument_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DocumentService/CreateDocument"
DocumentService_UpdateDocument_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DocumentService/UpdateDocument"
DocumentService_DeleteDocument_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DocumentService/DeleteDocument"
DocumentService_ImportDocuments_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DocumentService/ImportDocuments"
DocumentService_PurgeDocuments_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DocumentService/PurgeDocuments"
DocumentService_GetProcessedDocument_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DocumentService/GetProcessedDocument"
DocumentService_BatchGetDocumentsMetadata_FullMethodName = "/google.cloud.discoveryengine.v1alpha.DocumentService/BatchGetDocumentsMetadata"
)EngineService_CreateEngine_FullMethodName, EngineService_DeleteEngine_FullMethodName, EngineService_UpdateEngine_FullMethodName, EngineService_GetEngine_FullMethodName, EngineService_ListEngines_FullMethodName, EngineService_PauseEngine_FullMethodName, EngineService_ResumeEngine_FullMethodName, EngineService_TuneEngine_FullMethodName
const (
EngineService_CreateEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/CreateEngine"
EngineService_DeleteEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/DeleteEngine"
EngineService_UpdateEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/UpdateEngine"
EngineService_GetEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/GetEngine"
EngineService_ListEngines_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/ListEngines"
EngineService_PauseEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/PauseEngine"
EngineService_ResumeEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/ResumeEngine"
EngineService_TuneEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EngineService/TuneEngine"
)EvaluationService_GetEvaluation_FullMethodName, EvaluationService_ListEvaluations_FullMethodName, EvaluationService_CreateEvaluation_FullMethodName, EvaluationService_ListEvaluationResults_FullMethodName
const (
EvaluationService_GetEvaluation_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EvaluationService/GetEvaluation"
EvaluationService_ListEvaluations_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EvaluationService/ListEvaluations"
EvaluationService_CreateEvaluation_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EvaluationService/CreateEvaluation"
EvaluationService_ListEvaluationResults_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EvaluationService/ListEvaluationResults"
)ProjectService_GetProject_FullMethodName, ProjectService_ProvisionProject_FullMethodName, ProjectService_ReportConsentChange_FullMethodName
const (
ProjectService_GetProject_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ProjectService/GetProject"
ProjectService_ProvisionProject_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ProjectService/ProvisionProject"
ProjectService_ReportConsentChange_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ProjectService/ReportConsentChange"
)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.v1alpha.SampleQueryService/GetSampleQuery"
SampleQueryService_ListSampleQueries_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/ListSampleQueries"
SampleQueryService_CreateSampleQuery_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/CreateSampleQuery"
SampleQueryService_UpdateSampleQuery_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/UpdateSampleQuery"
SampleQueryService_DeleteSampleQuery_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/DeleteSampleQuery"
SampleQueryService_ImportSampleQueries_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQueryService/ImportSampleQueries"
)SampleQuerySetService_GetSampleQuerySet_FullMethodName, SampleQuerySetService_ListSampleQuerySets_FullMethodName, SampleQuerySetService_CreateSampleQuerySet_FullMethodName, SampleQuerySetService_UpdateSampleQuerySet_FullMethodName, SampleQuerySetService_DeleteSampleQuerySet_FullMethodName
const (
SampleQuerySetService_GetSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQuerySetService/GetSampleQuerySet"
SampleQuerySetService_ListSampleQuerySets_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQuerySetService/ListSampleQuerySets"
SampleQuerySetService_CreateSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQuerySetService/CreateSampleQuerySet"
SampleQuerySetService_UpdateSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQuerySetService/UpdateSampleQuerySet"
SampleQuerySetService_DeleteSampleQuerySet_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SampleQuerySetService/DeleteSampleQuerySet"
)SchemaService_GetSchema_FullMethodName, SchemaService_ListSchemas_FullMethodName, SchemaService_CreateSchema_FullMethodName, SchemaService_UpdateSchema_FullMethodName, SchemaService_DeleteSchema_FullMethodName
const (
SchemaService_GetSchema_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SchemaService/GetSchema"
SchemaService_ListSchemas_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SchemaService/ListSchemas"
SchemaService_CreateSchema_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SchemaService/CreateSchema"
SchemaService_UpdateSchema_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SchemaService/UpdateSchema"
SchemaService_DeleteSchema_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SchemaService/DeleteSchema"
)SearchTuningService_TrainCustomModel_FullMethodName, SearchTuningService_ListCustomModels_FullMethodName
const (
SearchTuningService_TrainCustomModel_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SearchTuningService/TrainCustomModel"
SearchTuningService_ListCustomModels_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SearchTuningService/ListCustomModels"
)ServingConfigService_UpdateServingConfig_FullMethodName, ServingConfigService_GetServingConfig_FullMethodName, ServingConfigService_ListServingConfigs_FullMethodName
const (
ServingConfigService_UpdateServingConfig_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ServingConfigService/UpdateServingConfig"
ServingConfigService_GetServingConfig_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ServingConfigService/GetServingConfig"
ServingConfigService_ListServingConfigs_FullMethodName = "/google.cloud.discoveryengine.v1alpha.ServingConfigService/ListServingConfigs"
)SessionService_CreateSession_FullMethodName, SessionService_DeleteSession_FullMethodName, SessionService_UpdateSession_FullMethodName, SessionService_GetSession_FullMethodName, SessionService_ListSessions_FullMethodName, SessionService_ListFiles_FullMethodName
const (
SessionService_CreateSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SessionService/CreateSession"
SessionService_DeleteSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SessionService/DeleteSession"
SessionService_UpdateSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SessionService/UpdateSession"
SessionService_GetSession_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SessionService/GetSession"
SessionService_ListSessions_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SessionService/ListSessions"
SessionService_ListFiles_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SessionService/ListFiles"
)SiteSearchEngineService_GetSiteSearchEngine_FullMethodName, SiteSearchEngineService_CreateTargetSite_FullMethodName, SiteSearchEngineService_BatchCreateTargetSites_FullMethodName, SiteSearchEngineService_GetTargetSite_FullMethodName, SiteSearchEngineService_UpdateTargetSite_FullMethodName, SiteSearchEngineService_DeleteTargetSite_FullMethodName, SiteSearchEngineService_ListTargetSites_FullMethodName, SiteSearchEngineService_EnableAdvancedSiteSearch_FullMethodName, SiteSearchEngineService_DisableAdvancedSiteSearch_FullMethodName, SiteSearchEngineService_RecrawlUris_FullMethodName, SiteSearchEngineService_BatchVerifyTargetSites_FullMethodName, SiteSearchEngineService_FetchDomainVerificationStatus_FullMethodName, SiteSearchEngineService_SetUriPatternDocumentData_FullMethodName, SiteSearchEngineService_GetUriPatternDocumentData_FullMethodName
const (
SiteSearchEngineService_GetSiteSearchEngine_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/GetSiteSearchEngine"
SiteSearchEngineService_CreateTargetSite_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/CreateTargetSite"
SiteSearchEngineService_BatchCreateTargetSites_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/BatchCreateTargetSites"
SiteSearchEngineService_GetTargetSite_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/GetTargetSite"
SiteSearchEngineService_UpdateTargetSite_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/UpdateTargetSite"
SiteSearchEngineService_DeleteTargetSite_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/DeleteTargetSite"
SiteSearchEngineService_ListTargetSites_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/ListTargetSites"
SiteSearchEngineService_EnableAdvancedSiteSearch_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/EnableAdvancedSiteSearch"
SiteSearchEngineService_DisableAdvancedSiteSearch_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/DisableAdvancedSiteSearch"
SiteSearchEngineService_RecrawlUris_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/RecrawlUris"
SiteSearchEngineService_BatchVerifyTargetSites_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/BatchVerifyTargetSites"
SiteSearchEngineService_FetchDomainVerificationStatus_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/FetchDomainVerificationStatus"
SiteSearchEngineService_SetUriPatternDocumentData_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/SetUriPatternDocumentData"
SiteSearchEngineService_GetUriPatternDocumentData_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SiteSearchEngineService/GetUriPatternDocumentData"
)UserEventService_WriteUserEvent_FullMethodName, UserEventService_CollectUserEvent_FullMethodName, UserEventService_PurgeUserEvents_FullMethodName, UserEventService_ImportUserEvents_FullMethodName
const (
UserEventService_WriteUserEvent_FullMethodName = "/google.cloud.discoveryengine.v1alpha.UserEventService/WriteUserEvent"
UserEventService_CollectUserEvent_FullMethodName = "/google.cloud.discoveryengine.v1alpha.UserEventService/CollectUserEvent"
UserEventService_PurgeUserEvents_FullMethodName = "/google.cloud.discoveryengine.v1alpha.UserEventService/PurgeUserEvents"
UserEventService_ImportUserEvents_FullMethodName = "/google.cloud.discoveryengine.v1alpha.UserEventService/ImportUserEvents"
)EstimateBillingService_EstimateDataSize_FullMethodName
const (
EstimateBillingService_EstimateDataSize_FullMethodName = "/google.cloud.discoveryengine.v1alpha.EstimateBillingService/EstimateDataSize"
)GroundedGenerationService_CheckGrounding_FullMethodName
const (
GroundedGenerationService_CheckGrounding_FullMethodName = "/google.cloud.discoveryengine.v1alpha.GroundedGenerationService/CheckGrounding"
)RankService_Rank_FullMethodName
const (
RankService_Rank_FullMethodName = "/google.cloud.discoveryengine.v1alpha.RankService/Rank"
)RecommendationService_Recommend_FullMethodName
const (
RecommendationService_Recommend_FullMethodName = "/google.cloud.discoveryengine.v1alpha.RecommendationService/Recommend"
)SearchService_Search_FullMethodName
const (
SearchService_Search_FullMethodName = "/google.cloud.discoveryengine.v1alpha.SearchService/Search"
)Variables
Answer_State_name, Answer_State_value
var (
Answer_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "IN_PROGRESS",
2: "FAILED",
3: "SUCCEEDED",
}
Answer_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"IN_PROGRESS": 1,
"FAILED": 2,
"SUCCEEDED": 3,
}
)Enum value maps for Answer_State.
Answer_AnswerSkippedReason_name, Answer_AnswerSkippedReason_value
var (
Answer_AnswerSkippedReason_name = map[int32]string{
0: "ANSWER_SKIPPED_REASON_UNSPECIFIED",
1: "ADVERSARIAL_QUERY_IGNORED",
2: "NON_ANSWER_SEEKING_QUERY_IGNORED",
3: "OUT_OF_DOMAIN_QUERY_IGNORED",
4: "POTENTIAL_POLICY_VIOLATION",
5: "NO_RELEVANT_CONTENT",
6: "JAIL_BREAKING_QUERY_IGNORED",
7: "CUSTOMER_POLICY_VIOLATION",
}
Answer_AnswerSkippedReason_value = map[string]int32{
"ANSWER_SKIPPED_REASON_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY_IGNORED": 1,
"NON_ANSWER_SEEKING_QUERY_IGNORED": 2,
"OUT_OF_DOMAIN_QUERY_IGNORED": 3,
"POTENTIAL_POLICY_VIOLATION": 4,
"NO_RELEVANT_CONTENT": 5,
"JAIL_BREAKING_QUERY_IGNORED": 6,
"CUSTOMER_POLICY_VIOLATION": 7,
}
)Enum value maps for Answer_AnswerSkippedReason.
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",
}
Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY": 1,
"NON_ANSWER_SEEKING_QUERY": 2,
"JAIL_BREAKING_QUERY": 3,
}
)Enum value maps for Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type.
IndustryVertical_name, IndustryVertical_value
var (
IndustryVertical_name = map[int32]string{
0: "INDUSTRY_VERTICAL_UNSPECIFIED",
1: "GENERIC",
2: "MEDIA",
7: "HEALTHCARE_FHIR",
}
IndustryVertical_value = map[string]int32{
"INDUSTRY_VERTICAL_UNSPECIFIED": 0,
"GENERIC": 1,
"MEDIA": 2,
"HEALTHCARE_FHIR": 7,
}
)Enum value maps for IndustryVertical.
SolutionType_name, SolutionType_value
var (
SolutionType_name = map[int32]string{
0: "SOLUTION_TYPE_UNSPECIFIED",
1: "SOLUTION_TYPE_RECOMMENDATION",
2: "SOLUTION_TYPE_SEARCH",
3: "SOLUTION_TYPE_CHAT",
4: "SOLUTION_TYPE_GENERATIVE_CHAT",
}
SolutionType_value = map[string]int32{
"SOLUTION_TYPE_UNSPECIFIED": 0,
"SOLUTION_TYPE_RECOMMENDATION": 1,
"SOLUTION_TYPE_SEARCH": 2,
"SOLUTION_TYPE_CHAT": 3,
"SOLUTION_TYPE_GENERATIVE_CHAT": 4,
}
)Enum value maps for SolutionType.
SearchUseCase_name, SearchUseCase_value
var (
SearchUseCase_name = map[int32]string{
0: "SEARCH_USE_CASE_UNSPECIFIED",
1: "SEARCH_USE_CASE_SEARCH",
2: "SEARCH_USE_CASE_BROWSE",
}
SearchUseCase_value = map[string]int32{
"SEARCH_USE_CASE_UNSPECIFIED": 0,
"SEARCH_USE_CASE_SEARCH": 1,
"SEARCH_USE_CASE_BROWSE": 2,
}
)Enum value maps for SearchUseCase.
SearchTier_name, SearchTier_value
var (
SearchTier_name = map[int32]string{
0: "SEARCH_TIER_UNSPECIFIED",
1: "SEARCH_TIER_STANDARD",
2: "SEARCH_TIER_ENTERPRISE",
}
SearchTier_value = map[string]int32{
"SEARCH_TIER_UNSPECIFIED": 0,
"SEARCH_TIER_STANDARD": 1,
"SEARCH_TIER_ENTERPRISE": 2,
}
)Enum value maps for SearchTier.
SearchAddOn_name, SearchAddOn_value
var (
SearchAddOn_name = map[int32]string{
0: "SEARCH_ADD_ON_UNSPECIFIED",
1: "SEARCH_ADD_ON_LLM",
}
SearchAddOn_value = map[string]int32{
"SEARCH_ADD_ON_UNSPECIFIED": 0,
"SEARCH_ADD_ON_LLM": 1,
}
)Enum value maps for SearchAddOn.
FileOriginType_name, FileOriginType_value
var (
FileOriginType_name = map[int32]string{
0: "FILE_ORIGIN_TYPE_UNSPECIFIED",
1: "USER_PROVIDED",
2: "AI_GENERATED",
3: "INTERNALLY_GENERATED",
}
FileOriginType_value = map[string]int32{
"FILE_ORIGIN_TYPE_UNSPECIFIED": 0,
"USER_PROVIDED": 1,
"AI_GENERATED": 2,
"INTERNALLY_GENERATED": 3,
}
)Enum value maps for FileOriginType.
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.
Conversation_State_name, Conversation_State_value
var (
Conversation_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "IN_PROGRESS",
2: "COMPLETED",
}
Conversation_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"IN_PROGRESS": 1,
"COMPLETED": 2,
}
)Enum value maps for Conversation_State.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_name, AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_value
var (
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "ADVERSARIAL_QUERY",
2: "NON_ANSWER_SEEKING_QUERY",
3: "JAIL_BREAKING_QUERY",
}
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY": 1,
"NON_ANSWER_SEEKING_QUERY": 2,
"JAIL_BREAKING_QUERY": 3,
}
)Enum value maps for AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type.
CustomTuningModel_ModelState_name, CustomTuningModel_ModelState_value
var (
CustomTuningModel_ModelState_name = map[int32]string{
0: "MODEL_STATE_UNSPECIFIED",
1: "TRAINING_PAUSED",
2: "TRAINING",
3: "TRAINING_COMPLETE",
4: "READY_FOR_SERVING",
5: "TRAINING_FAILED",
6: "NO_IMPROVEMENT",
7: "INPUT_VALIDATION_FAILED",
}
CustomTuningModel_ModelState_value = map[string]int32{
"MODEL_STATE_UNSPECIFIED": 0,
"TRAINING_PAUSED": 1,
"TRAINING": 2,
"TRAINING_COMPLETE": 3,
"READY_FOR_SERVING": 4,
"TRAINING_FAILED": 5,
"NO_IMPROVEMENT": 6,
"INPUT_VALIDATION_FAILED": 7,
}
)Enum value maps for CustomTuningModel_ModelState.
DataStore_ContentConfig_name, DataStore_ContentConfig_value
var (
DataStore_ContentConfig_name = map[int32]string{
0: "CONTENT_CONFIG_UNSPECIFIED",
1: "NO_CONTENT",
2: "CONTENT_REQUIRED",
3: "PUBLIC_WEBSITE",
4: "GOOGLE_WORKSPACE",
}
DataStore_ContentConfig_value = map[string]int32{
"CONTENT_CONFIG_UNSPECIFIED": 0,
"NO_CONTENT": 1,
"CONTENT_REQUIRED": 2,
"PUBLIC_WEBSITE": 3,
"GOOGLE_WORKSPACE": 4,
}
)Enum value maps for DataStore_ContentConfig.
WorkspaceConfig_Type_name, WorkspaceConfig_Type_value
var (
WorkspaceConfig_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "GOOGLE_DRIVE",
2: "GOOGLE_MAIL",
3: "GOOGLE_SITES",
4: "GOOGLE_CALENDAR",
5: "GOOGLE_CHAT",
6: "GOOGLE_GROUPS",
7: "GOOGLE_KEEP",
}
WorkspaceConfig_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"GOOGLE_DRIVE": 1,
"GOOGLE_MAIL": 2,
"GOOGLE_SITES": 3,
"GOOGLE_CALENDAR": 4,
"GOOGLE_CHAT": 5,
"GOOGLE_GROUPS": 6,
"GOOGLE_KEEP": 7,
}
)Enum value maps for WorkspaceConfig_Type.
GetProcessedDocumentRequest_ProcessedDocumentType_name, GetProcessedDocumentRequest_ProcessedDocumentType_value
var (
GetProcessedDocumentRequest_ProcessedDocumentType_name = map[int32]string{
0: "PROCESSED_DOCUMENT_TYPE_UNSPECIFIED",
1: "PARSED_DOCUMENT",
2: "CHUNKED_DOCUMENT",
3: "PNG_CONVERTED_DOCUMENT",
}
GetProcessedDocumentRequest_ProcessedDocumentType_value = map[string]int32{
"PROCESSED_DOCUMENT_TYPE_UNSPECIFIED": 0,
"PARSED_DOCUMENT": 1,
"CHUNKED_DOCUMENT": 2,
"PNG_CONVERTED_DOCUMENT": 3,
}
)Enum value maps for GetProcessedDocumentRequest_ProcessedDocumentType.
GetProcessedDocumentRequest_ProcessedDocumentFormat_name, GetProcessedDocumentRequest_ProcessedDocumentFormat_value
var (
GetProcessedDocumentRequest_ProcessedDocumentFormat_name = map[int32]string{
0: "PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED",
1: "JSON",
}
GetProcessedDocumentRequest_ProcessedDocumentFormat_value = map[string]int32{
"PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED": 0,
"JSON": 1,
}
)Enum value maps for GetProcessedDocumentRequest_ProcessedDocumentFormat.
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_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.
Engine_RecommendationMetadata_ServingState_name, Engine_RecommendationMetadata_ServingState_value
var (
Engine_RecommendationMetadata_ServingState_name = map[int32]string{
0: "SERVING_STATE_UNSPECIFIED",
1: "INACTIVE",
2: "ACTIVE",
3: "TUNED",
}
Engine_RecommendationMetadata_ServingState_value = map[string]int32{
"SERVING_STATE_UNSPECIFIED": 0,
"INACTIVE": 1,
"ACTIVE": 2,
"TUNED": 3,
}
)Enum value maps for Engine_RecommendationMetadata_ServingState.
Engine_RecommendationMetadata_DataState_name, Engine_RecommendationMetadata_DataState_value
var (
Engine_RecommendationMetadata_DataState_name = map[int32]string{
0: "DATA_STATE_UNSPECIFIED",
1: "DATA_OK",
2: "DATA_ERROR",
}
Engine_RecommendationMetadata_DataState_value = map[string]int32{
"DATA_STATE_UNSPECIFIED": 0,
"DATA_OK": 1,
"DATA_ERROR": 2,
}
)Enum value maps for Engine_RecommendationMetadata_DataState.
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.
BigtableOptions_Type_name, BigtableOptions_Type_value
var (
BigtableOptions_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "STRING",
2: "NUMBER",
3: "INTEGER",
4: "VAR_INTEGER",
5: "BIG_NUMERIC",
6: "BOOLEAN",
7: "JSON",
}
BigtableOptions_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"STRING": 1,
"NUMBER": 2,
"INTEGER": 3,
"VAR_INTEGER": 4,
"BIG_NUMERIC": 5,
"BOOLEAN": 6,
"JSON": 7,
}
)Enum value maps for BigtableOptions_Type.
BigtableOptions_Encoding_name, BigtableOptions_Encoding_value
var (
BigtableOptions_Encoding_name = map[int32]string{
0: "ENCODING_UNSPECIFIED",
1: "TEXT",
2: "BINARY",
}
BigtableOptions_Encoding_value = map[string]int32{
"ENCODING_UNSPECIFIED": 0,
"TEXT": 1,
"BINARY": 2,
}
)Enum value maps for BigtableOptions_Encoding.
ImportDocumentsRequest_ReconciliationMode_name, ImportDocumentsRequest_ReconciliationMode_value
var (
ImportDocumentsRequest_ReconciliationMode_name = map[int32]string{
0: "RECONCILIATION_MODE_UNSPECIFIED",
1: "INCREMENTAL",
2: "FULL",
}
ImportDocumentsRequest_ReconciliationMode_value = map[string]int32{
"RECONCILIATION_MODE_UNSPECIFIED": 0,
"INCREMENTAL": 1,
"FULL": 2,
}
)Enum value maps for ImportDocumentsRequest_ReconciliationMode.
Project_ServiceTerms_State_name, Project_ServiceTerms_State_value
var (
Project_ServiceTerms_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "TERMS_ACCEPTED",
2: "TERMS_PENDING",
3: "TERMS_DECLINED",
}
Project_ServiceTerms_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"TERMS_ACCEPTED": 1,
"TERMS_PENDING": 2,
"TERMS_DECLINED": 3,
}
)Enum value maps for Project_ServiceTerms_State.
ReportConsentChangeRequest_ConsentChangeAction_name, ReportConsentChangeRequest_ConsentChangeAction_value
var (
ReportConsentChangeRequest_ConsentChangeAction_name = map[int32]string{
0: "CONSENT_CHANGE_ACTION_UNSPECIFIED",
1: "ACCEPT",
}
ReportConsentChangeRequest_ConsentChangeAction_value = map[string]int32{
"CONSENT_CHANGE_ACTION_UNSPECIFIED": 0,
"ACCEPT": 1,
}
)Enum value maps for ReportConsentChangeRequest_ConsentChangeAction.
FieldConfig_FieldType_name, FieldConfig_FieldType_value
var (
FieldConfig_FieldType_name = map[int32]string{
0: "FIELD_TYPE_UNSPECIFIED",
1: "OBJECT",
2: "STRING",
3: "NUMBER",
4: "INTEGER",
5: "BOOLEAN",
6: "GEOLOCATION",
7: "DATETIME",
}
FieldConfig_FieldType_value = map[string]int32{
"FIELD_TYPE_UNSPECIFIED": 0,
"OBJECT": 1,
"STRING": 2,
"NUMBER": 3,
"INTEGER": 4,
"BOOLEAN": 5,
"GEOLOCATION": 6,
"DATETIME": 7,
}
)Enum value maps for FieldConfig_FieldType.
FieldConfig_IndexableOption_name, FieldConfig_IndexableOption_value
var (
FieldConfig_IndexableOption_name = map[int32]string{
0: "INDEXABLE_OPTION_UNSPECIFIED",
1: "INDEXABLE_ENABLED",
2: "INDEXABLE_DISABLED",
}
FieldConfig_IndexableOption_value = map[string]int32{
"INDEXABLE_OPTION_UNSPECIFIED": 0,
"INDEXABLE_ENABLED": 1,
"INDEXABLE_DISABLED": 2,
}
)Enum value maps for FieldConfig_IndexableOption.
FieldConfig_DynamicFacetableOption_name, FieldConfig_DynamicFacetableOption_value
var (
FieldConfig_DynamicFacetableOption_name = map[int32]string{
0: "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED",
1: "DYNAMIC_FACETABLE_ENABLED",
2: "DYNAMIC_FACETABLE_DISABLED",
}
FieldConfig_DynamicFacetableOption_value = map[string]int32{
"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED": 0,
"DYNAMIC_FACETABLE_ENABLED": 1,
"DYNAMIC_FACETABLE_DISABLED": 2,
}
)Enum value maps for FieldConfig_DynamicFacetableOption.
FieldConfig_SearchableOption_name, FieldConfig_SearchableOption_value
var (
FieldConfig_SearchableOption_name = map[int32]string{
0: "SEARCHABLE_OPTION_UNSPECIFIED",
1: "SEARCHABLE_ENABLED",
2: "SEARCHABLE_DISABLED",
}
FieldConfig_SearchableOption_value = map[string]int32{
"SEARCHABLE_OPTION_UNSPECIFIED": 0,
"SEARCHABLE_ENABLED": 1,
"SEARCHABLE_DISABLED": 2,
}
)Enum value maps for FieldConfig_SearchableOption.
FieldConfig_RetrievableOption_name, FieldConfig_RetrievableOption_value
var (
FieldConfig_RetrievableOption_name = map[int32]string{
0: "RETRIEVABLE_OPTION_UNSPECIFIED",
1: "RETRIEVABLE_ENABLED",
2: "RETRIEVABLE_DISABLED",
}
FieldConfig_RetrievableOption_value = map[string]int32{
"RETRIEVABLE_OPTION_UNSPECIFIED": 0,
"RETRIEVABLE_ENABLED": 1,
"RETRIEVABLE_DISABLED": 2,
}
)Enum value maps for FieldConfig_RetrievableOption.
FieldConfig_CompletableOption_name, FieldConfig_CompletableOption_value
var (
FieldConfig_CompletableOption_name = map[int32]string{
0: "COMPLETABLE_OPTION_UNSPECIFIED",
1: "COMPLETABLE_ENABLED",
2: "COMPLETABLE_DISABLED",
}
FieldConfig_CompletableOption_value = map[string]int32{
"COMPLETABLE_OPTION_UNSPECIFIED": 0,
"COMPLETABLE_ENABLED": 1,
"COMPLETABLE_DISABLED": 2,
}
)Enum value maps for FieldConfig_CompletableOption.
FieldConfig_FilterableOption_name, FieldConfig_FilterableOption_value
var (
FieldConfig_FilterableOption_name = map[int32]string{
0: "FILTERABLE_OPTION_UNSPECIFIED",
1: "FILTERABLE_ENABLED",
2: "FILTERABLE_DISABLED",
}
FieldConfig_FilterableOption_value = map[string]int32{
"FILTERABLE_OPTION_UNSPECIFIED": 0,
"FILTERABLE_ENABLED": 1,
"FILTERABLE_DISABLED": 2,
}
)Enum value maps for FieldConfig_FilterableOption.
FieldConfig_AdvancedSiteSearchDataSource_name, FieldConfig_AdvancedSiteSearchDataSource_value
var (
FieldConfig_AdvancedSiteSearchDataSource_name = map[int32]string{
0: "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED",
1: "METATAGS",
2: "PAGEMAP",
3: "URI_PATTERN_MAPPING",
4: "SCHEMA_ORG",
}
FieldConfig_AdvancedSiteSearchDataSource_value = map[string]int32{
"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED": 0,
"METATAGS": 1,
"PAGEMAP": 2,
"URI_PATTERN_MAPPING": 3,
"SCHEMA_ORG": 4,
}
)Enum value maps for FieldConfig_AdvancedSiteSearchDataSource.
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_RankingExpressionBackend_name, SearchRequest_RankingExpressionBackend_value
var (
SearchRequest_RankingExpressionBackend_name = map[int32]string{
0: "RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
3: "RANK_BY_EMBEDDING",
4: "RANK_BY_FORMULA",
}
SearchRequest_RankingExpressionBackend_value = map[string]int32{
"RANKING_EXPRESSION_BACKEND_UNSPECIFIED": 0,
"RANK_BY_EMBEDDING": 3,
"RANK_BY_FORMULA": 4,
}
)Enum value maps for SearchRequest_RankingExpressionBackend.
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_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_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.
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",
}
SearchResponse_Summary_SummarySkippedReason_value = map[string]int32{
"SUMMARY_SKIPPED_REASON_UNSPECIFIED": 0,
"ADVERSARIAL_QUERY_IGNORED": 1,
"NON_SUMMARY_SEEKING_QUERY_IGNORED": 2,
"OUT_OF_DOMAIN_QUERY_IGNORED": 3,
"POTENTIAL_POLICY_VIOLATION": 4,
"LLM_ADDON_NOT_ENABLED": 5,
"NO_RELEVANT_CONTENT": 6,
"JAIL_BREAKING_QUERY_IGNORED": 7,
"CUSTOMER_POLICY_VIOLATION": 8,
"NON_SUMMARY_SEEKING_QUERY_IGNORED_V2": 9,
}
)Enum value maps for SearchResponse_Summary_SummarySkippedReason.
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",
}
SearchResponse_OneBoxResult_OneBoxType_value = map[string]int32{
"ONE_BOX_TYPE_UNSPECIFIED": 0,
"PEOPLE": 1,
"ORGANIZATION": 2,
"SLACK": 3,
}
)Enum value maps for SearchResponse_OneBoxResult_OneBoxType.
FileSource_name, FileSource_value
var (
FileSource_name = map[int32]string{
0: "FILE_SOURCE_UNSPECIFIED",
1: "FILE_SOURCE_INLINE",
2: "FILE_SOURCE_LOCAL",
3: "FILE_SOURCE_CLOUD_STORAGE",
4: "FILE_SOURCE_CLOUD_DRIVE",
5: "FILE_SOURCE_URL",
}
FileSource_value = map[string]int32{
"FILE_SOURCE_UNSPECIFIED": 0,
"FILE_SOURCE_INLINE": 1,
"FILE_SOURCE_LOCAL": 2,
"FILE_SOURCE_CLOUD_STORAGE": 3,
"FILE_SOURCE_CLOUD_DRIVE": 4,
"FILE_SOURCE_URL": 5,
}
)Enum value maps for FileSource.
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.
ImageCharacteristics_ColorSpace_name, ImageCharacteristics_ColorSpace_value
var (
ImageCharacteristics_ColorSpace_name = map[int32]string{
0: "COLOR_SPACE_UNSPECIFIED",
1: "RGB",
2: "CMYK",
3: "GRAYSCALE",
4: "YUV",
5: "OTHER_COLOR_SPACE",
}
ImageCharacteristics_ColorSpace_value = map[string]int32{
"COLOR_SPACE_UNSPECIFIED": 0,
"RGB": 1,
"CMYK": 2,
"GRAYSCALE": 3,
"YUV": 4,
"OTHER_COLOR_SPACE": 5,
}
)Enum value maps for ImageCharacteristics_ColorSpace.
TargetSite_Type_name, TargetSite_Type_value
var (
TargetSite_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "INCLUDE",
2: "EXCLUDE",
}
TargetSite_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"INCLUDE": 1,
"EXCLUDE": 2,
}
)Enum value maps for TargetSite_Type.
TargetSite_IndexingStatus_name, TargetSite_IndexingStatus_value
var (
TargetSite_IndexingStatus_name = map[int32]string{
0: "INDEXING_STATUS_UNSPECIFIED",
1: "PENDING",
2: "FAILED",
3: "SUCCEEDED",
4: "DELETING",
}
TargetSite_IndexingStatus_value = map[string]int32{
"INDEXING_STATUS_UNSPECIFIED": 0,
"PENDING": 1,
"FAILED": 2,
"SUCCEEDED": 3,
"DELETING": 4,
}
)Enum value maps for TargetSite_IndexingStatus.
SiteVerificationInfo_SiteVerificationState_name, SiteVerificationInfo_SiteVerificationState_value
var (
SiteVerificationInfo_SiteVerificationState_name = map[int32]string{
0: "SITE_VERIFICATION_STATE_UNSPECIFIED",
1: "VERIFIED",
2: "UNVERIFIED",
3: "EXEMPTED",
}
SiteVerificationInfo_SiteVerificationState_value = map[string]int32{
"SITE_VERIFICATION_STATE_UNSPECIFIED": 0,
"VERIFIED": 1,
"UNVERIFIED": 2,
"EXEMPTED": 3,
}
)Enum value maps for SiteVerificationInfo_SiteVerificationState.
RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_name, RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_value
var (
RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_name = map[int32]string{
0: "CORPUS_TYPE_UNSPECIFIED",
1: "DESKTOP",
2: "MOBILE",
}
RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType_value = map[string]int32{
"CORPUS_TYPE_UNSPECIFIED": 0,
"DESKTOP": 1,
"MOBILE": 2,
}
)Enum value maps for RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType.
AclConfigService_ServiceDesc
var AclConfigService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.AclConfigService",
HandlerType: (*AclConfigServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "UpdateAclConfig",
Handler: _AclConfigService_UpdateAclConfig_Handler,
},
{
MethodName: "GetAclConfig",
Handler: _AclConfigService_GetAclConfig_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/acl_config_service.proto",
}AclConfigService_ServiceDesc is the grpc.ServiceDesc for AclConfigService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
ChunkService_ServiceDesc
var ChunkService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.ChunkService",
HandlerType: (*ChunkServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetChunk",
Handler: _ChunkService_GetChunk_Handler,
},
{
MethodName: "ListChunks",
Handler: _ChunkService_ListChunks_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/chunk_service.proto",
}ChunkService_ServiceDesc is the grpc.ServiceDesc for ChunkService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
CompletionService_ServiceDesc
var CompletionService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.CompletionService",
HandlerType: (*CompletionServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CompleteQuery",
Handler: _CompletionService_CompleteQuery_Handler,
},
{
MethodName: "ImportSuggestionDenyListEntries",
Handler: _CompletionService_ImportSuggestionDenyListEntries_Handler,
},
{
MethodName: "PurgeSuggestionDenyListEntries",
Handler: _CompletionService_PurgeSuggestionDenyListEntries_Handler,
},
{
MethodName: "ImportCompletionSuggestions",
Handler: _CompletionService_ImportCompletionSuggestions_Handler,
},
{
MethodName: "PurgeCompletionSuggestions",
Handler: _CompletionService_PurgeCompletionSuggestions_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/completion_service.proto",
}CompletionService_ServiceDesc is the grpc.ServiceDesc for CompletionService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
ControlService_ServiceDesc
var ControlService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.ControlService",
HandlerType: (*ControlServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateControl",
Handler: _ControlService_CreateControl_Handler,
},
{
MethodName: "DeleteControl",
Handler: _ControlService_DeleteControl_Handler,
},
{
MethodName: "UpdateControl",
Handler: _ControlService_UpdateControl_Handler,
},
{
MethodName: "GetControl",
Handler: _ControlService_GetControl_Handler,
},
{
MethodName: "ListControls",
Handler: _ControlService_ListControls_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/control_service.proto",
}ControlService_ServiceDesc is the grpc.ServiceDesc for ControlService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
ConversationalSearchService_ServiceDesc
var ConversationalSearchService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.ConversationalSearchService",
HandlerType: (*ConversationalSearchServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ConverseConversation",
Handler: _ConversationalSearchService_ConverseConversation_Handler,
},
{
MethodName: "CreateConversation",
Handler: _ConversationalSearchService_CreateConversation_Handler,
},
{
MethodName: "DeleteConversation",
Handler: _ConversationalSearchService_DeleteConversation_Handler,
},
{
MethodName: "UpdateConversation",
Handler: _ConversationalSearchService_UpdateConversation_Handler,
},
{
MethodName: "GetConversation",
Handler: _ConversationalSearchService_GetConversation_Handler,
},
{
MethodName: "ListConversations",
Handler: _ConversationalSearchService_ListConversations_Handler,
},
{
MethodName: "AnswerQuery",
Handler: _ConversationalSearchService_AnswerQuery_Handler,
},
{
MethodName: "GetAnswer",
Handler: _ConversationalSearchService_GetAnswer_Handler,
},
{
MethodName: "CreateSession",
Handler: _ConversationalSearchService_CreateSession_Handler,
},
{
MethodName: "DeleteSession",
Handler: _ConversationalSearchService_DeleteSession_Handler,
},
{
MethodName: "UpdateSession",
Handler: _ConversationalSearchService_UpdateSession_Handler,
},
{
MethodName: "GetSession",
Handler: _ConversationalSearchService_GetSession_Handler,
},
{
MethodName: "ListSessions",
Handler: _ConversationalSearchService_ListSessions_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/conversational_search_service.proto",
}ConversationalSearchService_ServiceDesc is the grpc.ServiceDesc for ConversationalSearchService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
DataStoreService_ServiceDesc
var DataStoreService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.DataStoreService",
HandlerType: (*DataStoreServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateDataStore",
Handler: _DataStoreService_CreateDataStore_Handler,
},
{
MethodName: "GetDataStore",
Handler: _DataStoreService_GetDataStore_Handler,
},
{
MethodName: "ListDataStores",
Handler: _DataStoreService_ListDataStores_Handler,
},
{
MethodName: "DeleteDataStore",
Handler: _DataStoreService_DeleteDataStore_Handler,
},
{
MethodName: "UpdateDataStore",
Handler: _DataStoreService_UpdateDataStore_Handler,
},
{
MethodName: "GetDocumentProcessingConfig",
Handler: _DataStoreService_GetDocumentProcessingConfig_Handler,
},
{
MethodName: "UpdateDocumentProcessingConfig",
Handler: _DataStoreService_UpdateDocumentProcessingConfig_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/data_store_service.proto",
}DataStoreService_ServiceDesc is the grpc.ServiceDesc for DataStoreService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
DocumentService_ServiceDesc
var DocumentService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.DocumentService",
HandlerType: (*DocumentServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetDocument",
Handler: _DocumentService_GetDocument_Handler,
},
{
MethodName: "ListDocuments",
Handler: _DocumentService_ListDocuments_Handler,
},
{
MethodName: "CreateDocument",
Handler: _DocumentService_CreateDocument_Handler,
},
{
MethodName: "UpdateDocument",
Handler: _DocumentService_UpdateDocument_Handler,
},
{
MethodName: "DeleteDocument",
Handler: _DocumentService_DeleteDocument_Handler,
},
{
MethodName: "ImportDocuments",
Handler: _DocumentService_ImportDocuments_Handler,
},
{
MethodName: "PurgeDocuments",
Handler: _DocumentService_PurgeDocuments_Handler,
},
{
MethodName: "GetProcessedDocument",
Handler: _DocumentService_GetProcessedDocument_Handler,
},
{
MethodName: "BatchGetDocumentsMetadata",
Handler: _DocumentService_BatchGetDocumentsMetadata_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/document_service.proto",
}DocumentService_ServiceDesc is the grpc.ServiceDesc for DocumentService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
EngineService_ServiceDesc
var EngineService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.EngineService",
HandlerType: (*EngineServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateEngine",
Handler: _EngineService_CreateEngine_Handler,
},
{
MethodName: "DeleteEngine",
Handler: _EngineService_DeleteEngine_Handler,
},
{
MethodName: "UpdateEngine",
Handler: _EngineService_UpdateEngine_Handler,
},
{
MethodName: "GetEngine",
Handler: _EngineService_GetEngine_Handler,
},
{
MethodName: "ListEngines",
Handler: _EngineService_ListEngines_Handler,
},
{
MethodName: "PauseEngine",
Handler: _EngineService_PauseEngine_Handler,
},
{
MethodName: "ResumeEngine",
Handler: _EngineService_ResumeEngine_Handler,
},
{
MethodName: "TuneEngine",
Handler: _EngineService_TuneEngine_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/engine_service.proto",
}EngineService_ServiceDesc is the grpc.ServiceDesc for EngineService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
EstimateBillingService_ServiceDesc
var EstimateBillingService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.EstimateBillingService",
HandlerType: (*EstimateBillingServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "EstimateDataSize",
Handler: _EstimateBillingService_EstimateDataSize_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto",
}EstimateBillingService_ServiceDesc is the grpc.ServiceDesc for EstimateBillingService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
EvaluationService_ServiceDesc
var EvaluationService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.EvaluationService",
HandlerType: (*EvaluationServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetEvaluation",
Handler: _EvaluationService_GetEvaluation_Handler,
},
{
MethodName: "ListEvaluations",
Handler: _EvaluationService_ListEvaluations_Handler,
},
{
MethodName: "CreateEvaluation",
Handler: _EvaluationService_CreateEvaluation_Handler,
},
{
MethodName: "ListEvaluationResults",
Handler: _EvaluationService_ListEvaluationResults_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/evaluation_service.proto",
}EvaluationService_ServiceDesc is the grpc.ServiceDesc for EvaluationService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
File_google_cloud_discoveryengine_v1alpha_acl_config_proto
var File_google_cloud_discoveryengine_v1alpha_acl_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_acl_config_service_proto
var File_google_cloud_discoveryengine_v1alpha_acl_config_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_answer_proto
var File_google_cloud_discoveryengine_v1alpha_answer_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_chunk_proto
var File_google_cloud_discoveryengine_v1alpha_chunk_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_chunk_service_proto
var File_google_cloud_discoveryengine_v1alpha_chunk_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_common_proto
var File_google_cloud_discoveryengine_v1alpha_common_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_completion_proto
var File_google_cloud_discoveryengine_v1alpha_completion_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_completion_service_proto
var File_google_cloud_discoveryengine_v1alpha_completion_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_control_proto
var File_google_cloud_discoveryengine_v1alpha_control_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_control_service_proto
var File_google_cloud_discoveryengine_v1alpha_control_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_conversation_proto
var File_google_cloud_discoveryengine_v1alpha_conversation_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_conversational_search_service_proto
var File_google_cloud_discoveryengine_v1alpha_conversational_search_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_custom_tuning_model_proto
var File_google_cloud_discoveryengine_v1alpha_custom_tuning_model_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_data_store_proto
var File_google_cloud_discoveryengine_v1alpha_data_store_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_data_store_service_proto
var File_google_cloud_discoveryengine_v1alpha_data_store_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_document_processing_config_proto
var File_google_cloud_discoveryengine_v1alpha_document_processing_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_document_proto
var File_google_cloud_discoveryengine_v1alpha_document_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_document_service_proto
var File_google_cloud_discoveryengine_v1alpha_document_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_engine_proto
var File_google_cloud_discoveryengine_v1alpha_engine_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_engine_service_proto
var File_google_cloud_discoveryengine_v1alpha_engine_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_estimate_billing_service_proto
var File_google_cloud_discoveryengine_v1alpha_estimate_billing_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_evaluation_proto
var File_google_cloud_discoveryengine_v1alpha_evaluation_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_evaluation_service_proto
var File_google_cloud_discoveryengine_v1alpha_evaluation_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_grounded_generation_service_proto
var File_google_cloud_discoveryengine_v1alpha_grounded_generation_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_grounding_proto
var File_google_cloud_discoveryengine_v1alpha_grounding_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_import_config_proto
var File_google_cloud_discoveryengine_v1alpha_import_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_project_proto
var File_google_cloud_discoveryengine_v1alpha_project_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_project_service_proto
var File_google_cloud_discoveryengine_v1alpha_project_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_purge_config_proto
var File_google_cloud_discoveryengine_v1alpha_purge_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_rank_service_proto
var File_google_cloud_discoveryengine_v1alpha_rank_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_recommendation_service_proto
var File_google_cloud_discoveryengine_v1alpha_recommendation_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_sample_query_proto
var File_google_cloud_discoveryengine_v1alpha_sample_query_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_sample_query_service_proto
var File_google_cloud_discoveryengine_v1alpha_sample_query_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_sample_query_set_proto
var File_google_cloud_discoveryengine_v1alpha_sample_query_set_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_sample_query_set_service_proto
var File_google_cloud_discoveryengine_v1alpha_sample_query_set_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_schema_proto
var File_google_cloud_discoveryengine_v1alpha_schema_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_schema_service_proto
var File_google_cloud_discoveryengine_v1alpha_schema_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_search_service_proto
var File_google_cloud_discoveryengine_v1alpha_search_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_search_tuning_service_proto
var File_google_cloud_discoveryengine_v1alpha_search_tuning_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_serving_config_proto
var File_google_cloud_discoveryengine_v1alpha_serving_config_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_serving_config_service_proto
var File_google_cloud_discoveryengine_v1alpha_serving_config_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_session_proto
var File_google_cloud_discoveryengine_v1alpha_session_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_session_service_proto
var File_google_cloud_discoveryengine_v1alpha_session_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_site_search_engine_proto
var File_google_cloud_discoveryengine_v1alpha_site_search_engine_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_site_search_engine_service_proto
var File_google_cloud_discoveryengine_v1alpha_site_search_engine_service_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_user_event_proto
var File_google_cloud_discoveryengine_v1alpha_user_event_proto protoreflect.FileDescriptorFile_google_cloud_discoveryengine_v1alpha_user_event_service_proto
var File_google_cloud_discoveryengine_v1alpha_user_event_service_proto protoreflect.FileDescriptorGroundedGenerationService_ServiceDesc
var GroundedGenerationService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.GroundedGenerationService",
HandlerType: (*GroundedGenerationServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CheckGrounding",
Handler: _GroundedGenerationService_CheckGrounding_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto",
}GroundedGenerationService_ServiceDesc is the grpc.ServiceDesc for GroundedGenerationService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
ProjectService_ServiceDesc
var ProjectService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.ProjectService",
HandlerType: (*ProjectServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetProject",
Handler: _ProjectService_GetProject_Handler,
},
{
MethodName: "ProvisionProject",
Handler: _ProjectService_ProvisionProject_Handler,
},
{
MethodName: "ReportConsentChange",
Handler: _ProjectService_ReportConsentChange_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/project_service.proto",
}ProjectService_ServiceDesc is the grpc.ServiceDesc for ProjectService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
RankService_ServiceDesc
var RankService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.RankService",
HandlerType: (*RankServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "Rank",
Handler: _RankService_Rank_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/rank_service.proto",
}RankService_ServiceDesc is the grpc.ServiceDesc for RankService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
RecommendationService_ServiceDesc
var RecommendationService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.RecommendationService",
HandlerType: (*RecommendationServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "Recommend",
Handler: _RecommendationService_Recommend_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/recommendation_service.proto",
}RecommendationService_ServiceDesc is the grpc.ServiceDesc for RecommendationService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
SampleQueryService_ServiceDesc
var SampleQueryService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.SampleQueryService",
HandlerType: (*SampleQueryServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetSampleQuery",
Handler: _SampleQueryService_GetSampleQuery_Handler,
},
{
MethodName: "ListSampleQueries",
Handler: _SampleQueryService_ListSampleQueries_Handler,
},
{
MethodName: "CreateSampleQuery",
Handler: _SampleQueryService_CreateSampleQuery_Handler,
},
{
MethodName: "UpdateSampleQuery",
Handler: _SampleQueryService_UpdateSampleQuery_Handler,
},
{
MethodName: "DeleteSampleQuery",
Handler: _SampleQueryService_DeleteSampleQuery_Handler,
},
{
MethodName: "ImportSampleQueries",
Handler: _SampleQueryService_ImportSampleQueries_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/sample_query_service.proto",
}SampleQueryService_ServiceDesc is the grpc.ServiceDesc for SampleQueryService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
SampleQuerySetService_ServiceDesc
var SampleQuerySetService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.SampleQuerySetService",
HandlerType: (*SampleQuerySetServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetSampleQuerySet",
Handler: _SampleQuerySetService_GetSampleQuerySet_Handler,
},
{
MethodName: "ListSampleQuerySets",
Handler: _SampleQuerySetService_ListSampleQuerySets_Handler,
},
{
MethodName: "CreateSampleQuerySet",
Handler: _SampleQuerySetService_CreateSampleQuerySet_Handler,
},
{
MethodName: "UpdateSampleQuerySet",
Handler: _SampleQuerySetService_UpdateSampleQuerySet_Handler,
},
{
MethodName: "DeleteSampleQuerySet",
Handler: _SampleQuerySetService_DeleteSampleQuerySet_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto",
}SampleQuerySetService_ServiceDesc is the grpc.ServiceDesc for SampleQuerySetService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
SchemaService_ServiceDesc
var SchemaService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.SchemaService",
HandlerType: (*SchemaServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetSchema",
Handler: _SchemaService_GetSchema_Handler,
},
{
MethodName: "ListSchemas",
Handler: _SchemaService_ListSchemas_Handler,
},
{
MethodName: "CreateSchema",
Handler: _SchemaService_CreateSchema_Handler,
},
{
MethodName: "UpdateSchema",
Handler: _SchemaService_UpdateSchema_Handler,
},
{
MethodName: "DeleteSchema",
Handler: _SchemaService_DeleteSchema_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/schema_service.proto",
}SchemaService_ServiceDesc is the grpc.ServiceDesc for SchemaService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
SearchService_ServiceDesc
var SearchService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.SearchService",
HandlerType: (*SearchServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "Search",
Handler: _SearchService_Search_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/search_service.proto",
}SearchService_ServiceDesc is the grpc.ServiceDesc for SearchService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
SearchTuningService_ServiceDesc
var SearchTuningService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.SearchTuningService",
HandlerType: (*SearchTuningServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "TrainCustomModel",
Handler: _SearchTuningService_TrainCustomModel_Handler,
},
{
MethodName: "ListCustomModels",
Handler: _SearchTuningService_ListCustomModels_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/search_tuning_service.proto",
}SearchTuningService_ServiceDesc is the grpc.ServiceDesc for SearchTuningService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
ServingConfigService_ServiceDesc
var ServingConfigService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.ServingConfigService",
HandlerType: (*ServingConfigServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "UpdateServingConfig",
Handler: _ServingConfigService_UpdateServingConfig_Handler,
},
{
MethodName: "GetServingConfig",
Handler: _ServingConfigService_GetServingConfig_Handler,
},
{
MethodName: "ListServingConfigs",
Handler: _ServingConfigService_ListServingConfigs_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/serving_config_service.proto",
}ServingConfigService_ServiceDesc is the grpc.ServiceDesc for ServingConfigService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
SessionService_ServiceDesc
var SessionService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.SessionService",
HandlerType: (*SessionServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateSession",
Handler: _SessionService_CreateSession_Handler,
},
{
MethodName: "DeleteSession",
Handler: _SessionService_DeleteSession_Handler,
},
{
MethodName: "UpdateSession",
Handler: _SessionService_UpdateSession_Handler,
},
{
MethodName: "GetSession",
Handler: _SessionService_GetSession_Handler,
},
{
MethodName: "ListSessions",
Handler: _SessionService_ListSessions_Handler,
},
{
MethodName: "ListFiles",
Handler: _SessionService_ListFiles_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/session_service.proto",
}SessionService_ServiceDesc is the grpc.ServiceDesc for SessionService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
SiteSearchEngineService_ServiceDesc
var SiteSearchEngineService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.SiteSearchEngineService",
HandlerType: (*SiteSearchEngineServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GetSiteSearchEngine",
Handler: _SiteSearchEngineService_GetSiteSearchEngine_Handler,
},
{
MethodName: "CreateTargetSite",
Handler: _SiteSearchEngineService_CreateTargetSite_Handler,
},
{
MethodName: "BatchCreateTargetSites",
Handler: _SiteSearchEngineService_BatchCreateTargetSites_Handler,
},
{
MethodName: "GetTargetSite",
Handler: _SiteSearchEngineService_GetTargetSite_Handler,
},
{
MethodName: "UpdateTargetSite",
Handler: _SiteSearchEngineService_UpdateTargetSite_Handler,
},
{
MethodName: "DeleteTargetSite",
Handler: _SiteSearchEngineService_DeleteTargetSite_Handler,
},
{
MethodName: "ListTargetSites",
Handler: _SiteSearchEngineService_ListTargetSites_Handler,
},
{
MethodName: "EnableAdvancedSiteSearch",
Handler: _SiteSearchEngineService_EnableAdvancedSiteSearch_Handler,
},
{
MethodName: "DisableAdvancedSiteSearch",
Handler: _SiteSearchEngineService_DisableAdvancedSiteSearch_Handler,
},
{
MethodName: "RecrawlUris",
Handler: _SiteSearchEngineService_RecrawlUris_Handler,
},
{
MethodName: "BatchVerifyTargetSites",
Handler: _SiteSearchEngineService_BatchVerifyTargetSites_Handler,
},
{
MethodName: "FetchDomainVerificationStatus",
Handler: _SiteSearchEngineService_FetchDomainVerificationStatus_Handler,
},
{
MethodName: "SetUriPatternDocumentData",
Handler: _SiteSearchEngineService_SetUriPatternDocumentData_Handler,
},
{
MethodName: "GetUriPatternDocumentData",
Handler: _SiteSearchEngineService_GetUriPatternDocumentData_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto",
}SiteSearchEngineService_ServiceDesc is the grpc.ServiceDesc for SiteSearchEngineService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
UserEventService_ServiceDesc
var UserEventService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.discoveryengine.v1alpha.UserEventService",
HandlerType: (*UserEventServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "WriteUserEvent",
Handler: _UserEventService_WriteUserEvent_Handler,
},
{
MethodName: "CollectUserEvent",
Handler: _UserEventService_CollectUserEvent_Handler,
},
{
MethodName: "PurgeUserEvents",
Handler: _UserEventService_PurgeUserEvents_Handler,
},
{
MethodName: "ImportUserEvents",
Handler: _UserEventService_ImportUserEvents_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/discoveryengine/v1alpha/user_event_service.proto",
}UserEventService_ServiceDesc is the grpc.ServiceDesc for UserEventService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions
func RegisterAclConfigServiceServer
func RegisterAclConfigServiceServer(s grpc.ServiceRegistrar, srv AclConfigServiceServer)func RegisterChunkServiceServer
func RegisterChunkServiceServer(s grpc.ServiceRegistrar, srv ChunkServiceServer)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 RegisterEstimateBillingServiceServer
func RegisterEstimateBillingServiceServer(s grpc.ServiceRegistrar, srv EstimateBillingServiceServer)func RegisterEvaluationServiceServer
func RegisterEvaluationServiceServer(s grpc.ServiceRegistrar, srv EvaluationServiceServer)func RegisterGroundedGenerationServiceServer
func RegisterGroundedGenerationServiceServer(s grpc.ServiceRegistrar, srv GroundedGenerationServiceServer)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)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.v1alpha.AclConfig].
GetAclConfig(ctx context.Context, in *GetAclConfigRequest, opts ...grpc.CallOption) (*AclConfig, error)
}AclConfigServiceClient is the client API for AclConfigService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewAclConfigServiceClient
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.v1alpha.AclConfig].
GetAclConfig(context.Context, *GetAclConfigRequest) (*AclConfig, error)
}AclConfigServiceServer is the server API for AclConfigService service. All implementations should embed UnimplementedAclConfigServiceServer for forward compatibility
AlloyDbSource
type AlloyDbSource struct {
// The project ID that contains the AlloyDB source.
// Has a length limit of 128 characters. If not specified, inherits the
// project ID from the parent request.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Required. The AlloyDB location to copy the data from with a length limit of
// 256 characters.
LocationId string `protobuf:"bytes,2,opt,name=location_id,json=locationId,proto3" json:"location_id,omitempty"`
// Required. The AlloyDB cluster to copy the data from with a length limit of
// 256 characters.
ClusterId string `protobuf:"bytes,3,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
// Required. The AlloyDB database to copy the data from with a length limit of
// 256 characters.
DatabaseId string `protobuf:"bytes,4,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// Required. The AlloyDB table to copy the data from with a length limit of
// 256 characters.
TableId string `protobuf:"bytes,5,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Intermediate Cloud Storage directory used for the import with a length
// limit of 2,000 characters. Can be specified if one wants to have the
// AlloyDB export to a specific Cloud Storage directory.
//
// Ensure that the AlloyDB service account has the necessary Cloud
// Storage Admin permissions to access the specified Cloud Storage directory.
GcsStagingDir string `protobuf:"bytes,6,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
// contains filtered or unexported fields
}AlloyDB source import data from.
func (*AlloyDbSource) Descriptor
func (*AlloyDbSource) Descriptor() ([]byte, []int)Deprecated: Use AlloyDbSource.ProtoReflect.Descriptor instead.
func (*AlloyDbSource) GetClusterId
func (x *AlloyDbSource) GetClusterId() 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.v1alpha.Answer_State" json:"state,omitempty"`
// The textual answer.
AnswerText string `protobuf:"bytes,3,opt,name=answer_text,json=answerText,proto3" json:"answer_text,omitempty"`
// Citations.
Citations []*Answer_Citation `protobuf:"bytes,4,rep,name=citations,proto3" json:"citations,omitempty"`
// References.
References []*Answer_Reference `protobuf:"bytes,5,rep,name=references,proto3" json:"references,omitempty"`
// Suggested related questions.
RelatedQuestions []string `protobuf:"bytes,6,rep,name=related_questions,json=relatedQuestions,proto3" json:"related_questions,omitempty"`
// Answer generation steps.
Steps []*Answer_Step `protobuf:"bytes,7,rep,name=steps,proto3" json:"steps,omitempty"`
// Query understanding information.
QueryUnderstandingInfo *Answer_QueryUnderstandingInfo `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.v1alpha.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"`
// 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) GetCitations
func (x *Answer) GetCitations() []*Answer_Citationfunc (*Answer) GetCompleteTime
func (x *Answer) GetCompleteTime() *timestamppb.Timestampfunc (*Answer) GetCreateTime
func (x *Answer) GetCreateTime() *timestamppb.Timestampfunc (*Answer) GetName
func (*Answer) GetQueryUnderstandingInfo
func (x *Answer) GetQueryUnderstandingInfo() *Answer_QueryUnderstandingInfofunc (*Answer) GetReferences
func (x *Answer) GetReferences() []*Answer_Referencefunc (*Answer) GetRelatedQuestions
func (*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
AnswerQueryRequest
type AnswerQueryRequest struct {
// Required. The resource name of the Search serving config, such as
// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
// or
// `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
// This field is used to identify the serving configuration name, set
// of models used to make the search.
ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
// Required. Current user query.
Query *Query `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
// The session resource name. Not required.
//
// When session field is not set, the API is in sessionless mode.
//
// We support auto session mode: users can use the wildcard symbol `-` as
// session ID. A new ID will be automatically generated and assigned.
Session string `protobuf:"bytes,3,opt,name=session,proto3" json:"session,omitempty"`
// Model specification.
SafetySpec *AnswerQueryRequest_SafetySpec `protobuf:"bytes,4,opt,name=safety_spec,json=safetySpec,proto3" json:"safety_spec,omitempty"`
// Related questions specification.
RelatedQuestionsSpec *AnswerQueryRequest_RelatedQuestionsSpec `protobuf:"bytes,5,opt,name=related_questions_spec,json=relatedQuestionsSpec,proto3" json:"related_questions_spec,omitempty"`
// 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"`
// Asynchronous mode control.
//
// If enabled, the response will be returned with answer/session resource
// name without final answer. The API users need to do the polling to get
// the latest status of answer/session by calling
// [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetAnswer]
// or
// [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetSession]
// method.
AsynchronousMode bool `protobuf:"varint,10,opt,name=asynchronous_mode,json=asynchronousMode,proto3" json:"asynchronous_mode,omitempty"`
// A unique identifier for tracking visitors. For example, this could be
// implemented with an HTTP cookie, which should be able to uniquely identify
// a visitor on a single device. This unique identifier should not change if
// the visitor logs in or out of the website.
//
// This field should NOT have a fixed value such as `unknown_visitor`.
//
// The field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
UserPseudoId string `protobuf:"bytes,12,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
// The user labels applied to a resource must meet the following requirements:
//
// - Each resource can have multiple labels, up to a maximum of 64.
// - Each label must be a key-value pair.
// - Keys have a minimum length of 1 character and a maximum length of 63
// characters and cannot be empty. Values can be empty and have a maximum
// length of 63 characters.
// - Keys and values can contain only lowercase letters, numeric characters,
// underscores, and dashes. All characters must use UTF-8 encoding, and
// international characters are allowed.
// - The key portion of a label must be unique. However, you can use the same
// key with multiple resources.
// - Keys must start with a lowercase letter or international character.
//
// See [Google Cloud
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
// for more details.
UserLabels map[string]string `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"`
// contains filtered or unexported fields
}Request message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.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() boolfunc (*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"`
// 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) 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) 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_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_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"`
// 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) 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.v1alpha.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
const (
// Unspecified query classification type.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_TYPE_UNSPECIFIED AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 0
// Adversarial query classification type.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_ADVERSARIAL_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 1
// Non-answer-seeking query classification type.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_NON_ANSWER_SEEKING_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 2
// Jail-breaking query classification type.
AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_JAIL_BREAKING_QUERY AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type = 3
)func (AnswerQueryRequest_QueryUnderstandingSpec_QueryClassificationSpec_Type) Descriptor
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"`
// 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) 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_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"`
// contains filtered or unexported fields
}Safety specification.
func (*AnswerQueryRequest_SafetySpec) Descriptor
func (*AnswerQueryRequest_SafetySpec) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SafetySpec.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SafetySpec) GetEnable
func (x *AnswerQueryRequest_SafetySpec) GetEnable() boolfunc (*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_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.v1alpha.Document] object. Leave
// it unset if ordered by relevance. `order_by` expression is
// case-sensitive. For more information on ordering, see
// [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
//
// If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// Specifies the search result mode. If unspecified, the
// search result mode defaults to `DOCUMENTS`.
// See [parse and chunk
// documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
SearchResultMode SearchRequest_ContentSearchSpec_SearchResultMode `protobuf:"varint,5,opt,name=search_result_mode,json=searchResultMode,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchRequest_ContentSearchSpec_SearchResultMode" json:"search_result_mode,omitempty"`
// Custom fine tuning configs.
CustomFineTuningSpec *CustomFineTuningSpec `protobuf:"bytes,6,opt,name=custom_fine_tuning_spec,json=customFineTuningSpec,proto3" json:"custom_fine_tuning_spec,omitempty"`
// Specs defining dataStores to filter on in a search call and
// configurations for those dataStores. This is only considered for
// engines with multiple dataStores use case. For single dataStore within
// an engine, they should use the specs at the top level.
DataStoreSpecs []*SearchRequest_DataStoreSpec `protobuf:"bytes,7,rep,name=data_store_specs,json=dataStoreSpecs,proto3" json:"data_store_specs,omitempty"`
// contains filtered or unexported fields
}Search parameters.
func (*AnswerQueryRequest_SearchSpec_SearchParams) Descriptor
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) GetCustomFineTuningSpec
func (x *AnswerQueryRequest_SearchSpec_SearchParams) GetCustomFineTuningSpec() *CustomFineTuningSpecfunc (*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) 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"`
// 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) 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_UnstructuredDocumentInfo
type AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo struct {
// Document resource name.
Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// URI for the document.
Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
// Title.
Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
// List of document contexts.
DocumentContexts []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_DocumentContext `protobuf:"bytes,4,rep,name=document_contexts,json=documentContexts,proto3" json:"document_contexts,omitempty"`
// List of extractive segments.
ExtractiveSegments []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveSegment `protobuf:"bytes,5,rep,name=extractive_segments,json=extractiveSegments,proto3" json:"extractive_segments,omitempty"`
// List of extractive answers.
ExtractiveAnswers []*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo_ExtractiveAnswer `protobuf:"bytes,6,rep,name=extractive_answers,json=extractiveAnswers,proto3" json:"extractive_answers,omitempty"`
// contains filtered or unexported fields
}Unstructured document information.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Descriptor
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) Descriptor() ([]byte, []int)Deprecated: Use AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo.ProtoReflect.Descriptor instead.
func (*AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument
func (x *AnswerQueryRequest_SearchSpec_SearchResultList_SearchResult_UnstructuredDocumentInfo) GetDocument() 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_ExtractiveAnswerfunc (*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.
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
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.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps]
// is greater than 1, use
// [Answer.name][google.cloud.discoveryengine.v1alpha.Answer.name] to fetch
// answer information using
// [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetAnswer]
// API.
Answer *Answer `protobuf:"bytes,1,opt,name=answer,proto3" json:"answer,omitempty"`
// Session resource object.
// It will be only available when session field is set and valid in the
// [AnswerQueryRequest][google.cloud.discoveryengine.v1alpha.AnswerQueryRequest]
// request.
Session *Session `protobuf:"bytes,2,opt,name=session,proto3" json:"session,omitempty"`
// A global unique ID used for logging.
AnswerQueryToken string `protobuf:"bytes,3,opt,name=answer_query_token,json=answerQueryToken,proto3" json:"answer_query_token,omitempty"`
// contains filtered or unexported fields
}Response message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery] method.
func (*AnswerQueryResponse) Descriptor
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
const (
// Default value. The answer skipped reason is not specified.
Answer_ANSWER_SKIPPED_REASON_UNSPECIFIED Answer_AnswerSkippedReason = 0
// The adversarial query ignored case.
Answer_ADVERSARIAL_QUERY_IGNORED Answer_AnswerSkippedReason = 1
// The non-answer seeking query ignored case.
Answer_NON_ANSWER_SEEKING_QUERY_IGNORED Answer_AnswerSkippedReason = 2
// The out-of-domain query ignored case.
//
// Google skips the answer if there are no high-relevance search results.
Answer_OUT_OF_DOMAIN_QUERY_IGNORED Answer_AnswerSkippedReason = 3
// The potential policy violation case.
//
// Google skips the answer if there is a potential policy violation
// detected. This includes content that may be violent or toxic.
Answer_POTENTIAL_POLICY_VIOLATION Answer_AnswerSkippedReason = 4
// The no relevant content case.
//
// Google skips the answer if there is no relevant content in the
// retrieved search results.
Answer_NO_RELEVANT_CONTENT Answer_AnswerSkippedReason = 5
// The jail-breaking query ignored case.
//
// For example, "Reply in the tone of a competing company's CEO".
// Google skips the answer if the query is classified as a jail-breaking
// query.
Answer_JAIL_BREAKING_QUERY_IGNORED Answer_AnswerSkippedReason = 6
// The customer policy violation case.
//
// Google skips the summary if there is a customer policy violation
// detected. The policy is defined by the customer.
Answer_CUSTOMER_POLICY_VIOLATION Answer_AnswerSkippedReason = 7
)func (Answer_AnswerSkippedReason) Descriptor
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_Citation
type Answer_Citation struct {
// Index indicates the start of the segment, measured in bytes (UTF-8
// unicode).
StartIndex int64 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
// End of the attributed segment, exclusive.
EndIndex int64 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
// Citation sources for the attributed segment.
Sources []*Answer_CitationSource `protobuf:"bytes,3,rep,name=sources,proto3" json:"sources,omitempty"`
// contains filtered or unexported fields
}Citation info for a segment.
func (*Answer_Citation) Descriptor
func (*Answer_Citation) Descriptor() ([]byte, []int)Deprecated: Use Answer_Citation.ProtoReflect.Descriptor instead.
func (*Answer_Citation) GetEndIndex
func (x *Answer_Citation) GetEndIndex() 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_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.v1alpha.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
const (
// Unspecified query classification type.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_TYPE_UNSPECIFIED Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 0
// Adversarial query classification type.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_ADVERSARIAL_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 1
// Non-answer-seeking query classification type.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_NON_ANSWER_SEEKING_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 2
// Jail-breaking query classification type.
Answer_QueryUnderstandingInfo_QueryClassificationInfo_JAIL_BREAKING_QUERY Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type = 3
)func (Answer_QueryUnderstandingInfo_QueryClassificationInfo_Type) Descriptor
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"`
// contains filtered or unexported fields
}Chunk information.
func (*Answer_Reference_ChunkInfo) Descriptor
func (*Answer_Reference_ChunkInfo) Descriptor() ([]byte, []int)Deprecated: Use Answer_Reference_ChunkInfo.ProtoReflect.Descriptor instead.
func (*Answer_Reference_ChunkInfo) GetChunk
func (x *Answer_Reference_ChunkInfo) GetChunk() 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"`
// 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) 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"`
// contains filtered or unexported fields
}Chunk content.
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Descriptor
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) Descriptor() ([]byte, []int)Deprecated: Use Answer_Reference_UnstructuredDocumentInfo_ChunkContent.ProtoReflect.Descriptor instead.
func (*Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent
func (x *Answer_Reference_UnstructuredDocumentInfo_ChunkContent) GetContent() 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
const (
// Unknown.
Answer_STATE_UNSPECIFIED Answer_State = 0
// Answer generation is currently in progress.
Answer_IN_PROGRESS Answer_State = 1
// Answer generation currently failed.
Answer_FAILED Answer_State = 2
// Answer generation has succeeded.
Answer_SUCCEEDED Answer_State = 3
)func (Answer_State) Descriptor
func (Answer_State) Descriptor() protoreflect.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.v1alpha.Answer_Step_State" json:"state,omitempty"`
// The description of the step.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// The thought of the step.
Thought string `protobuf:"bytes,3,opt,name=thought,proto3" json:"thought,omitempty"`
// Actions.
Actions []*Answer_Step_Action `protobuf:"bytes,4,rep,name=actions,proto3" json:"actions,omitempty"`
// contains filtered or unexported fields
}Step information.
func (*Answer_Step) Descriptor
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.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.Document]s.
Matcher *BatchGetDocumentsMetadataRequest_Matcher `protobuf:"bytes,2,opt,name=matcher,proto3" json:"matcher,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata] method.
func (*BatchGetDocumentsMetadataRequest) Descriptor
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_Matcher
type BatchGetDocumentsMetadataRequest_Matcher struct {
// Matcher for the
// [Document][google.cloud.discoveryengine.v1alpha.Document]s.
//
// Types that are valid to be assigned to Matcher:
//
// *BatchGetDocumentsMetadataRequest_Matcher_UrisMatcher
Matcher isBatchGetDocumentsMetadataRequest_Matcher_Matcher `protobuf_oneof:"matcher"`
// contains filtered or unexported fields
}Matcher for the [Document][google.cloud.discoveryengine.v1alpha.Document]s. Currently supports matching by exact URIs.
func (*BatchGetDocumentsMetadataRequest_Matcher) Descriptor
func (*BatchGetDocumentsMetadataRequest_Matcher) Descriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataRequest_Matcher.ProtoReflect.Descriptor instead.
func (*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_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.v1alpha.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.v1alpha.Document]s.
DocumentsMetadata []*BatchGetDocumentsMetadataResponse_DocumentMetadata `protobuf:"bytes,1,rep,name=documents_metadata,json=documentsMetadata,proto3" json:"documents_metadata,omitempty"`
// contains filtered or unexported fields
}Response message for [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata] method.
func (*BatchGetDocumentsMetadataResponse) Descriptor
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.v1alpha.Document].
MatcherValue *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue `protobuf:"bytes,2,opt,name=matcher_value,json=matcherValue,proto3" json:"matcher_value,omitempty"`
// The state of the document.
State BatchGetDocumentsMetadataResponse_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse_State" json:"state,omitempty"`
// The timestamp of the last time the
// [Document][google.cloud.discoveryengine.v1alpha.Document] was last
// indexed.
LastRefreshedTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=last_refreshed_time,json=lastRefreshedTime,proto3" json:"last_refreshed_time,omitempty"`
// contains filtered or unexported fields
}The metadata of a [Document][google.cloud.discoveryengine.v1alpha.Document].
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) Descriptor
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata) Descriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata.ProtoReflect.Descriptor instead.
func (*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.v1alpha.Document].
//
// Types that are valid to be assigned to MatcherValue:
//
// *BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri
MatcherValue isBatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_MatcherValue `protobuf_oneof:"matcher_value"`
// contains filtered or unexported fields
}The value of the matcher that was used to match the [Document][google.cloud.discoveryengine.v1alpha.Document].
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Descriptor
func (*BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue) Descriptor() ([]byte, []int)Deprecated: Use BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue.ProtoReflect.Descriptor instead.
func (*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_Uri
type BatchGetDocumentsMetadataResponse_DocumentMetadata_MatcherValue_Uri struct {
// If match by URI, the URI of the
// [Document][google.cloud.discoveryengine.v1alpha.Document].
Uri string `protobuf:"bytes,1,opt,name=uri,proto3,oneof"`
}BatchGetDocumentsMetadataResponse_State
type BatchGetDocumentsMetadataResponse_State int32The state of the [Document][google.cloud.discoveryengine.v1alpha.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.v1alpha.Document] is indexed.
BatchGetDocumentsMetadataResponse_INDEXED BatchGetDocumentsMetadataResponse_State = 1
// The [Document][google.cloud.discoveryengine.v1alpha.Document] is not
// indexed because its URI is not in the
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
BatchGetDocumentsMetadataResponse_NOT_IN_TARGET_SITE BatchGetDocumentsMetadataResponse_State = 2
// The [Document][google.cloud.discoveryengine.v1alpha.Document] is not
// indexed.
BatchGetDocumentsMetadataResponse_NOT_IN_INDEX BatchGetDocumentsMetadataResponse_State = 3
)func (BatchGetDocumentsMetadataResponse_State) Descriptor
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.EnumTypeBatchVerifyTargetSitesMetadata
type BatchVerifyTargetSitesMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*BatchVerifyTargetSitesMetadata) Descriptor
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.v1alpha.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.v1alpha.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.v1alpha.UserEvent] per row.
//
// Supported values for document imports:
//
// * `document` (default): One
// [Document][google.cloud.discoveryengine.v1alpha.Document] format per
//
// row. Each document must have a valid
// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] and one
// of
// [Document.json_data][google.cloud.discoveryengine.v1alpha.Document.json_data]
// or
// [Document.struct_data][google.cloud.discoveryengine.v1alpha.Document.struct_data].
// - `custom`: One custom data per row in arbitrary format that conforms to
// the defined [Schema][google.cloud.discoveryengine.v1alpha.Schema] of the
// data store. This can only be used by the GENERIC Data Store vertical.
DataSchema string `protobuf:"bytes,6,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
// contains filtered or unexported fields
}BigQuery source import data from.
func (*BigQuerySource) Descriptor
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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.BigtableOptions_Type" json:"type,omitempty"`
// The list of objects that contains column level information for each
// column. If a column is not present in this list it will be ignored.
Columns []*BigtableOptions_BigtableColumn `protobuf:"bytes,4,rep,name=columns,proto3" json:"columns,omitempty"`
// contains filtered or unexported fields
}The column family of the Bigtable.
func (*BigtableOptions_BigtableColumnFamily) Descriptor
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. Can have a maximum length of 1024 characters.
AnswerCandidate string `protobuf:"bytes,2,opt,name=answer_candidate,json=answerCandidate,proto3" json:"answer_candidate,omitempty"`
// List of facts for the grounding check.
// We support up to 200 facts.
Facts []*GroundingFact `protobuf:"bytes,3,rep,name=facts,proto3" json:"facts,omitempty"`
// Configuration of the grounding check.
GroundingSpec *CheckGroundingSpec `protobuf:"bytes,4,opt,name=grounding_spec,json=groundingSpec,proto3" json:"grounding_spec,omitempty"`
// The user labels applied to a resource must meet the following requirements:
//
// - Each resource can have multiple labels, up to a maximum of 64.
// - Each label must be a key-value pair.
// - Keys have a minimum length of 1 character and a maximum length of 63
// characters and cannot be empty. Values can be empty and have a maximum
// length of 63 characters.
// - Keys and values can contain only lowercase letters, numeric characters,
// underscores, and dashes. All characters must use UTF-8 encoding, and
// international characters are allowed.
// - The key portion of a label must be unique. However, you can use the same
// key with multiple resources.
// - Keys must start with a lowercase letter or international character.
//
// See [Google Cloud
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
// for more details.
UserLabels map[string]string `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.v1alpha.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"`
// Claim texts and citation info across all claims in the answer candidate.
Claims []*CheckGroundingResponse_Claim `protobuf:"bytes,4,rep,name=claims,proto3" json:"claims,omitempty"`
// contains filtered or unexported fields
}Response message for the [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding] method.
func (*CheckGroundingResponse) Descriptor
func (*CheckGroundingResponse) Descriptor() ([]byte, []int)Deprecated: Use CheckGroundingResponse.ProtoReflect.Descriptor instead.
func (*CheckGroundingResponse) GetCitedChunks
func (x *CheckGroundingResponse) GetCitedChunks() []*FactChunkfunc (*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_Claim
type CheckGroundingResponse_Claim struct {
// Position indicating the start of the claim in the answer candidate,
// measured in bytes.
StartPos *int32 `protobuf:"varint,1,opt,name=start_pos,json=startPos,proto3,oneof" json:"start_pos,omitempty"`
// Position indicating the end of the claim in the answer candidate,
// exclusive.
EndPos *int32 `protobuf:"varint,2,opt,name=end_pos,json=endPos,proto3,oneof" json:"end_pos,omitempty"`
// Text for the claim in the answer candidate. Always provided regardless of
// whether citations or anti-citations are found.
ClaimText string `protobuf:"bytes,3,opt,name=claim_text,json=claimText,proto3" json:"claim_text,omitempty"`
// A list of indices (into 'cited_chunks') specifying the citations
// associated with the claim. For instance [1,3,4] means that
// cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
// supporting for the claim. A citation to a fact indicates that the claim
// is supported by the fact.
CitationIndices []int32 `protobuf:"varint,4,rep,packed,name=citation_indices,json=citationIndices,proto3" json:"citation_indices,omitempty"`
// Indicates that this claim required grounding check. When the system
// decided this claim doesn't require attribution/grounding check, this
// field will be set to false. In that case, no grounding check was done for
// the claim and therefore
// [citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.citation_indices],
// [anti_citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.anti_citation_indices],
// and
// [score][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.score]
// should not be returned.
GroundingCheckRequired *bool `protobuf:"varint,6,opt,name=grounding_check_required,json=groundingCheckRequired,proto3,oneof" json:"grounding_check_required,omitempty"`
// contains filtered or unexported fields
}Text and citation info for a claim in the answer candidate.
func (*CheckGroundingResponse_Claim) Descriptor
func (*CheckGroundingResponse_Claim) Descriptor() ([]byte, []int)Deprecated: Use CheckGroundingResponse_Claim.ProtoReflect.Descriptor instead.
func (*CheckGroundingResponse_Claim) GetCitationIndices
func (x *CheckGroundingResponse_Claim) GetCitationIndices() []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) 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"`
// 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) 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 [SearchService.SearchResponse][].
RelevanceScore *float64 `protobuf:"fixed64,8,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
// Metadata of the document from the current chunk.
DocumentMetadata *Chunk_DocumentMetadata `protobuf:"bytes,5,opt,name=document_metadata,json=documentMetadata,proto3" json:"document_metadata,omitempty"`
// Output only. This field is OUTPUT_ONLY.
// It contains derived data that are not in the original input document.
DerivedStructData *structpb.Struct `protobuf:"bytes,4,opt,name=derived_struct_data,json=derivedStructData,proto3" json:"derived_struct_data,omitempty"`
// Page span of the chunk.
PageSpan *Chunk_PageSpan `protobuf:"bytes,6,opt,name=page_span,json=pageSpan,proto3" json:"page_span,omitempty"`
// Output only. Metadata of the current chunk.
ChunkMetadata *Chunk_ChunkMetadata `protobuf:"bytes,7,opt,name=chunk_metadata,json=chunkMetadata,proto3" json:"chunk_metadata,omitempty"`
// contains filtered or unexported fields
}Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.
func (*Chunk) Descriptor
Deprecated: Use Chunk.ProtoReflect.Descriptor instead.
func (*Chunk) GetChunkMetadata
func (x *Chunk) GetChunkMetadata() *Chunk_ChunkMetadatafunc (*Chunk) GetContent
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
ChunkServiceClient
type ChunkServiceClient interface {
// Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
GetChunk(ctx context.Context, in *GetChunkRequest, opts ...grpc.CallOption) (*Chunk, error)
// Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
ListChunks(ctx context.Context, in *ListChunksRequest, opts ...grpc.CallOption) (*ListChunksResponse, error)
}ChunkServiceClient is the client API for ChunkService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewChunkServiceClient
func NewChunkServiceClient(cc grpc.ClientConnInterface) ChunkServiceClientChunkServiceServer
type ChunkServiceServer interface {
// Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
GetChunk(context.Context, *GetChunkRequest) (*Chunk, error)
// Gets a list of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
ListChunks(context.Context, *ListChunksRequest) (*ListChunksResponse, error)
}ChunkServiceServer is the server API for ChunkService service. All implementations should embed UnimplementedChunkServiceServer for forward compatibility
Chunk_ChunkMetadata
type Chunk_ChunkMetadata struct {
// The previous chunks of the current chunk. The number is controlled by
// [SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks].
// This field is only populated on
// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
// API.
PreviousChunks []*Chunk `protobuf:"bytes,1,rep,name=previous_chunks,json=previousChunks,proto3" json:"previous_chunks,omitempty"`
// The next chunks of the current chunk. The number is controlled by
// [SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks].
// This field is only populated on
// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
// API.
NextChunks []*Chunk `protobuf:"bytes,2,rep,name=next_chunks,json=nextChunks,proto3" json:"next_chunks,omitempty"`
// contains filtered or unexported fields
}Metadata of the current chunk. This field is only populated on [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] API.
func (*Chunk_ChunkMetadata) Descriptor
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"`
// Data representation.
// The structured JSON data for the document. It should conform to the
// registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an
// `INVALID_ARGUMENT` error is thrown.
StructData *structpb.Struct `protobuf:"bytes,3,opt,name=struct_data,json=structData,proto3" json:"struct_data,omitempty"`
// contains filtered or unexported fields
}Document metadata contains the information of the document of the current chunk.
func (*Chunk_DocumentMetadata) Descriptor
func (*Chunk_DocumentMetadata) Descriptor() ([]byte, []int)Deprecated: Use Chunk_DocumentMetadata.ProtoReflect.Descriptor instead.
func (*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() stringCloudSqlSource
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() stringCollectUserEventRequest
type CollectUserEventRequest struct {
// Required. The parent DataStore resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. URL encoded UserEvent proto with a length limit of 2,000,000
// characters.
UserEvent string `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
// The URL including cgi-parameters but excluding the hash fragment with a
// length limit of 5,000 characters. This is often more useful than the
// referer URL, because many browsers only send the domain for third-party
// requests.
Uri *string `protobuf:"bytes,3,opt,name=uri,proto3,oneof" json:"uri,omitempty"`
// The event timestamp in milliseconds. This prevents browser caching of
// otherwise identical get requests. The name is abbreviated to reduce the
// payload bytes.
Ets *int64 `protobuf:"varint,4,opt,name=ets,proto3,oneof" json:"ets,omitempty"`
// contains filtered or unexported fields
}Request message for CollectUserEvent method.
func (*CollectUserEventRequest) Descriptor
func (*CollectUserEventRequest) Descriptor() ([]byte, []int)Deprecated: Use CollectUserEventRequest.ProtoReflect.Descriptor instead.
func (*CollectUserEventRequest) GetEts
func (x *CollectUserEventRequest) GetEts() 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.v1alpha.SearchService.Search]
// API calls. Do not use it when there is no traffic for Search API.
// * `user-event` - Using suggestions generated from user-imported search
// events.
// * `document-completable` - Using suggestions taken directly from
// user-imported document fields marked as completable.
//
// Default values:
//
// * `document` is the default model for regular dataStores.
// * `search-history` is the default model for site search dataStores.
QueryModel string `protobuf:"bytes,3,opt,name=query_model,json=queryModel,proto3" json:"query_model,omitempty"`
// A unique identifier for tracking visitors. For example, this could be
// implemented with an HTTP cookie, which should be able to uniquely identify
// a visitor on a single device. This unique identifier should not change if
// the visitor logs in or out of the website.
//
// This field should NOT have a fixed value such as `unknown_visitor`.
//
// This should be the same identifier as
// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id]
// and
// [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id].
//
// The field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
UserPseudoId string `protobuf:"bytes,4,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
// Indicates if tail suggestions should be returned if there are no
// suggestions that match the full query. Even if set to true, if there are
// suggestions that match the full query, those are returned and no
// tail suggestions are returned.
IncludeTailSuggestions bool `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.v1alpha.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.v1alpha.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.v1alpha.CompleteQueryResponse.QuerySuggestion.suggestion].
SelectedSuggestion string `protobuf:"bytes,1,opt,name=selected_suggestion,json=selectedSuggestion,proto3" json:"selected_suggestion,omitempty"`
// End user selected
// [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion.suggestion]
// position, starting from 0.
SelectedPosition int32 `protobuf:"varint,2,opt,name=selected_position,json=selectedPosition,proto3" json:"selected_position,omitempty"`
// contains filtered or unexported fields
}Detailed completion information including completion attribution token and clicked completion info.
func (*CompletionInfo) Descriptor
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)
// Imports all
// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry]
// for a DataStore.
ImportSuggestionDenyListEntries(ctx context.Context, in *ImportSuggestionDenyListEntriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Permanently deletes all
// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry]
// for a DataStore.
PurgeSuggestionDenyListEntries(ctx context.Context, in *PurgeSuggestionDenyListEntriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Imports
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
// for a DataStore.
ImportCompletionSuggestions(ctx context.Context, in *ImportCompletionSuggestionsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Permanently deletes all
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
// for a DataStore.
PurgeCompletionSuggestions(ctx context.Context, in *PurgeCompletionSuggestionsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}CompletionServiceClient is the client API for CompletionService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewCompletionServiceClient
func NewCompletionServiceClient(cc grpc.ClientConnInterface) CompletionServiceClientCompletionServiceServer
type CompletionServiceServer interface {
// Completes the specified user input with keyword suggestions.
CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)
// Imports all
// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry]
// for a DataStore.
ImportSuggestionDenyListEntries(context.Context, *ImportSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)
// Permanently deletes all
// [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry]
// for a DataStore.
PurgeSuggestionDenyListEntries(context.Context, *PurgeSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)
// Imports
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
// for a DataStore.
ImportCompletionSuggestions(context.Context, *ImportCompletionSuggestionsRequest) (*longrunningpb.Operation, error)
// Permanently deletes all
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
// for a DataStore.
PurgeCompletionSuggestions(context.Context, *PurgeCompletionSuggestionsRequest) (*longrunningpb.Operation, error)
}CompletionServiceServer is the server API for CompletionService service. All implementations should embed UnimplementedCompletionServiceServer for forward compatibility
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.
//
// Maximum of 10 query terms.
QueryTerms []*Condition_QueryTerm `protobuf:"bytes,2,rep,name=query_terms,json=queryTerms,proto3" json:"query_terms,omitempty"`
// Range of time(s) specifying when condition is active.
//
// Maximum of 10 time ranges.
ActiveTimeRange []*Condition_TimeRange `protobuf:"bytes,3,rep,name=active_time_range,json=activeTimeRange,proto3" json:"active_time_range,omitempty"`
// contains filtered or unexported fields
}Defines circumstances to be checked before allowing a behavior
func (*Condition) Descriptor
Deprecated: Use Condition.ProtoReflect.Descriptor instead.
func (*Condition) GetActiveTimeRange
func (x *Condition) GetActiveTimeRange() []*Condition_TimeRangefunc (*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 {
// Actions are restricted by Vertical and Solution
//
// Required.
//
// Types that are valid to be assigned to Action:
//
// *Control_BoostAction_
// *Control_FilterAction_
// *Control_RedirectAction_
// *Control_SynonymsAction_
Action isControl_Action `protobuf_oneof:"action"`
// Immutable. Fully qualified name
// `projects/*/locations/global/dataStore/*/controls/*`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Human readable name. The identifier used in UI views.
//
// Must be UTF-8 encoded string. Length limit is 128 characters.
// Otherwise an INVALID ARGUMENT error is thrown.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. List of all
// [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] IDs
// this control is attached to. May take up to 10 minutes to update after
// changes.
AssociatedServingConfigIds []string `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.v1alpha.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.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
// Currently only allow one use case per control.
// Must be set when solution_type is
// [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
UseCases []SearchUseCase `protobuf:"varint,8,rep,packed,name=use_cases,json=useCases,proto3,enum=google.cloud.discoveryengine.v1alpha.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.v1alpha.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) 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.v1alpha.Control] to create
// already exists, an ALREADY_EXISTS error is returned.
CreateControl(ctx context.Context, in *CreateControlRequest, opts ...grpc.CallOption) (*Control, error)
// Deletes a Control.
//
// If the [Control][google.cloud.discoveryengine.v1alpha.Control] to delete
// does not exist, a NOT_FOUND error is returned.
DeleteControl(ctx context.Context, in *DeleteControlRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates a Control.
//
// [Control][google.cloud.discoveryengine.v1alpha.Control] action type cannot
// be changed. If the [Control][google.cloud.discoveryengine.v1alpha.Control]
// to update does not exist, a NOT_FOUND error is returned.
UpdateControl(ctx context.Context, in *UpdateControlRequest, opts ...grpc.CallOption) (*Control, error)
// Gets a Control.
GetControl(ctx context.Context, in *GetControlRequest, opts ...grpc.CallOption) (*Control, error)
// Lists all Controls by their parent
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
ListControls(ctx context.Context, in *ListControlsRequest, opts ...grpc.CallOption) (*ListControlsResponse, error)
}ControlServiceClient is the client API for ControlService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewControlServiceClient
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.v1alpha.Control] to create
// already exists, an ALREADY_EXISTS error is returned.
CreateControl(context.Context, *CreateControlRequest) (*Control, error)
// Deletes a Control.
//
// If the [Control][google.cloud.discoveryengine.v1alpha.Control] to delete
// does not exist, a NOT_FOUND error is returned.
DeleteControl(context.Context, *DeleteControlRequest) (*emptypb.Empty, error)
// Updates a Control.
//
// [Control][google.cloud.discoveryengine.v1alpha.Control] action type cannot
// be changed. If the [Control][google.cloud.discoveryengine.v1alpha.Control]
// to update does not exist, a NOT_FOUND error is returned.
UpdateControl(context.Context, *UpdateControlRequest) (*Control, error)
// Gets a Control.
GetControl(context.Context, *GetControlRequest) (*Control, error)
// Lists all Controls by their parent
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
ListControls(context.Context, *ListControlsRequest) (*ListControlsResponse, error)
}ControlServiceServer is the server API for ControlService service. All implementations should embed UnimplementedControlServiceServer for forward compatibility
Control_BoostAction
type Control_BoostAction struct {
// Required. Strength of the boost, which should be in [-1, 1]. Negative
// boost means demotion. Default is 0.0 (No-op).
Boost float32 `protobuf:"fixed32,1,opt,name=boost,proto3" json:"boost,omitempty"`
// Required. Specifies which products to apply the boost to.
//
// If no filter is provided all products will be boosted (No-op).
// Syntax documentation:
// https://cloud.google.com/retail/docs/filter-and-order
// Maximum length is 5000 characters.
// Otherwise an INVALID ARGUMENT error is thrown.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Required. Specifies which data store's documents can be boosted by this
// control. Full data store name e.g.
// projects/123/locations/global/collections/default_collection/dataStores/default_data_store
DataStore string `protobuf:"bytes,3,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// contains filtered or unexported fields
}Adjusts order of products in returned list.
func (*Control_BoostAction) Descriptor
func (*Control_BoostAction) Descriptor() ([]byte, []int)Deprecated: Use Control_BoostAction.ProtoReflect.Descriptor instead.
func (*Control_BoostAction) GetBoost
func (x *Control_BoostAction) GetBoost() float32func (*Control_BoostAction) GetDataStore
func (x *Control_BoostAction) GetDataStore() stringfunc (*Control_BoostAction) GetFilter
func (x *Control_BoostAction) GetFilter() stringfunc (*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_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_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.v1alpha.Conversation_State" json:"state,omitempty"`
// A unique identifier for tracking users.
UserPseudoId string `protobuf:"bytes,3,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
// Conversation messages.
Messages []*ConversationMessage `protobuf:"bytes,4,rep,name=messages,proto3" json:"messages,omitempty"`
// Output only. The time the conversation started.
StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. The time the conversation finished.
EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}External conversation proto definition.
func (*Conversation) Descriptor
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.v1alpha.Conversation] to
// create already exists, an ALREADY_EXISTS error is returned.
CreateConversation(ctx context.Context, in *CreateConversationRequest, opts ...grpc.CallOption) (*Conversation, error)
// Deletes a Conversation.
//
// If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
// delete does not exist, a NOT_FOUND error is returned.
DeleteConversation(ctx context.Context, in *DeleteConversationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates a Conversation.
//
// [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] action
// type cannot be changed. If the
// [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to update
// does not exist, a NOT_FOUND error is returned.
UpdateConversation(ctx context.Context, in *UpdateConversationRequest, opts ...grpc.CallOption) (*Conversation, error)
// Gets a Conversation.
GetConversation(ctx context.Context, in *GetConversationRequest, opts ...grpc.CallOption) (*Conversation, error)
// Lists all Conversations by their parent
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
ListConversations(ctx context.Context, in *ListConversationsRequest, opts ...grpc.CallOption) (*ListConversationsResponse, error)
// Answer query method.
AnswerQuery(ctx context.Context, in *AnswerQueryRequest, opts ...grpc.CallOption) (*AnswerQueryResponse, error)
// Gets a Answer.
GetAnswer(ctx context.Context, in *GetAnswerRequest, opts ...grpc.CallOption) (*Answer, error)
// Creates a Session.
//
// If the [Session][google.cloud.discoveryengine.v1alpha.Session] to create
// already exists, an ALREADY_EXISTS error is returned.
CreateSession(ctx context.Context, in *CreateSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Deletes a Session.
//
// If the [Session][google.cloud.discoveryengine.v1alpha.Session] to delete
// does not exist, a NOT_FOUND error is returned.
DeleteSession(ctx context.Context, in *DeleteSessionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates a Session.
//
// [Session][google.cloud.discoveryengine.v1alpha.Session] action type cannot
// be changed. If the [Session][google.cloud.discoveryengine.v1alpha.Session]
// to update does not exist, a NOT_FOUND error is returned.
UpdateSession(ctx context.Context, in *UpdateSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Gets a Session.
GetSession(ctx context.Context, in *GetSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Lists all Sessions by their parent
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
ListSessions(ctx context.Context, in *ListSessionsRequest, opts ...grpc.CallOption) (*ListSessionsResponse, error)
}ConversationalSearchServiceClient is the client API for ConversationalSearchService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewConversationalSearchServiceClient
func NewConversationalSearchServiceClient(cc grpc.ClientConnInterface) ConversationalSearchServiceClientConversationalSearchServiceServer
type ConversationalSearchServiceServer interface {
// Converses a conversation.
ConverseConversation(context.Context, *ConverseConversationRequest) (*ConverseConversationResponse, error)
// Creates a Conversation.
//
// If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
// create already exists, an ALREADY_EXISTS error is returned.
CreateConversation(context.Context, *CreateConversationRequest) (*Conversation, error)
// Deletes a Conversation.
//
// If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
// delete does not exist, a NOT_FOUND error is returned.
DeleteConversation(context.Context, *DeleteConversationRequest) (*emptypb.Empty, error)
// Updates a Conversation.
//
// [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] action
// type cannot be changed. If the
// [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to update
// does not exist, a NOT_FOUND error is returned.
UpdateConversation(context.Context, *UpdateConversationRequest) (*Conversation, error)
// Gets a Conversation.
GetConversation(context.Context, *GetConversationRequest) (*Conversation, error)
// Lists all Conversations by their parent
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
ListConversations(context.Context, *ListConversationsRequest) (*ListConversationsResponse, error)
// Answer query method.
AnswerQuery(context.Context, *AnswerQueryRequest) (*AnswerQueryResponse, error)
// Gets a Answer.
GetAnswer(context.Context, *GetAnswerRequest) (*Answer, error)
// Creates a Session.
//
// If the [Session][google.cloud.discoveryengine.v1alpha.Session] to create
// already exists, an ALREADY_EXISTS error is returned.
CreateSession(context.Context, *CreateSessionRequest) (*Session, error)
// Deletes a Session.
//
// If the [Session][google.cloud.discoveryengine.v1alpha.Session] to delete
// does not exist, a NOT_FOUND error is returned.
DeleteSession(context.Context, *DeleteSessionRequest) (*emptypb.Empty, error)
// Updates a Session.
//
// [Session][google.cloud.discoveryengine.v1alpha.Session] action type cannot
// be changed. If the [Session][google.cloud.discoveryengine.v1alpha.Session]
// to update does not exist, a NOT_FOUND error is returned.
UpdateSession(context.Context, *UpdateSessionRequest) (*Session, error)
// Gets a Session.
GetSession(context.Context, *GetSessionRequest) (*Session, error)
// Lists all Sessions by their parent
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)
}ConversationalSearchServiceServer is the server API for ConversationalSearchService service. All implementations should embed UnimplementedConversationalSearchServiceServer for forward compatibility
ConverseConversationRequest
type ConverseConversationRequest struct {
// Required. The resource name of the Conversation to get. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
// Use
// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
// to activate auto session mode, which automatically creates a new
// conversation inside a ConverseConversation session.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Current user input.
Query *TextInput `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
// The resource name of the Serving Config to use. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
// If this is not set, the default serving config will be used.
ServingConfig string `protobuf:"bytes,3,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
// The conversation to be used by auto session only. The name field will be
// ignored as we automatically assign new name for the conversation in auto
// session.
Conversation *Conversation `protobuf:"bytes,5,opt,name=conversation,proto3" json:"conversation,omitempty"`
// Whether to turn on safe search.
SafeSearch bool `protobuf:"varint,6,opt,name=safe_search,json=safeSearch,proto3" json:"safe_search,omitempty"`
// The user labels applied to a resource must meet the following requirements:
//
// - Each resource can have multiple labels, up to a maximum of 64.
// - Each label must be a key-value pair.
// - Keys have a minimum length of 1 character and a maximum length of 63
// characters and cannot be empty. Values can be empty and have a maximum
// length of 63 characters.
// - Keys and values can contain only lowercase letters, numeric characters,
// underscores, and dashes. All characters must use UTF-8 encoding, and
// international characters are allowed.
// - The key portion of a label must be unique. However, you can use the same
// key with multiple resources.
// - Keys must start with a lowercase letter or international character.
//
// See [Google Cloud
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
// for more details.
UserLabels map[string]string `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.v1alpha.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.v1alpha.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() stringCreateControlRequest
type CreateControlRequest struct {
// Required. Full resource name of parent data store. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
// or
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The Control to create.
Control *Control `protobuf:"bytes,2,opt,name=control,proto3" json:"control,omitempty"`
// Required. The ID to use for the Control, which will become the final
// component of the Control's resource name.
//
// This value must be within 1-63 characters.
// Valid characters are /[a-z][0-9]-_/.
ControlId string `protobuf:"bytes,3,opt,name=control_id,json=controlId,proto3" json:"control_id,omitempty"`
// contains filtered or unexported fields
}Request for CreateControl method.
func (*CreateControlRequest) Descriptor
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_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The conversation to create.
Conversation *Conversation `protobuf:"bytes,2,opt,name=conversation,proto3" json:"conversation,omitempty"`
// contains filtered or unexported fields
}Request for CreateConversation method.
func (*CreateConversationRequest) Descriptor
func (*CreateConversationRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateConversationRequest.ProtoReflect.Descriptor instead.
func (*CreateConversationRequest) GetConversation
func (x *CreateConversationRequest) GetConversation() *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.v1alpha.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 {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
// to create.
DataStore *DataStore `protobuf:"bytes,2,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// Required. The ID to use for the
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], which will
// become the final component of the
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]'s resource
// name.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters. Otherwise, an
// INVALID_ARGUMENT error is returned.
DataStoreId string `protobuf:"bytes,3,opt,name=data_store_id,json=dataStoreId,proto3" json:"data_store_id,omitempty"`
// A boolean flag indicating whether user want to directly create an advanced
// data store for site search.
// If the data store is not configured as site
// search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
// be ignored.
CreateAdvancedSiteSearch bool `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.v1alpha.DataStoreService.CreateDataStore] method.
func (*CreateDataStoreRequest) Descriptor
func (*CreateDataStoreRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateDataStoreRequest.ProtoReflect.Descriptor instead.
func (*CreateDataStoreRequest) GetCreateAdvancedSiteSearch
func (x *CreateDataStoreRequest) GetCreateAdvancedSiteSearch() boolfunc (*CreateDataStoreRequest) GetDataStore
func (x *CreateDataStoreRequest) GetDataStore() *DataStorefunc (*CreateDataStoreRequest) GetDataStoreId
func (x *CreateDataStoreRequest) GetDataStoreId() stringfunc (*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() stringCreateDocumentRequest
type CreateDocumentRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [Document][google.cloud.discoveryengine.v1alpha.Document] to
// create.
Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
// Required. The ID to use for the
// [Document][google.cloud.discoveryengine.v1alpha.Document], which becomes
// the final component of the
// [Document.name][google.cloud.discoveryengine.v1alpha.Document.name].
//
// If the caller does not have permission to create the
// [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
// whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// This field must be unique among all
// [Document][google.cloud.discoveryengine.v1alpha.Document]s with the same
// [parent][google.cloud.discoveryengine.v1alpha.CreateDocumentRequest.parent].
// Otherwise, an `ALREADY_EXISTS` error is returned.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
DocumentId string `protobuf:"bytes,3,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.CreateDocument][google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocument] method.
func (*CreateDocumentRequest) Descriptor
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.v1alpha.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.v1alpha.Engine] to
// create.
Engine *Engine `protobuf:"bytes,2,opt,name=engine,proto3" json:"engine,omitempty"`
// Required. The ID to use for the
// [Engine][google.cloud.discoveryengine.v1alpha.Engine], which will become
// the final component of the
// [Engine][google.cloud.discoveryengine.v1alpha.Engine]'s resource name.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters. Otherwise, an
// INVALID_ARGUMENT error is returned.
EngineId string `protobuf:"bytes,3,opt,name=engine_id,json=engineId,proto3" json:"engine_id,omitempty"`
// contains filtered or unexported fields
}Request for [EngineService.CreateEngine][google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine] method.
func (*CreateEngineRequest) Descriptor
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.v1alpha.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.v1alpha.Evaluation]
// to create.
Evaluation *Evaluation `protobuf:"bytes,2,opt,name=evaluation,proto3" json:"evaluation,omitempty"`
// contains filtered or unexported fields
}Request message for [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.CreateEvaluation] method.
func (*CreateEvaluationRequest) Descriptor
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() 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.v1alpha.SampleQuery] to create.
SampleQuery *SampleQuery `protobuf:"bytes,2,opt,name=sample_query,json=sampleQuery,proto3" json:"sample_query,omitempty"`
// Required. The ID to use for the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], which will
// become the final component of the
// [SampleQuery.name][google.cloud.discoveryengine.v1alpha.SampleQuery.name].
//
// If the caller does not have permission to create the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
// of whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// This field must be unique among all
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s with the
// same
// [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest.parent].
// Otherwise, an `ALREADY_EXISTS` error is returned.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
SampleQueryId string `protobuf:"bytes,3,opt,name=sample_query_id,json=sampleQueryId,proto3" json:"sample_query_id,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.CreateSampleQuery] method.
func (*CreateSampleQueryRequest) Descriptor
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.v1alpha.SampleQuerySet] to
// create.
SampleQuerySet *SampleQuerySet `protobuf:"bytes,2,opt,name=sample_query_set,json=sampleQuerySet,proto3" json:"sample_query_set,omitempty"`
// Required. The ID to use for the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
// which will become the final component of the
// [SampleQuerySet.name][google.cloud.discoveryengine.v1alpha.SampleQuerySet.name].
//
// If the caller does not have permission to create the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
// regardless of whether or not it exists, a `PERMISSION_DENIED` error is
// returned.
//
// This field must be unique among all
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s with
// the same
// [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest.parent].
// Otherwise, an `ALREADY_EXISTS` error is returned.
//
// This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
SampleQuerySetId string `protobuf:"bytes,3,opt,name=sample_query_set_id,json=sampleQuerySetId,proto3" json:"sample_query_set_id,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.CreateSampleQuerySet] method.
func (*CreateSampleQuerySetRequest) Descriptor
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.v1alpha.Schema] to
// create.
Schema *Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
// Required. The ID to use for the
// [Schema][google.cloud.discoveryengine.v1alpha.Schema], which becomes the
// final component of the
// [Schema.name][google.cloud.discoveryengine.v1alpha.Schema.name].
//
// This field should conform to
// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
// limit of 63 characters.
SchemaId string `protobuf:"bytes,3,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
// contains filtered or unexported fields
}Request message for [SchemaService.CreateSchema][google.cloud.discoveryengine.v1alpha.SchemaService.CreateSchema] method.
func (*CreateSchemaRequest) Descriptor
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() 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"`
// 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) 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() 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.v1alpha.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.v1alpha.TargetSite], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]
// to create.
TargetSite *TargetSite `protobuf:"bytes,2,opt,name=target_site,json=targetSite,proto3" json:"target_site,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite] method.
func (*CreateTargetSiteRequest) Descriptor
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.v1alpha.CustomAttribute.text]
// or
// [CustomAttribute.numbers][google.cloud.discoveryengine.v1alpha.CustomAttribute.numbers]
// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
Text []string `protobuf:"bytes,1,rep,name=text,proto3" json:"text,omitempty"`
// The numerical values of this custom attribute. For example, `[2.3, 15.4]`
// when the key is "lengths_cm".
//
// Exactly one of
// [CustomAttribute.text][google.cloud.discoveryengine.v1alpha.CustomAttribute.text]
// or
// [CustomAttribute.numbers][google.cloud.discoveryengine.v1alpha.CustomAttribute.numbers]
// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
Numbers []float64 `protobuf:"fixed64,2,rep,packed,name=numbers,proto3" json:"numbers,omitempty"`
// contains filtered or unexported fields
}A custom attribute that is not explicitly modeled in a resource, e.g. [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent].
func (*CustomAttribute) Descriptor
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() stringCustomFineTuningSpec
type CustomFineTuningSpec struct {
// Whether or not to enable and include custom fine tuned search adaptor
// model.
EnableSearchAdaptor bool `protobuf:"varint,1,opt,name=enable_search_adaptor,json=enableSearchAdaptor,proto3" json:"enable_search_adaptor,omitempty"`
// contains filtered or unexported fields
}Defines custom fine tuning spec.
func (*CustomFineTuningSpec) Descriptor
func (*CustomFineTuningSpec) Descriptor() ([]byte, []int)Deprecated: Use CustomFineTuningSpec.ProtoReflect.Descriptor instead.
func (*CustomFineTuningSpec) GetEnableSearchAdaptor
func (x *CustomFineTuningSpec) GetEnableSearchAdaptor() boolfunc (*CustomFineTuningSpec) ProtoMessage
func (*CustomFineTuningSpec) ProtoMessage()func (*CustomFineTuningSpec) ProtoReflect
func (x *CustomFineTuningSpec) ProtoReflect() protoreflect.Messagefunc (*CustomFineTuningSpec) Reset
func (x *CustomFineTuningSpec) Reset()func (*CustomFineTuningSpec) String
func (x *CustomFineTuningSpec) String() stringCustomTuningModel
type CustomTuningModel struct {
// Required. The fully qualified resource name of the model.
//
// Format:
// `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`
// model must be an alpha-numerical string with limit of 40 characters.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The display name of the model.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The version of the model.
ModelVersion int64 `protobuf:"varint,3,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
// The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
ModelState CustomTuningModel_ModelState `protobuf:"varint,4,opt,name=model_state,json=modelState,proto3,enum=google.cloud.discoveryengine.v1alpha.CustomTuningModel_ModelState" json:"model_state,omitempty"`
// Timestamp the Model was created at.
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Timestamp the model training was initiated.
TrainingStartTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=training_start_time,json=trainingStartTime,proto3" json:"training_start_time,omitempty"`
// The metrics of the trained model.
Metrics map[string]float64 `protobuf:"bytes,7,rep,name=metrics,proto3" json:"metrics,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"fixed64,2,opt,name=value"`
// 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/v1alpha/custom_tuning_model.proto.
func (*CustomTuningModel) GetDisplayName
func (x *CustomTuningModel) GetDisplayName() 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. 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.v1alpha.IndustryVertical" json:"industry_vertical,omitempty"`
// The solutions that the data store enrolls. Available solutions for each
// [industry_vertical][google.cloud.discoveryengine.v1alpha.DataStore.industry_vertical]:
//
// - `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
// - `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
// solutions cannot be enrolled.
SolutionTypes []SolutionType `protobuf:"varint,5,rep,packed,name=solution_types,json=solutionTypes,proto3,enum=google.cloud.discoveryengine.v1alpha.SolutionType" json:"solution_types,omitempty"`
// Output only. The id of the default
// [Schema][google.cloud.discoveryengine.v1alpha.Schema] asscociated to this
// data store.
DefaultSchemaId string `protobuf:"bytes,7,opt,name=default_schema_id,json=defaultSchemaId,proto3" json:"default_schema_id,omitempty"`
// Immutable. The content config of the data store. If this field is unset,
// the server behavior defaults to
// [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.NO_CONTENT].
ContentConfig DataStore_ContentConfig `protobuf:"varint,6,opt,name=content_config,json=contentConfig,proto3,enum=google.cloud.discoveryengine.v1alpha.DataStore_ContentConfig" json:"content_config,omitempty"`
// Output only. Timestamp the
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] was created at.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Language info for DataStore.
LanguageInfo *LanguageInfo `protobuf:"bytes,14,opt,name=language_info,json=languageInfo,proto3" json:"language_info,omitempty"`
// Output only. Data store level identity provider config.
IdpConfig *IdpConfig `protobuf:"bytes,21,opt,name=idp_config,json=idpConfig,proto3" json:"idp_config,omitempty"`
// Immutable. Whether data in the
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] has ACL
// information. If set to `true`, the source data must have ACL. ACL will be
// ingested when data is ingested by
// [DocumentService.ImportDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments]
// methods.
//
// When ACL is enabled for the
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore],
// [Document][google.cloud.discoveryengine.v1alpha.Document] can't be accessed
// by calling
// [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument]
// or
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments].
//
// Currently ACL is only supported in `GENERIC` industry vertical with
// non-`PUBLIC_WEBSITE` content config.
AclEnabled bool `protobuf:"varint,24,opt,name=acl_enabled,json=aclEnabled,proto3" json:"acl_enabled,omitempty"`
// Config to store data store type configuration for workspace data. This
// must be set when
// [DataStore.content_config][google.cloud.discoveryengine.v1alpha.DataStore.content_config]
// is set as
// [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.GOOGLE_WORKSPACE].
WorkspaceConfig *WorkspaceConfig `protobuf:"bytes,25,opt,name=workspace_config,json=workspaceConfig,proto3" json:"workspace_config,omitempty"`
// Configuration for Document understanding and enrichment.
DocumentProcessingConfig *DocumentProcessingConfig `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.v1alpha.DataStore] when
// provisioning it. If unset, a default vertical specialized schema will be
// used.
//
// This field is only used by [CreateDataStore][] API, and will be ignored if
// used in other APIs. This field will be omitted from all API responses
// including [CreateDataStore][] API. To retrieve a schema of a
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], use
// [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema]
// API instead.
//
// The provided schema will be validated against certain rules on schema.
// Learn more from [this
// doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
StartingSchema *Schema `protobuf:"bytes,28,opt,name=starting_schema,json=startingSchema,proto3" json:"starting_schema,omitempty"`
// contains filtered or unexported fields
}DataStore captures global settings and configs at the DataStore level.
func (*DataStore) Descriptor
Deprecated: Use DataStore.ProtoReflect.Descriptor instead.
func (*DataStore) GetAclEnabled
func (*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) GetIdpConfig
func (*DataStore) GetIndustryVertical
func (x *DataStore) GetIndustryVertical() IndustryVerticalfunc (*DataStore) GetLanguageInfo
func (x *DataStore) GetLanguageInfo() *LanguageInfofunc (*DataStore) GetName
func (*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.v1alpha.DataStore].
//
// DataStore is for storing
// [Documents][google.cloud.discoveryengine.v1alpha.Document]. To serve these
// documents for Search, or Recommendation use case, an
// [Engine][google.cloud.discoveryengine.v1alpha.Engine] needs to be created
// separately.
CreateDataStore(ctx context.Context, in *CreateDataStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
GetDataStore(ctx context.Context, in *GetDataStoreRequest, opts ...grpc.CallOption) (*DataStore, error)
// Lists all the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s
// associated with the project.
ListDataStores(ctx context.Context, in *ListDataStoresRequest, opts ...grpc.CallOption) (*ListDataStoresResponse, error)
// Deletes a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
DeleteDataStore(ctx context.Context, in *DeleteDataStoreRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
UpdateDataStore(ctx context.Context, in *UpdateDataStoreRequest, opts ...grpc.CallOption) (*DataStore, error)
// Gets a
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
GetDocumentProcessingConfig(ctx context.Context, in *GetDocumentProcessingConfigRequest, opts ...grpc.CallOption) (*DocumentProcessingConfig, error)
// Updates the
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
// is a singleon resource of
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. It's empty
// when [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is
// created. The first call to this method will set up
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
UpdateDocumentProcessingConfig(ctx context.Context, in *UpdateDocumentProcessingConfigRequest, opts ...grpc.CallOption) (*DocumentProcessingConfig, error)
}DataStoreServiceClient is the client API for DataStoreService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewDataStoreServiceClient
func NewDataStoreServiceClient(cc grpc.ClientConnInterface) DataStoreServiceClientDataStoreServiceServer
type DataStoreServiceServer interface {
// Creates a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
//
// DataStore is for storing
// [Documents][google.cloud.discoveryengine.v1alpha.Document]. To serve these
// documents for Search, or Recommendation use case, an
// [Engine][google.cloud.discoveryengine.v1alpha.Engine] needs to be created
// separately.
CreateDataStore(context.Context, *CreateDataStoreRequest) (*longrunningpb.Operation, error)
// Gets a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
GetDataStore(context.Context, *GetDataStoreRequest) (*DataStore, error)
// Lists all the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s
// associated with the project.
ListDataStores(context.Context, *ListDataStoresRequest) (*ListDataStoresResponse, error)
// Deletes a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
DeleteDataStore(context.Context, *DeleteDataStoreRequest) (*longrunningpb.Operation, error)
// Updates a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
UpdateDataStore(context.Context, *UpdateDataStoreRequest) (*DataStore, error)
// Gets a
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
GetDocumentProcessingConfig(context.Context, *GetDocumentProcessingConfigRequest) (*DocumentProcessingConfig, error)
// Updates the
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
// is a singleon resource of
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. It's empty
// when [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is
// created. The first call to this method will set up
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig].
UpdateDocumentProcessingConfig(context.Context, *UpdateDocumentProcessingConfigRequest) (*DocumentProcessingConfig, error)
}DataStoreServiceServer is the server API for DataStoreService service. All implementations should embed UnimplementedDataStoreServiceServer for forward compatibility
DataStore_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.v1alpha.Document.content].
DataStore_NO_CONTENT DataStore_ContentConfig = 1
// Only contains documents with
// [Document.content][google.cloud.discoveryengine.v1alpha.Document.content].
DataStore_CONTENT_REQUIRED DataStore_ContentConfig = 2
// The data store is used for public website search.
DataStore_PUBLIC_WEBSITE DataStore_ContentConfig = 3
// The data store is used for workspace search. Details of workspace
// data store are specified in the
// [WorkspaceConfig][google.cloud.discoveryengine.v1alpha.WorkspaceConfig].
DataStore_GOOGLE_WORKSPACE DataStore_ContentConfig = 4
)func (DataStore_ContentConfig) Descriptor
func (DataStore_ContentConfig) Descriptor() protoreflect.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.EnumTypeDeleteControlRequest
type DeleteControlRequest struct {
// Required. The resource name of the Control to delete. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for DeleteControl method.
func (*DeleteControlRequest) Descriptor
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_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for DeleteConversation method.
func (*DeleteConversationRequest) Descriptor
func (*DeleteConversationRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteConversationRequest.ProtoReflect.Descriptor instead.
func (*DeleteConversationRequest) GetName
func (x *DeleteConversationRequest) GetName() 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.v1alpha.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.v1alpha.DataStore], such as
// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
//
// If the caller does not have permission to delete the
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], regardless of
// whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] to
// delete does not exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore] method.
func (*DeleteDataStoreRequest) Descriptor
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.v1alpha.Document], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
//
// If the caller does not have permission to delete the
// [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
// whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// If the [Document][google.cloud.discoveryengine.v1alpha.Document] to delete
// does not exist, a `NOT_FOUND` error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1alpha.DocumentService.DeleteDocument] method.
func (*DeleteDocumentRequest) Descriptor
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.v1alpha.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.v1alpha.Engine], such as
// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
//
// If the caller does not have permission to delete the
// [Engine][google.cloud.discoveryengine.v1alpha.Engine], regardless of
// whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the [Engine][google.cloud.discoveryengine.v1alpha.Engine] to delete does
// not exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [EngineService.DeleteEngine][google.cloud.discoveryengine.v1alpha.EngineService.DeleteEngine] method.
func (*DeleteEngineRequest) Descriptor
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() stringDeleteSampleQueryRequest
type DeleteSampleQueryRequest struct {
// Required. Full resource name of
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
//
// If the caller does not have permission to delete the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
// of whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// If the [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] to
// delete does not exist, a `NOT_FOUND` error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.DeleteSampleQuery] method.
func (*DeleteSampleQueryRequest) Descriptor
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.v1alpha.SampleQuerySet], such
// as
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
//
// If the caller does not have permission to delete the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
// regardless of whether or not it exists, a `PERMISSION_DENIED` error is
// returned.
//
// If the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] to
// delete does not exist, a `NOT_FOUND` error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.DeleteSampleQuerySet] method.
func (*DeleteSampleQuerySetRequest) Descriptor
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.v1alpha.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() 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() 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.v1alpha.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.v1alpha.TargetSite], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
//
// If the caller does not have permission to access the
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], regardless
// of whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the requested
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] does not
// exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite] method.
func (*DeleteTargetSiteRequest) Descriptor
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.v1alpha.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.v1alpha.SiteSearchEngine],
// such as
// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] method.
func (*DisableAdvancedSiteSearchRequest) Descriptor
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.v1alpha.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() stringDocument
type Document struct {
// Data representation. One of
// [struct_data][google.cloud.discoveryengine.v1alpha.Document.struct_data] or
// [json_data][google.cloud.discoveryengine.v1alpha.Document.json_data] should
// be provided otherwise an `INVALID_ARGUMENT` error is thrown.
//
// Types that are 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 63 characters.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// The identifier of the schema located in the same data store.
SchemaId string `protobuf:"bytes,3,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
// The unstructured data linked to this document. Content must be set if this
// document is under a
// `CONTENT_REQUIRED` data store.
Content *Document_Content `protobuf:"bytes,10,opt,name=content,proto3" json:"content,omitempty"`
// The identifier of the parent document. Currently supports at most two level
// document hierarchy.
//
// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
// standard with a length limit of 63 characters.
ParentDocumentId string `protobuf:"bytes,7,opt,name=parent_document_id,json=parentDocumentId,proto3" json:"parent_document_id,omitempty"`
// Output only. This field is OUTPUT_ONLY.
// It contains derived data that are not in the original input document.
DerivedStructData *structpb.Struct `protobuf:"bytes,6,opt,name=derived_struct_data,json=derivedStructData,proto3" json:"derived_struct_data,omitempty"`
// Access control information for the document.
AclInfo *Document_AclInfo `protobuf:"bytes,11,opt,name=acl_info,json=aclInfo,proto3" json:"acl_info,omitempty"`
// Output only. The last time the document was indexed. If this field is set,
// the document could be returned in search results.
//
// This field is OUTPUT_ONLY. If this field is not populated, it means the
// document has never been indexed.
IndexTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=index_time,json=indexTime,proto3" json:"index_time,omitempty"`
// Output only. The index status of the document.
//
// - If document is indexed successfully, the index_time field is populated.
// - Otherwise, if document is not indexed due to errors, the error_samples
// field is populated.
// - Otherwise, index_status is unset.
IndexStatus *Document_IndexStatus `protobuf:"bytes,15,opt,name=index_status,json=indexStatus,proto3" json:"index_status,omitempty"`
// contains filtered or unexported fields
}Document captures all raw metadata information of items to be recommended or searched.
func (*Document) Descriptor
Deprecated: 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.v1alpha.Document].
//
// * If [id][google.cloud.discoveryengine.v1alpha.DocumentInfo.id] is
// specified, then the default values for
// `{location}`, `{collection_id}`, `{data_store_id}`, and `{branch_id}` are
// used when annotating with the stored Document.
//
// * If [name][google.cloud.discoveryengine.v1alpha.DocumentInfo.name] is
// specified, then the provided values (default values allowed) for
// `{location}`, `{collection_id}`, `{data_store_id}`, and
// `{branch_id}` are used when annotating with the stored Document.
//
// Types that are 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"`
// contains filtered or unexported fields
}Detailed document information associated with a user event.
func (*DocumentInfo) Descriptor
func (*DocumentInfo) Descriptor() ([]byte, []int)Deprecated: Use DocumentInfo.ProtoReflect.Descriptor instead.
func (*DocumentInfo) GetDocumentDescriptor
func (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.v1alpha.Document] resource
// ID.
Id string `protobuf:"bytes,1,opt,name=id,proto3,oneof"`
}DocumentInfo_Name
type DocumentInfo_Name struct {
// The [Document][google.cloud.discoveryengine.v1alpha.Document] resource
// full name, of the form:
// `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
Name string `protobuf:"bytes,2,opt,name=name,proto3,oneof"`
}DocumentInfo_Uri
type DocumentInfo_Uri struct {
// The [Document][google.cloud.discoveryengine.v1alpha.Document] URI - only
// allowed for website data stores.
Uri string `protobuf:"bytes,6,opt,name=uri,proto3,oneof"`
}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.
// * `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.v1alpha.DataStore]. It's empty when [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is created, which defaults to digital parser. The first call to [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] method will initialize the config.
func (*DocumentProcessingConfig) Descriptor
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 {
// 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) 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/v1alpha/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/v1alpha/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.v1alpha.Document].
GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Gets a list of [Document][google.cloud.discoveryengine.v1alpha.Document]s.
ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...grpc.CallOption) (*ListDocumentsResponse, error)
// Creates a [Document][google.cloud.discoveryengine.v1alpha.Document].
CreateDocument(ctx context.Context, in *CreateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Updates a [Document][google.cloud.discoveryengine.v1alpha.Document].
UpdateDocument(ctx context.Context, in *UpdateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Deletes a [Document][google.cloud.discoveryengine.v1alpha.Document].
DeleteDocument(ctx context.Context, in *DeleteDocumentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Bulk import of multiple
// [Document][google.cloud.discoveryengine.v1alpha.Document]s. Request
// processing may be synchronous. Non-existing items are created.
//
// Note: It is possible for a subset of the
// [Document][google.cloud.discoveryengine.v1alpha.Document]s to be
// successfully updated.
ImportDocuments(ctx context.Context, in *ImportDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Permanently deletes all selected
// [Document][google.cloud.discoveryengine.v1alpha.Document]s in a branch.
//
// This process is asynchronous. Depending on the number of
// [Document][google.cloud.discoveryengine.v1alpha.Document]s to be deleted,
// this operation can take hours to complete. Before the delete operation
// completes, some [Document][google.cloud.discoveryengine.v1alpha.Document]s
// might still be returned by
// [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument]
// or
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments].
//
// To get a list of the
// [Document][google.cloud.discoveryengine.v1alpha.Document]s to be deleted,
// set
// [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.force]
// to false.
PurgeDocuments(ctx context.Context, in *PurgeDocumentsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets the parsed layout information for a
// [Document][google.cloud.discoveryengine.v1alpha.Document].
GetProcessedDocument(ctx context.Context, in *GetProcessedDocumentRequest, opts ...grpc.CallOption) (*ProcessedDocument, error)
// Gets index freshness metadata for
// [Document][google.cloud.discoveryengine.v1alpha.Document]s. Supported for
// website search only.
BatchGetDocumentsMetadata(ctx context.Context, in *BatchGetDocumentsMetadataRequest, opts ...grpc.CallOption) (*BatchGetDocumentsMetadataResponse, error)
}DocumentServiceClient is the client API for DocumentService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewDocumentServiceClient
func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClientDocumentServiceServer
type DocumentServiceServer interface {
// Gets a [Document][google.cloud.discoveryengine.v1alpha.Document].
GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
// Gets a list of [Document][google.cloud.discoveryengine.v1alpha.Document]s.
ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
// Creates a [Document][google.cloud.discoveryengine.v1alpha.Document].
CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
// Updates a [Document][google.cloud.discoveryengine.v1alpha.Document].
UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)
// Deletes a [Document][google.cloud.discoveryengine.v1alpha.Document].
DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
// Bulk import of multiple
// [Document][google.cloud.discoveryengine.v1alpha.Document]s. Request
// processing may be synchronous. Non-existing items are created.
//
// Note: It is possible for a subset of the
// [Document][google.cloud.discoveryengine.v1alpha.Document]s to be
// successfully updated.
ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)
// Permanently deletes all selected
// [Document][google.cloud.discoveryengine.v1alpha.Document]s in a branch.
//
// This process is asynchronous. Depending on the number of
// [Document][google.cloud.discoveryengine.v1alpha.Document]s to be deleted,
// this operation can take hours to complete. Before the delete operation
// completes, some [Document][google.cloud.discoveryengine.v1alpha.Document]s
// might still be returned by
// [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument]
// or
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments].
//
// To get a list of the
// [Document][google.cloud.discoveryengine.v1alpha.Document]s to be deleted,
// set
// [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.force]
// to false.
PurgeDocuments(context.Context, *PurgeDocumentsRequest) (*longrunningpb.Operation, error)
// Gets the parsed layout information for a
// [Document][google.cloud.discoveryengine.v1alpha.Document].
GetProcessedDocument(context.Context, *GetProcessedDocumentRequest) (*ProcessedDocument, error)
// Gets index freshness metadata for
// [Document][google.cloud.discoveryengine.v1alpha.Document]s. Supported for
// website search only.
BatchGetDocumentsMetadata(context.Context, *BatchGetDocumentsMetadataRequest) (*BatchGetDocumentsMetadataResponse, error)
}DocumentServiceServer is the server API for DocumentService service. All implementations should embed UnimplementedDocumentServiceServer for forward compatibility
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 {
// 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)
// * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
// * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
// * `text/plain` (TXT)
//
// See https://www.iana.org/assignments/media-types/media-types.xhtml.
MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// contains filtered or unexported fields
}Unstructured data linked to this document.
func (*Document_Content) Descriptor
func (*Document_Content) Descriptor() ([]byte, []int)Deprecated: Use Document_Content.ProtoReflect.Descriptor instead.
func (*Document_Content) GetContent
func (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.
IndexTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=index_time,json=indexTime,proto3" json:"index_time,omitempty"`
// A sample of errors encountered while indexing the document.
// If this field is populated, the document is not indexed due to errors.
ErrorSamples []*status.Status `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// contains filtered or unexported fields
}Index status of the document.
func (*Document_IndexStatus) Descriptor
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) 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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.SiteSearchEngine],
// such as
// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] method.
func (*EnableAdvancedSiteSearchRequest) Descriptor
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.v1alpha.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_SimilarDocumentsConfig
// *Engine_ChatEngineConfig_
// *Engine_SearchEngineConfig_
// *Engine_MediaRecommendationEngineConfig_
EngineConfig isEngine_EngineConfig `protobuf_oneof:"engine_config"`
// Engine metadata to monitor the status of the engine.
//
// Types that are valid to be assigned to EngineMetadata:
//
// *Engine_RecommendationMetadata_
// *Engine_ChatEngineMetadata_
EngineMetadata isEngine_EngineMetadata `protobuf_oneof:"engine_metadata"`
// Immutable. The fully qualified resource name of the engine.
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
//
// Format:
// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
// engine should be 1-63 characters, and valid characters are
// /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The display name of the engine. Should be human readable. UTF-8
// encoded string with limit of 1024 characters.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. Timestamp the Recommendation Engine was created at.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp the Recommendation Engine was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// The data stores associated with this engine.
//
// For
// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]
// and
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
// type of engines, they can only associate with at most one data store.
//
// If
// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
// is
// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT],
// multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in
// the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can
// be associated here.
//
// Note that when used in
// [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
// one DataStore id must be provided as the system will use it for necessary
// initializations.
DataStoreIds []string `protobuf:"bytes,5,rep,name=data_store_ids,json=dataStoreIds,proto3" json:"data_store_ids,omitempty"`
// Required. The solutions of the engine.
SolutionType SolutionType `protobuf:"varint,6,opt,name=solution_type,json=solutionType,proto3,enum=google.cloud.discoveryengine.v1alpha.SolutionType" json:"solution_type,omitempty"`
// The industry vertical that the engine registers.
// The restriction of the Engine industry vertical is based on
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]: If
// unspecified, default to `GENERIC`. 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.v1alpha.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"`
// contains filtered or unexported fields
}Metadata that describes the training and serving parameters of an [Engine][google.cloud.discoveryengine.v1alpha.Engine].
func (*Engine) Descriptor
Deprecated: Use Engine.ProtoReflect.Descriptor instead.
func (*Engine) GetChatEngineConfig
func (x *Engine) GetChatEngineConfig() *Engine_ChatEngineConfigfunc (*Engine) GetChatEngineMetadata
func (x *Engine) GetChatEngineMetadata() *Engine_ChatEngineMetadatafunc (*Engine) GetCommonConfig
func (x *Engine) GetCommonConfig() *Engine_CommonConfigfunc (*Engine) GetCreateTime
func (x *Engine) GetCreateTime() *timestamppb.Timestampfunc (*Engine) GetDataStoreIds
func (*Engine) GetDisplayName
func (*Engine) GetEngineConfig
func (x *Engine) GetEngineConfig() isEngine_EngineConfigfunc (*Engine) GetEngineMetadata
func (x *Engine) GetEngineMetadata() isEngine_EngineMetadatafunc (*Engine) GetIndustryVertical
func (x *Engine) GetIndustryVertical() IndustryVerticalfunc (*Engine) GetMediaRecommendationEngineConfig
func (x *Engine) GetMediaRecommendationEngineConfig() *Engine_MediaRecommendationEngineConfigfunc (*Engine) GetName
func (*Engine) GetRecommendationMetadata
func (x *Engine) GetRecommendationMetadata() *Engine_RecommendationMetadatafunc (*Engine) GetSearchEngineConfig
func (x *Engine) GetSearchEngineConfig() *Engine_SearchEngineConfigfunc (*Engine) GetSimilarDocumentsConfig
func (x *Engine) GetSimilarDocumentsConfig() *Engine_SimilarDocumentsEngineConfigfunc (*Engine) GetSolutionType
func (x *Engine) GetSolutionType() SolutionTypefunc (*Engine) GetUpdateTime
func (x *Engine) GetUpdateTime() *timestamppb.Timestampfunc (*Engine) ProtoMessage
func (*Engine) ProtoMessage()func (*Engine) ProtoReflect
func (x *Engine) ProtoReflect() protoreflect.Messagefunc (*Engine) Reset
func (x *Engine) Reset()func (*Engine) String
EngineServiceClient
type EngineServiceClient interface {
// Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
CreateEngine(ctx context.Context, in *CreateEngineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
DeleteEngine(ctx context.Context, in *DeleteEngineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine]
UpdateEngine(ctx context.Context, in *UpdateEngineRequest, opts ...grpc.CallOption) (*Engine, error)
// Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
GetEngine(ctx context.Context, in *GetEngineRequest, opts ...grpc.CallOption) (*Engine, error)
// Lists all the [Engine][google.cloud.discoveryengine.v1alpha.Engine]s
// associated with the project.
ListEngines(ctx context.Context, in *ListEnginesRequest, opts ...grpc.CallOption) (*ListEnginesResponse, error)
// Pauses the training of an existing engine. Only applicable if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
PauseEngine(ctx context.Context, in *PauseEngineRequest, opts ...grpc.CallOption) (*Engine, error)
// Resumes the training of an existing engine. Only applicable if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
ResumeEngine(ctx context.Context, in *ResumeEngineRequest, opts ...grpc.CallOption) (*Engine, error)
// Tunes an existing engine. Only applicable if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
TuneEngine(ctx context.Context, in *TuneEngineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}EngineServiceClient is the client API for EngineService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewEngineServiceClient
func NewEngineServiceClient(cc grpc.ClientConnInterface) EngineServiceClientEngineServiceServer
type EngineServiceServer interface {
// Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
CreateEngine(context.Context, *CreateEngineRequest) (*longrunningpb.Operation, error)
// Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
DeleteEngine(context.Context, *DeleteEngineRequest) (*longrunningpb.Operation, error)
// Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine]
UpdateEngine(context.Context, *UpdateEngineRequest) (*Engine, error)
// Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
GetEngine(context.Context, *GetEngineRequest) (*Engine, error)
// Lists all the [Engine][google.cloud.discoveryengine.v1alpha.Engine]s
// associated with the project.
ListEngines(context.Context, *ListEnginesRequest) (*ListEnginesResponse, error)
// Pauses the training of an existing engine. Only applicable if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
PauseEngine(context.Context, *PauseEngineRequest) (*Engine, error)
// Resumes the training of an existing engine. Only applicable if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
ResumeEngine(context.Context, *ResumeEngineRequest) (*Engine, error)
// Tunes an existing engine. Only applicable if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
TuneEngine(context.Context, *TuneEngineRequest) (*longrunningpb.Operation, error)
}EngineServiceServer is the server API for EngineService service. All implementations should embed UnimplementedEngineServiceServer for forward compatibility
Engine_ChatEngineConfig
type Engine_ChatEngineConfig struct {
// The configurationt generate the Dialogflow agent that is associated to
// this Engine.
//
// Note that these configurations are one-time consumed by
// and passed to Dialogflow service. It means they cannot be retrieved using
// [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine]
// or
// [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines]
// API after engine creation.
AgentCreationConfig *Engine_ChatEngineConfig_AgentCreationConfig `protobuf:"bytes,1,opt,name=agent_creation_config,json=agentCreationConfig,proto3" json:"agent_creation_config,omitempty"`
// The resource name of an exist Dialogflow agent to link to this Chat
// Engine. Customers can either provide `agent_creation_config` to create
// agent or provide an agent name that links the agent with the Chat engine.
//
// Format: `projects/Configurations for a Chat Engine.
func (*Engine_ChatEngineConfig) Descriptor
func (*Engine_ChatEngineConfig) Descriptor() ([]byte, []int)Deprecated: Use Engine_ChatEngineConfig.ProtoReflect.Descriptor instead.
func (*Engine_ChatEngineConfig) GetAgentCreationConfig
func (x *Engine_ChatEngineConfig) GetAgentCreationConfig() *Engine_ChatEngineConfig_AgentCreationConfigfunc (*Engine_ChatEngineConfig) GetDialogflowAgentToLink
func (x *Engine_ChatEngineConfig) GetDialogflowAgentToLink() stringfunc (*Engine_ChatEngineConfig) ProtoMessage
func (*Engine_ChatEngineConfig) ProtoMessage()func (*Engine_ChatEngineConfig) ProtoReflect
func (x *Engine_ChatEngineConfig) ProtoReflect() protoreflect.Messagefunc (*Engine_ChatEngineConfig) Reset
func (x *Engine_ChatEngineConfig) Reset()func (*Engine_ChatEngineConfig) String
func (x *Engine_ChatEngineConfig) String() stringEngine_ChatEngineConfig_
type Engine_ChatEngineConfig_ struct {
// Configurations for the Chat Engine. Only applicable if
// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
// is
// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
ChatEngineConfig *Engine_ChatEngineConfig `protobuf:"bytes,11,opt,name=chat_engine_config,json=chatEngineConfig,proto3,oneof"`
}Engine_ChatEngineConfig_AgentCreationConfig
type Engine_ChatEngineConfig_AgentCreationConfig struct {
// Name of the company, organization or other entity that the agent
// represents. Used for knowledge connector LLM prompt and for knowledge
// search.
Business string `protobuf:"bytes,1,opt,name=business,proto3" json:"business,omitempty"`
// Required. The default language of the agent as a language tag.
// See [Language
// Support](https://cloud.google.com/dialogflow/docs/reference/language)
// for a list of the currently supported language codes.
DefaultLanguageCode string `protobuf:"bytes,2,opt,name=default_language_code,json=defaultLanguageCode,proto3" json:"default_language_code,omitempty"`
// Required. The time zone of the agent from the [time zone
// database](https://www.iana.org/time-zones), e.g., America/New_York,
// Europe/Paris.
TimeZone string `protobuf:"bytes,3,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
// Agent location for Agent creation, supported values: global/us/eu.
// If not provided, us Engine will create Agent using us-central-1 by
// default; eu Engine will create Agent using eu-west-1 by default.
Location string `protobuf:"bytes,4,opt,name=location,proto3" json:"location,omitempty"`
// contains filtered or unexported fields
}Configurations for generating a Dialogflow agent.
Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] or [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] API after engine creation.
func (*Engine_ChatEngineConfig_AgentCreationConfig) Descriptor
func (*Engine_ChatEngineConfig_AgentCreationConfig) Descriptor() ([]byte, []int)Deprecated: Use Engine_ChatEngineConfig_AgentCreationConfig.ProtoReflect.Descriptor instead.
func (*Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness
func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetBusiness() stringfunc (*Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode
func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetDefaultLanguageCode() stringfunc (*Engine_ChatEngineConfig_AgentCreationConfig) GetLocation
func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetLocation() stringfunc (*Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone
func (x *Engine_ChatEngineConfig_AgentCreationConfig) GetTimeZone() stringfunc (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage
func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoMessage()func (*Engine_ChatEngineConfig_AgentCreationConfig) ProtoReflect
func (x *Engine_ChatEngineConfig_AgentCreationConfig) ProtoReflect() protoreflect.Messagefunc (*Engine_ChatEngineConfig_AgentCreationConfig) Reset
func (x *Engine_ChatEngineConfig_AgentCreationConfig) Reset()func (*Engine_ChatEngineConfig_AgentCreationConfig) String
func (x *Engine_ChatEngineConfig_AgentCreationConfig) String() stringEngine_ChatEngineMetadata
type Engine_ChatEngineMetadata struct {
// The resource name of a Dialogflow agent, that this Chat Engine refers
// to.
//
// Format: `projects/Additional information of a Chat Engine. Fields in this message are output only.
func (*Engine_ChatEngineMetadata) Descriptor
func (*Engine_ChatEngineMetadata) Descriptor() ([]byte, []int)Deprecated: Use Engine_ChatEngineMetadata.ProtoReflect.Descriptor instead.
func (*Engine_ChatEngineMetadata) GetDialogflowAgent
func (x *Engine_ChatEngineMetadata) GetDialogflowAgent() stringfunc (*Engine_ChatEngineMetadata) ProtoMessage
func (*Engine_ChatEngineMetadata) ProtoMessage()func (*Engine_ChatEngineMetadata) ProtoReflect
func (x *Engine_ChatEngineMetadata) ProtoReflect() protoreflect.Messagefunc (*Engine_ChatEngineMetadata) Reset
func (x *Engine_ChatEngineMetadata) Reset()func (*Engine_ChatEngineMetadata) String
func (x *Engine_ChatEngineMetadata) String() stringEngine_ChatEngineMetadata_
type Engine_ChatEngineMetadata_ struct {
// Output only. Additional information of the Chat Engine. Only applicable
// if
// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
// is
// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
ChatEngineMetadata *Engine_ChatEngineMetadata `protobuf:"bytes,12,opt,name=chat_engine_metadata,json=chatEngineMetadata,proto3,oneof"`
}Engine_CommonConfig
type Engine_CommonConfig struct {
// The name of the company, business or entity that is associated with the
// engine. Setting this may help improve LLM related features.
CompanyName string `protobuf:"bytes,1,opt,name=company_name,json=companyName,proto3" json:"company_name,omitempty"`
// contains filtered or unexported fields
}Common configurations for an Engine.
func (*Engine_CommonConfig) Descriptor
func (*Engine_CommonConfig) Descriptor() ([]byte, []int)Deprecated: Use Engine_CommonConfig.ProtoReflect.Descriptor instead.
func (*Engine_CommonConfig) GetCompanyName
func (x *Engine_CommonConfig) GetCompanyName() stringfunc (*Engine_CommonConfig) ProtoMessage
func (*Engine_CommonConfig) ProtoMessage()func (*Engine_CommonConfig) ProtoReflect
func (x *Engine_CommonConfig) ProtoReflect() protoreflect.Messagefunc (*Engine_CommonConfig) Reset
func (x *Engine_CommonConfig) Reset()func (*Engine_CommonConfig) String
func (x *Engine_CommonConfig) String() stringEngine_MediaRecommendationEngineConfig
type Engine_MediaRecommendationEngineConfig struct {
// Required. The type of engine. e.g., `recommended-for-you`.
//
// This field together with
// [optimization_objective][Engine.optimization_objective] describe engine
// metadata to use to control engine training and serving.
//
// Currently supported values: `recommended-for-you`, `others-you-may-like`,
// `more-like-this`, `most-popular-items`.
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
// The optimization objective. e.g., `cvr`.
//
// This field together with
// [optimization_objective][google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.type]
// describe engine metadata to use to control engine training and serving.
//
// Currently supported
// values: `ctr`, `cvr`.
//
// If not specified, we choose default based on engine type.
//
// Default depends on type of recommendation:
//
// `recommended-for-you` => `ctr`
//
// `others-you-may-like` => `ctr`
OptimizationObjective string `protobuf:"bytes,2,opt,name=optimization_objective,json=optimizationObjective,proto3" json:"optimization_objective,omitempty"`
// Name and value of the custom threshold for cvr optimization_objective.
// For target_field `watch-time`, target_field_value must be an integer
// value indicating the media progress time in seconds between (0, 86400]
// (excludes 0, includes 86400) (e.g., 90).
// For target_field `watch-percentage`, the target_field_value must be a
// valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
// 0.5).
OptimizationObjectiveConfig *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig `protobuf:"bytes,3,opt,name=optimization_objective_config,json=optimizationObjectiveConfig,proto3" json:"optimization_objective_config,omitempty"`
// The training state that the engine is in (e.g.
// `TRAINING` or `PAUSED`).
//
// Since part of the cost of running the service
// is frequency of training - this can be used to determine when to train
// engine in order to control cost. If not specified: the default value for
// `CreateEngine` method is `TRAINING`. The default value for
// `UpdateEngine` method is to keep the state the same as before.
TrainingState Engine_MediaRecommendationEngineConfig_TrainingState `protobuf:"varint,4,opt,name=training_state,json=trainingState,proto3,enum=google.cloud.discoveryengine.v1alpha.Engine_MediaRecommendationEngineConfig_TrainingState" json:"training_state,omitempty"`
// contains filtered or unexported fields
}Additional config specs for a Media Recommendation engine.
func (*Engine_MediaRecommendationEngineConfig) Descriptor
func (*Engine_MediaRecommendationEngineConfig) Descriptor() ([]byte, []int)Deprecated: Use Engine_MediaRecommendationEngineConfig.ProtoReflect.Descriptor instead.
func (*Engine_MediaRecommendationEngineConfig) GetOptimizationObjective
func (x *Engine_MediaRecommendationEngineConfig) GetOptimizationObjective() stringfunc (*Engine_MediaRecommendationEngineConfig) GetOptimizationObjectiveConfig
func (x *Engine_MediaRecommendationEngineConfig) GetOptimizationObjectiveConfig() *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfigfunc (*Engine_MediaRecommendationEngineConfig) GetTrainingState
func (x *Engine_MediaRecommendationEngineConfig) GetTrainingState() Engine_MediaRecommendationEngineConfig_TrainingStatefunc (*Engine_MediaRecommendationEngineConfig) GetType
func (x *Engine_MediaRecommendationEngineConfig) GetType() stringfunc (*Engine_MediaRecommendationEngineConfig) ProtoMessage
func (*Engine_MediaRecommendationEngineConfig) ProtoMessage()func (*Engine_MediaRecommendationEngineConfig) ProtoReflect
func (x *Engine_MediaRecommendationEngineConfig) ProtoReflect() protoreflect.Messagefunc (*Engine_MediaRecommendationEngineConfig) Reset
func (x *Engine_MediaRecommendationEngineConfig) Reset()func (*Engine_MediaRecommendationEngineConfig) String
func (x *Engine_MediaRecommendationEngineConfig) String() stringEngine_MediaRecommendationEngineConfig_
type Engine_MediaRecommendationEngineConfig_ struct {
// Configurations for the Media Engine. Only applicable on the data
// stores with
// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
// and
// [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA]
// vertical.
MediaRecommendationEngineConfig *Engine_MediaRecommendationEngineConfig `protobuf:"bytes,14,opt,name=media_recommendation_engine_config,json=mediaRecommendationEngineConfig,proto3,oneof"`
}Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig
type Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig struct {
// Required. The name of the field to target. Currently supported
// values: `watch-percentage`, `watch-time`.
TargetField string `protobuf:"bytes,1,opt,name=target_field,json=targetField,proto3" json:"target_field,omitempty"`
// Required. The threshold to be applied to the target (e.g., 0.5).
TargetFieldValueFloat float32 `protobuf:"fixed32,2,opt,name=target_field_value_float,json=targetFieldValueFloat,proto3" json:"target_field_value_float,omitempty"`
// contains filtered or unexported fields
}Custom threshold for cvr optimization_objective.
func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Descriptor
func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Descriptor() ([]byte, []int)Deprecated: Use Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig.ProtoReflect.Descriptor instead.
func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetField
func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetField() stringfunc (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetFieldValueFloat
func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) GetTargetFieldValueFloat() float32func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoMessage
func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoMessage()func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoReflect
func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) ProtoReflect() protoreflect.Messagefunc (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Reset
func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) Reset()func (*Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) String
func (x *Engine_MediaRecommendationEngineConfig_OptimizationObjectiveConfig) String() stringEngine_MediaRecommendationEngineConfig_TrainingState
type Engine_MediaRecommendationEngineConfig_TrainingState int32The training state of the engine.
Engine_MediaRecommendationEngineConfig_TRAINING_STATE_UNSPECIFIED, Engine_MediaRecommendationEngineConfig_PAUSED, Engine_MediaRecommendationEngineConfig_TRAINING
const (
// Unspecified training state.
Engine_MediaRecommendationEngineConfig_TRAINING_STATE_UNSPECIFIED Engine_MediaRecommendationEngineConfig_TrainingState = 0
// The engine training is paused.
Engine_MediaRecommendationEngineConfig_PAUSED Engine_MediaRecommendationEngineConfig_TrainingState = 1
// The engine is training.
Engine_MediaRecommendationEngineConfig_TRAINING Engine_MediaRecommendationEngineConfig_TrainingState = 2
)func (Engine_MediaRecommendationEngineConfig_TrainingState) Descriptor
func (Engine_MediaRecommendationEngineConfig_TrainingState) Descriptor() protoreflect.EnumDescriptorfunc (Engine_MediaRecommendationEngineConfig_TrainingState) Enum
func (x Engine_MediaRecommendationEngineConfig_TrainingState) Enum() *Engine_MediaRecommendationEngineConfig_TrainingStatefunc (Engine_MediaRecommendationEngineConfig_TrainingState) EnumDescriptor
func (Engine_MediaRecommendationEngineConfig_TrainingState) EnumDescriptor() ([]byte, []int)Deprecated: Use Engine_MediaRecommendationEngineConfig_TrainingState.Descriptor instead.
func (Engine_MediaRecommendationEngineConfig_TrainingState) Number
func (x Engine_MediaRecommendationEngineConfig_TrainingState) Number() protoreflect.EnumNumberfunc (Engine_MediaRecommendationEngineConfig_TrainingState) String
func (x Engine_MediaRecommendationEngineConfig_TrainingState) String() stringfunc (Engine_MediaRecommendationEngineConfig_TrainingState) Type
Engine_RecommendationMetadata
type Engine_RecommendationMetadata struct {
// Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.
ServingState Engine_RecommendationMetadata_ServingState `protobuf:"varint,1,opt,name=serving_state,json=servingState,proto3,enum=google.cloud.discoveryengine.v1alpha.Engine_RecommendationMetadata_ServingState" json:"serving_state,omitempty"`
// Output only. The state of data requirements for this engine: `DATA_OK`
// and `DATA_ERROR`.
//
// Engine cannot be trained if the data is in
// `DATA_ERROR` state. Engine can have `DATA_ERROR` state even
// if serving state is `ACTIVE`: engines were trained successfully before,
// but cannot be refreshed because the underlying engine no longer has
// sufficient data for training.
DataState Engine_RecommendationMetadata_DataState `protobuf:"varint,2,opt,name=data_state,json=dataState,proto3,enum=google.cloud.discoveryengine.v1alpha.Engine_RecommendationMetadata_DataState" json:"data_state,omitempty"`
// Output only. The timestamp when the latest successful tune finished. Only
// applicable on Media Recommendation engines.
LastTuneTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=last_tune_time,json=lastTuneTime,proto3" json:"last_tune_time,omitempty"`
// Output only. The latest tune operation id associated with the engine.
// Only applicable on Media Recommendation engines.
//
// If present, this operation id can be used to determine if there is an
// ongoing tune for this engine. To check the operation status, send the
// GetOperation request with this operation id in the engine resource
// format. If no tuning has happened for this engine, the string is empty.
TuningOperation string `protobuf:"bytes,4,opt,name=tuning_operation,json=tuningOperation,proto3" json:"tuning_operation,omitempty"`
// contains filtered or unexported fields
}Additional information of a recommendation engine.
func (*Engine_RecommendationMetadata) Descriptor
func (*Engine_RecommendationMetadata) Descriptor() ([]byte, []int)Deprecated: Use Engine_RecommendationMetadata.ProtoReflect.Descriptor instead.
func (*Engine_RecommendationMetadata) GetDataState
func (x *Engine_RecommendationMetadata) GetDataState() Engine_RecommendationMetadata_DataStatefunc (*Engine_RecommendationMetadata) GetLastTuneTime
func (x *Engine_RecommendationMetadata) GetLastTuneTime() *timestamppb.Timestampfunc (*Engine_RecommendationMetadata) GetServingState
func (x *Engine_RecommendationMetadata) GetServingState() Engine_RecommendationMetadata_ServingStatefunc (*Engine_RecommendationMetadata) GetTuningOperation
func (x *Engine_RecommendationMetadata) GetTuningOperation() stringfunc (*Engine_RecommendationMetadata) ProtoMessage
func (*Engine_RecommendationMetadata) ProtoMessage()func (*Engine_RecommendationMetadata) ProtoReflect
func (x *Engine_RecommendationMetadata) ProtoReflect() protoreflect.Messagefunc (*Engine_RecommendationMetadata) Reset
func (x *Engine_RecommendationMetadata) Reset()func (*Engine_RecommendationMetadata) String
func (x *Engine_RecommendationMetadata) String() stringEngine_RecommendationMetadata_
type Engine_RecommendationMetadata_ struct {
// Output only. Additional information of a recommendation engine. Only
// applicable if
// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
// is
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
RecommendationMetadata *Engine_RecommendationMetadata `protobuf:"bytes,10,opt,name=recommendation_metadata,json=recommendationMetadata,proto3,oneof"`
}Engine_RecommendationMetadata_DataState
type Engine_RecommendationMetadata_DataState int32Describes whether this engine have sufficient training data to be continuously trained.
Engine_RecommendationMetadata_DATA_STATE_UNSPECIFIED, Engine_RecommendationMetadata_DATA_OK, Engine_RecommendationMetadata_DATA_ERROR
const (
// Unspecified default value, should never be explicitly set.
Engine_RecommendationMetadata_DATA_STATE_UNSPECIFIED Engine_RecommendationMetadata_DataState = 0
// The engine has sufficient training data.
Engine_RecommendationMetadata_DATA_OK Engine_RecommendationMetadata_DataState = 1
// The engine does not have sufficient training data. Error
// messages can be queried via Stackdriver.
Engine_RecommendationMetadata_DATA_ERROR Engine_RecommendationMetadata_DataState = 2
)func (Engine_RecommendationMetadata_DataState) Descriptor
func (Engine_RecommendationMetadata_DataState) Descriptor() protoreflect.EnumDescriptorfunc (Engine_RecommendationMetadata_DataState) Enum
func (Engine_RecommendationMetadata_DataState) EnumDescriptor
func (Engine_RecommendationMetadata_DataState) EnumDescriptor() ([]byte, []int)Deprecated: Use Engine_RecommendationMetadata_DataState.Descriptor instead.
func (Engine_RecommendationMetadata_DataState) Number
func (x Engine_RecommendationMetadata_DataState) Number() protoreflect.EnumNumberfunc (Engine_RecommendationMetadata_DataState) String
func (x Engine_RecommendationMetadata_DataState) String() stringfunc (Engine_RecommendationMetadata_DataState) Type
func (Engine_RecommendationMetadata_DataState) Type() protoreflect.EnumTypeEngine_RecommendationMetadata_ServingState
type Engine_RecommendationMetadata_ServingState int32The serving state of the recommendation engine.
Engine_RecommendationMetadata_SERVING_STATE_UNSPECIFIED, Engine_RecommendationMetadata_INACTIVE, Engine_RecommendationMetadata_ACTIVE, Engine_RecommendationMetadata_TUNED
const (
// Unspecified serving state.
Engine_RecommendationMetadata_SERVING_STATE_UNSPECIFIED Engine_RecommendationMetadata_ServingState = 0
// The engine is not serving.
Engine_RecommendationMetadata_INACTIVE Engine_RecommendationMetadata_ServingState = 1
// The engine is serving and can be queried.
Engine_RecommendationMetadata_ACTIVE Engine_RecommendationMetadata_ServingState = 2
// The engine is trained on tuned hyperparameters and can be
// queried.
Engine_RecommendationMetadata_TUNED Engine_RecommendationMetadata_ServingState = 3
)func (Engine_RecommendationMetadata_ServingState) Descriptor
func (Engine_RecommendationMetadata_ServingState) Descriptor() protoreflect.EnumDescriptorfunc (Engine_RecommendationMetadata_ServingState) Enum
func (x Engine_RecommendationMetadata_ServingState) Enum() *Engine_RecommendationMetadata_ServingStatefunc (Engine_RecommendationMetadata_ServingState) EnumDescriptor
func (Engine_RecommendationMetadata_ServingState) EnumDescriptor() ([]byte, []int)Deprecated: Use Engine_RecommendationMetadata_ServingState.Descriptor instead.
func (Engine_RecommendationMetadata_ServingState) Number
func (x Engine_RecommendationMetadata_ServingState) Number() protoreflect.EnumNumberfunc (Engine_RecommendationMetadata_ServingState) String
func (x Engine_RecommendationMetadata_ServingState) String() stringfunc (Engine_RecommendationMetadata_ServingState) Type
func (Engine_RecommendationMetadata_ServingState) Type() protoreflect.EnumTypeEngine_SearchEngineConfig
type Engine_SearchEngineConfig struct {
// The search feature tier of this engine.
//
// Different tiers might have different
// pricing. To learn more, check the pricing documentation.
//
// Defaults to
// [SearchTier.SEARCH_TIER_STANDARD][google.cloud.discoveryengine.v1alpha.SearchTier.SEARCH_TIER_STANDARD]
// if not specified.
SearchTier SearchTier `protobuf:"varint,1,opt,name=search_tier,json=searchTier,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchTier" json:"search_tier,omitempty"`
// The add-on that this search engine enables.
SearchAddOns []SearchAddOn `protobuf:"varint,2,rep,packed,name=search_add_ons,json=searchAddOns,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchAddOn" json:"search_add_ons,omitempty"`
// contains filtered or unexported fields
}Configurations for a Search Engine.
func (*Engine_SearchEngineConfig) Descriptor
func (*Engine_SearchEngineConfig) Descriptor() ([]byte, []int)Deprecated: Use Engine_SearchEngineConfig.ProtoReflect.Descriptor instead.
func (*Engine_SearchEngineConfig) GetSearchAddOns
func (x *Engine_SearchEngineConfig) GetSearchAddOns() []SearchAddOnfunc (*Engine_SearchEngineConfig) GetSearchTier
func (x *Engine_SearchEngineConfig) GetSearchTier() SearchTierfunc (*Engine_SearchEngineConfig) ProtoMessage
func (*Engine_SearchEngineConfig) ProtoMessage()func (*Engine_SearchEngineConfig) ProtoReflect
func (x *Engine_SearchEngineConfig) ProtoReflect() protoreflect.Messagefunc (*Engine_SearchEngineConfig) Reset
func (x *Engine_SearchEngineConfig) Reset()func (*Engine_SearchEngineConfig) String
func (x *Engine_SearchEngineConfig) String() stringEngine_SearchEngineConfig_
type Engine_SearchEngineConfig_ struct {
// Configurations for the Search Engine. Only applicable if
// [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
// is
// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
SearchEngineConfig *Engine_SearchEngineConfig `protobuf:"bytes,13,opt,name=search_engine_config,json=searchEngineConfig,proto3,oneof"`
}Engine_SimilarDocumentsConfig
type Engine_SimilarDocumentsConfig struct {
// Additional config specs for a `similar-items` engine.
SimilarDocumentsConfig *Engine_SimilarDocumentsEngineConfig `protobuf:"bytes,9,opt,name=similar_documents_config,json=similarDocumentsConfig,proto3,oneof"`
}Engine_SimilarDocumentsEngineConfig
type Engine_SimilarDocumentsEngineConfig struct {
// contains filtered or unexported fields
}Additional config specs for a similar-items engine.
func (*Engine_SimilarDocumentsEngineConfig) Descriptor
func (*Engine_SimilarDocumentsEngineConfig) Descriptor() ([]byte, []int)Deprecated: Use Engine_SimilarDocumentsEngineConfig.ProtoReflect.Descriptor instead.
func (*Engine_SimilarDocumentsEngineConfig) ProtoMessage
func (*Engine_SimilarDocumentsEngineConfig) ProtoMessage()func (*Engine_SimilarDocumentsEngineConfig) ProtoReflect
func (x *Engine_SimilarDocumentsEngineConfig) ProtoReflect() protoreflect.Messagefunc (*Engine_SimilarDocumentsEngineConfig) Reset
func (x *Engine_SimilarDocumentsEngineConfig) Reset()func (*Engine_SimilarDocumentsEngineConfig) String
func (x *Engine_SimilarDocumentsEngineConfig) String() stringEstimateBillingServiceClient
type EstimateBillingServiceClient interface {
// Estimates the data size to be used by a customer.
EstimateDataSize(ctx context.Context, in *EstimateDataSizeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}EstimateBillingServiceClient is the client API for EstimateBillingService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewEstimateBillingServiceClient
func NewEstimateBillingServiceClient(cc grpc.ClientConnInterface) EstimateBillingServiceClientEstimateBillingServiceServer
type EstimateBillingServiceServer interface {
// Estimates the data size to be used by a customer.
EstimateDataSize(context.Context, *EstimateDataSizeRequest) (*longrunningpb.Operation, error)
}EstimateBillingServiceServer is the server API for EstimateBillingService service. All implementations should embed UnimplementedEstimateBillingServiceServer for forward compatibility
EstimateDataSizeMetadata
type EstimateDataSizeMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.
func (*EstimateDataSizeMetadata) Descriptor
func (*EstimateDataSizeMetadata) Descriptor() ([]byte, []int)Deprecated: Use EstimateDataSizeMetadata.ProtoReflect.Descriptor instead.
func (*EstimateDataSizeMetadata) GetCreateTime
func (x *EstimateDataSizeMetadata) GetCreateTime() *timestamppb.Timestampfunc (*EstimateDataSizeMetadata) ProtoMessage
func (*EstimateDataSizeMetadata) ProtoMessage()func (*EstimateDataSizeMetadata) ProtoReflect
func (x *EstimateDataSizeMetadata) ProtoReflect() protoreflect.Messagefunc (*EstimateDataSizeMetadata) Reset
func (x *EstimateDataSizeMetadata) Reset()func (*EstimateDataSizeMetadata) String
func (x *EstimateDataSizeMetadata) String() stringEstimateDataSizeRequest
type EstimateDataSizeRequest struct {
// Data source for which we are estimating its size.
//
// Types that are valid to be assigned to DataSource:
//
// *EstimateDataSizeRequest_WebsiteDataSource_
// *EstimateDataSizeRequest_FileDataSource_
DataSource isEstimateDataSizeRequest_DataSource `protobuf_oneof:"data_source"`
// Required. Full resource name of the location, such as
// `projects/{project}/locations/{location}`.
Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
// contains filtered or unexported fields
}Request message for [EstimateBillingService.EstimateDataSize][google.cloud.discoveryengine.v1alpha.EstimateBillingService.EstimateDataSize] method
func (*EstimateDataSizeRequest) Descriptor
func (*EstimateDataSizeRequest) Descriptor() ([]byte, []int)Deprecated: Use EstimateDataSizeRequest.ProtoReflect.Descriptor instead.
func (*EstimateDataSizeRequest) GetDataSource
func (x *EstimateDataSizeRequest) GetDataSource() isEstimateDataSizeRequest_DataSourcefunc (*EstimateDataSizeRequest) GetFileDataSource
func (x *EstimateDataSizeRequest) GetFileDataSource() *EstimateDataSizeRequest_FileDataSourcefunc (*EstimateDataSizeRequest) GetLocation
func (x *EstimateDataSizeRequest) GetLocation() stringfunc (*EstimateDataSizeRequest) GetWebsiteDataSource
func (x *EstimateDataSizeRequest) GetWebsiteDataSource() *EstimateDataSizeRequest_WebsiteDataSourcefunc (*EstimateDataSizeRequest) ProtoMessage
func (*EstimateDataSizeRequest) ProtoMessage()func (*EstimateDataSizeRequest) ProtoReflect
func (x *EstimateDataSizeRequest) ProtoReflect() protoreflect.Messagefunc (*EstimateDataSizeRequest) Reset
func (x *EstimateDataSizeRequest) Reset()func (*EstimateDataSizeRequest) String
func (x *EstimateDataSizeRequest) String() stringEstimateDataSizeRequest_FileDataSource
type EstimateDataSizeRequest_FileDataSource struct {
// Which source contains the files to be used.
//
// Types that are valid to be assigned to Source:
//
// *EstimateDataSizeRequest_FileDataSource_GcsSource
// *EstimateDataSizeRequest_FileDataSource_BigquerySource
Source isEstimateDataSizeRequest_FileDataSource_Source `protobuf_oneof:"source"`
// contains filtered or unexported fields
}Data source contains files either in Cloud Storage or BigQuery.
func (*EstimateDataSizeRequest_FileDataSource) Descriptor
func (*EstimateDataSizeRequest_FileDataSource) Descriptor() ([]byte, []int)Deprecated: Use EstimateDataSizeRequest_FileDataSource.ProtoReflect.Descriptor instead.
func (*EstimateDataSizeRequest_FileDataSource) GetBigquerySource
func (x *EstimateDataSizeRequest_FileDataSource) GetBigquerySource() *BigQuerySourcefunc (*EstimateDataSizeRequest_FileDataSource) GetGcsSource
func (x *EstimateDataSizeRequest_FileDataSource) GetGcsSource() *GcsSourcefunc (*EstimateDataSizeRequest_FileDataSource) GetSource
func (x *EstimateDataSizeRequest_FileDataSource) GetSource() isEstimateDataSizeRequest_FileDataSource_Sourcefunc (*EstimateDataSizeRequest_FileDataSource) ProtoMessage
func (*EstimateDataSizeRequest_FileDataSource) ProtoMessage()func (*EstimateDataSizeRequest_FileDataSource) ProtoReflect
func (x *EstimateDataSizeRequest_FileDataSource) ProtoReflect() protoreflect.Messagefunc (*EstimateDataSizeRequest_FileDataSource) Reset
func (x *EstimateDataSizeRequest_FileDataSource) Reset()func (*EstimateDataSizeRequest_FileDataSource) String
func (x *EstimateDataSizeRequest_FileDataSource) String() stringEstimateDataSizeRequest_FileDataSource_
type EstimateDataSizeRequest_FileDataSource_ struct {
// Structured or unstructured data.
FileDataSource *EstimateDataSizeRequest_FileDataSource `protobuf:"bytes,3,opt,name=file_data_source,json=fileDataSource,proto3,oneof"`
}EstimateDataSizeRequest_FileDataSource_BigquerySource
type EstimateDataSizeRequest_FileDataSource_BigquerySource struct {
// BigQuery input source.
BigquerySource *BigQuerySource `protobuf:"bytes,2,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}EstimateDataSizeRequest_FileDataSource_GcsSource
type EstimateDataSizeRequest_FileDataSource_GcsSource struct {
// Cloud Storage location for the input content.
GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}EstimateDataSizeRequest_WebsiteDataSource
type EstimateDataSizeRequest_WebsiteDataSource struct {
// Required. The URI patterns to estimate the data sizes. At most 10
// patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.
EstimatorUriPatterns []*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern `protobuf:"bytes,1,rep,name=estimator_uri_patterns,json=estimatorUriPatterns,proto3" json:"estimator_uri_patterns,omitempty"`
// contains filtered or unexported fields
}Data source is a set of website patterns that we crawl to get the total number of websites.
func (*EstimateDataSizeRequest_WebsiteDataSource) Descriptor
func (*EstimateDataSizeRequest_WebsiteDataSource) Descriptor() ([]byte, []int)Deprecated: Use EstimateDataSizeRequest_WebsiteDataSource.ProtoReflect.Descriptor instead.
func (*EstimateDataSizeRequest_WebsiteDataSource) GetEstimatorUriPatterns
func (x *EstimateDataSizeRequest_WebsiteDataSource) GetEstimatorUriPatterns() []*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPatternfunc (*EstimateDataSizeRequest_WebsiteDataSource) ProtoMessage
func (*EstimateDataSizeRequest_WebsiteDataSource) ProtoMessage()func (*EstimateDataSizeRequest_WebsiteDataSource) ProtoReflect
func (x *EstimateDataSizeRequest_WebsiteDataSource) ProtoReflect() protoreflect.Messagefunc (*EstimateDataSizeRequest_WebsiteDataSource) Reset
func (x *EstimateDataSizeRequest_WebsiteDataSource) Reset()func (*EstimateDataSizeRequest_WebsiteDataSource) String
func (x *EstimateDataSizeRequest_WebsiteDataSource) String() stringEstimateDataSizeRequest_WebsiteDataSource_
type EstimateDataSizeRequest_WebsiteDataSource_ struct {
// Website data.
WebsiteDataSource *EstimateDataSizeRequest_WebsiteDataSource `protobuf:"bytes,2,opt,name=website_data_source,json=websiteDataSource,proto3,oneof"`
}EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern
type EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern struct {
// User provided URI pattern. For example, `foo.com/bar/*`.
ProvidedUriPattern string `protobuf:"bytes,1,opt,name=provided_uri_pattern,json=providedUriPattern,proto3" json:"provided_uri_pattern,omitempty"`
// Whether we infer the generated URI or use the exact provided one.
ExactMatch bool `protobuf:"varint,2,opt,name=exact_match,json=exactMatch,proto3" json:"exact_match,omitempty"`
// Whether the pattern is exclusive or not. If set to true, the pattern is
// considered exclusive. If unset or set to false, the pattern is
// considered inclusive by default.
Exclusive bool `protobuf:"varint,3,opt,name=exclusive,proto3" json:"exclusive,omitempty"`
// contains filtered or unexported fields
}URI patterns that we use to crawl.
func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) Descriptor
func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) Descriptor() ([]byte, []int)Deprecated: Use EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern.ProtoReflect.Descriptor instead.
func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetExactMatch
func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetExactMatch() boolfunc (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetExclusive
func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetExclusive() boolfunc (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetProvidedUriPattern
func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) GetProvidedUriPattern() stringfunc (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) ProtoMessage
func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) ProtoMessage()func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) ProtoReflect
func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) ProtoReflect() protoreflect.Messagefunc (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) Reset
func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) Reset()func (*EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) String
func (x *EstimateDataSizeRequest_WebsiteDataSource_EstimatorUriPattern) String() stringEstimateDataSizeResponse
type EstimateDataSizeResponse struct {
// Data size in terms of bytes.
DataSizeBytes int64 `protobuf:"varint,1,opt,name=data_size_bytes,json=dataSizeBytes,proto3" json:"data_size_bytes,omitempty"`
// Total number of documents.
DocumentCount int64 `protobuf:"varint,2,opt,name=document_count,json=documentCount,proto3" json:"document_count,omitempty"`
// contains filtered or unexported fields
}Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
func (*EstimateDataSizeResponse) Descriptor
func (*EstimateDataSizeResponse) Descriptor() ([]byte, []int)Deprecated: Use EstimateDataSizeResponse.ProtoReflect.Descriptor instead.
func (*EstimateDataSizeResponse) GetDataSizeBytes
func (x *EstimateDataSizeResponse) GetDataSizeBytes() int64func (*EstimateDataSizeResponse) GetDocumentCount
func (x *EstimateDataSizeResponse) GetDocumentCount() int64func (*EstimateDataSizeResponse) ProtoMessage
func (*EstimateDataSizeResponse) ProtoMessage()func (*EstimateDataSizeResponse) ProtoReflect
func (x *EstimateDataSizeResponse) ProtoReflect() protoreflect.Messagefunc (*EstimateDataSizeResponse) Reset
func (x *EstimateDataSizeResponse) Reset()func (*EstimateDataSizeResponse) String
func (x *EstimateDataSizeResponse) String() stringEvaluation
type Evaluation struct {
// Identifier. The full resource name of the
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], in the
// format of
// `projects/{project}/locations/{location}/evaluations/{evaluation}`.
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The specification of the evaluation.
EvaluationSpec *Evaluation_EvaluationSpec `protobuf:"bytes,2,opt,name=evaluation_spec,json=evaluationSpec,proto3" json:"evaluation_spec,omitempty"`
// Output only. The metrics produced by the evaluation, averaged across all
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s in the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
//
// Only populated when the evaluation's state is SUCCEEDED.
QualityMetrics *QualityMetrics `protobuf:"bytes,3,opt,name=quality_metrics,json=qualityMetrics,proto3" json:"quality_metrics,omitempty"`
// Output only. The state of the evaluation.
State Evaluation_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1alpha.Evaluation_State" json:"state,omitempty"`
// Output only. The error that occurred during evaluation. Only populated when
// the evaluation's state is FAILED.
Error *status.Status `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
// Output only. Timestamp the
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] was created
// at.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp the
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] was completed
// at.
EndTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Output only. A sample of errors encountered while processing the request.
ErrorSamples []*status.Status `protobuf:"bytes,8,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// contains filtered or unexported fields
}An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
func (*Evaluation) Descriptor
func (*Evaluation) Descriptor() ([]byte, []int)Deprecated: Use Evaluation.ProtoReflect.Descriptor instead.
func (*Evaluation) GetCreateTime
func (x *Evaluation) GetCreateTime() *timestamppb.Timestampfunc (*Evaluation) GetEndTime
func (x *Evaluation) GetEndTime() *timestamppb.Timestampfunc (*Evaluation) GetError
func (x *Evaluation) GetError() *status.Statusfunc (*Evaluation) GetErrorSamples
func (x *Evaluation) GetErrorSamples() []*status.Statusfunc (*Evaluation) GetEvaluationSpec
func (x *Evaluation) GetEvaluationSpec() *Evaluation_EvaluationSpecfunc (*Evaluation) GetName
func (x *Evaluation) GetName() stringfunc (*Evaluation) GetQualityMetrics
func (x *Evaluation) GetQualityMetrics() *QualityMetricsfunc (*Evaluation) GetState
func (x *Evaluation) GetState() Evaluation_Statefunc (*Evaluation) ProtoMessage
func (*Evaluation) ProtoMessage()func (*Evaluation) ProtoReflect
func (x *Evaluation) ProtoReflect() protoreflect.Messagefunc (*Evaluation) Reset
func (x *Evaluation) Reset()func (*Evaluation) String
func (x *Evaluation) String() stringEvaluationServiceClient
type EvaluationServiceClient interface {
// Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
GetEvaluation(ctx context.Context, in *GetEvaluationRequest, opts ...grpc.CallOption) (*Evaluation, error)
// Gets a list of
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
ListEvaluations(ctx context.Context, in *ListEvaluationsRequest, opts ...grpc.CallOption) (*ListEvaluationsResponse, error)
// Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
//
// Upon creation, the evaluation will be automatically triggered and begin
// execution.
CreateEvaluation(ctx context.Context, in *CreateEvaluationRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets a list of results for a given a
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
ListEvaluationResults(ctx context.Context, in *ListEvaluationResultsRequest, opts ...grpc.CallOption) (*ListEvaluationResultsResponse, error)
}EvaluationServiceClient is the client API for EvaluationService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewEvaluationServiceClient
func NewEvaluationServiceClient(cc grpc.ClientConnInterface) EvaluationServiceClientEvaluationServiceServer
type EvaluationServiceServer interface {
// Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
GetEvaluation(context.Context, *GetEvaluationRequest) (*Evaluation, error)
// Gets a list of
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
ListEvaluations(context.Context, *ListEvaluationsRequest) (*ListEvaluationsResponse, error)
// Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
//
// Upon creation, the evaluation will be automatically triggered and begin
// execution.
CreateEvaluation(context.Context, *CreateEvaluationRequest) (*longrunningpb.Operation, error)
// Gets a list of results for a given a
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
ListEvaluationResults(context.Context, *ListEvaluationResultsRequest) (*ListEvaluationResultsResponse, error)
}EvaluationServiceServer is the server API for EvaluationService service. All implementations should embed UnimplementedEvaluationServiceServer for forward compatibility
Evaluation_EvaluationSpec
type Evaluation_EvaluationSpec struct {
// The search specification.
//
// Types that are valid to be assigned to SearchSpec:
//
// *Evaluation_EvaluationSpec_SearchRequest
SearchSpec isEvaluation_EvaluationSpec_SearchSpec `protobuf_oneof:"search_spec"`
// Required. The specification of the query set.
QuerySetSpec *Evaluation_EvaluationSpec_QuerySetSpec `protobuf:"bytes,1,opt,name=query_set_spec,json=querySetSpec,proto3" json:"query_set_spec,omitempty"`
// contains filtered or unexported fields
}Describes the specification of the evaluation.
func (*Evaluation_EvaluationSpec) Descriptor
func (*Evaluation_EvaluationSpec) Descriptor() ([]byte, []int)Deprecated: Use Evaluation_EvaluationSpec.ProtoReflect.Descriptor instead.
func (*Evaluation_EvaluationSpec) GetQuerySetSpec
func (x *Evaluation_EvaluationSpec) GetQuerySetSpec() *Evaluation_EvaluationSpec_QuerySetSpecfunc (*Evaluation_EvaluationSpec) GetSearchRequest
func (x *Evaluation_EvaluationSpec) GetSearchRequest() *SearchRequestfunc (*Evaluation_EvaluationSpec) GetSearchSpec
func (x *Evaluation_EvaluationSpec) GetSearchSpec() isEvaluation_EvaluationSpec_SearchSpecfunc (*Evaluation_EvaluationSpec) ProtoMessage
func (*Evaluation_EvaluationSpec) ProtoMessage()func (*Evaluation_EvaluationSpec) ProtoReflect
func (x *Evaluation_EvaluationSpec) ProtoReflect() protoreflect.Messagefunc (*Evaluation_EvaluationSpec) Reset
func (x *Evaluation_EvaluationSpec) Reset()func (*Evaluation_EvaluationSpec) String
func (x *Evaluation_EvaluationSpec) String() stringEvaluation_EvaluationSpec_QuerySetSpec
type Evaluation_EvaluationSpec_QuerySetSpec struct {
// Required. The full resource name of the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]
// used for the evaluation, in the format of
// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
SampleQuerySet string `protobuf:"bytes,1,opt,name=sample_query_set,json=sampleQuerySet,proto3" json:"sample_query_set,omitempty"`
// contains filtered or unexported fields
}Describes the specification of the query set.
func (*Evaluation_EvaluationSpec_QuerySetSpec) Descriptor
func (*Evaluation_EvaluationSpec_QuerySetSpec) Descriptor() ([]byte, []int)Deprecated: Use Evaluation_EvaluationSpec_QuerySetSpec.ProtoReflect.Descriptor instead.
func (*Evaluation_EvaluationSpec_QuerySetSpec) GetSampleQuerySet
func (x *Evaluation_EvaluationSpec_QuerySetSpec) GetSampleQuerySet() stringfunc (*Evaluation_EvaluationSpec_QuerySetSpec) ProtoMessage
func (*Evaluation_EvaluationSpec_QuerySetSpec) ProtoMessage()func (*Evaluation_EvaluationSpec_QuerySetSpec) ProtoReflect
func (x *Evaluation_EvaluationSpec_QuerySetSpec) ProtoReflect() protoreflect.Messagefunc (*Evaluation_EvaluationSpec_QuerySetSpec) Reset
func (x *Evaluation_EvaluationSpec_QuerySetSpec) Reset()func (*Evaluation_EvaluationSpec_QuerySetSpec) String
func (x *Evaluation_EvaluationSpec_QuerySetSpec) String() stringEvaluation_EvaluationSpec_SearchRequest
type Evaluation_EvaluationSpec_SearchRequest struct {
// Required. The search request that is used to perform the evaluation.
//
// Only the following fields within SearchRequest are supported; if any
// other fields are provided, an UNSUPPORTED error will be returned:
//
// * [SearchRequest.serving_config][google.cloud.discoveryengine.v1alpha.SearchRequest.serving_config]
// * [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch]
// * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter]
// * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec]
// * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec]
// * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec]
// * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]
SearchRequest *SearchRequest `protobuf:"bytes,2,opt,name=search_request,json=searchRequest,proto3,oneof"`
}Evaluation_State
type Evaluation_State int32Describes the state of an evaluation.
Evaluation_STATE_UNSPECIFIED, Evaluation_PENDING, Evaluation_RUNNING, Evaluation_SUCCEEDED, Evaluation_FAILED
const (
// The evaluation is unspecified.
Evaluation_STATE_UNSPECIFIED Evaluation_State = 0
// The service is preparing to run the evaluation.
Evaluation_PENDING Evaluation_State = 1
// The evaluation is in progress.
Evaluation_RUNNING Evaluation_State = 2
// The evaluation completed successfully.
Evaluation_SUCCEEDED Evaluation_State = 3
// The evaluation failed.
Evaluation_FAILED Evaluation_State = 4
)func (Evaluation_State) Descriptor
func (Evaluation_State) Descriptor() protoreflect.EnumDescriptorfunc (Evaluation_State) Enum
func (x Evaluation_State) Enum() *Evaluation_Statefunc (Evaluation_State) EnumDescriptor
func (Evaluation_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Evaluation_State.Descriptor instead.
func (Evaluation_State) Number
func (x Evaluation_State) Number() protoreflect.EnumNumberfunc (Evaluation_State) String
func (x Evaluation_State) String() stringfunc (Evaluation_State) Type
func (Evaluation_State) Type() protoreflect.EnumTypeFactChunk
type FactChunk struct {
// Text content of the fact chunk. Can be at most 10K characters long.
ChunkText string `protobuf:"bytes,1,opt,name=chunk_text,json=chunkText,proto3" json:"chunk_text,omitempty"`
// Source from which this fact chunk was retrieved. If it was retrieved
// from the GroundingFacts provided in the request then this field will
// contain the index of the specific fact from which this chunk was
// retrieved.
Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
// The index of this chunk. Currently, only used for the streaming mode.
Index int32 `protobuf:"varint,4,opt,name=index,proto3" json:"index,omitempty"`
// More fine-grained information for the source reference.
SourceMetadata map[string]string `protobuf:"bytes,3,rep,name=source_metadata,json=sourceMetadata,proto3" json:"source_metadata,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Fact Chunk.
func (*FactChunk) Descriptor
Deprecated: Use FactChunk.ProtoReflect.Descriptor instead.
func (*FactChunk) GetChunkText
func (*FactChunk) GetIndex
func (*FactChunk) GetSource
func (*FactChunk) GetSourceMetadata
func (*FactChunk) ProtoMessage
func (*FactChunk) ProtoMessage()func (*FactChunk) ProtoReflect
func (x *FactChunk) ProtoReflect() protoreflect.Messagefunc (*FactChunk) Reset
func (x *FactChunk) Reset()func (*FactChunk) String
FetchDomainVerificationStatusRequest
type FetchDomainVerificationStatusRequest struct {
// Required. The site search engine resource under which we fetch all the
// domain verification status.
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
// Requested page size. Server may return fewer items than requested. If
// unspecified, server will pick an appropriate default. The maximum value is
// 1000; values above 1000 will be coerced to 1000.
//
// If this field is negative, an INVALID_ARGUMENT error is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `FetchDomainVerificationStatus`
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// `FetchDomainVerificationStatus` must match the call that provided the page
// token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] method.
func (*FetchDomainVerificationStatusRequest) Descriptor
func (*FetchDomainVerificationStatusRequest) Descriptor() ([]byte, []int)Deprecated: Use FetchDomainVerificationStatusRequest.ProtoReflect.Descriptor instead.
func (*FetchDomainVerificationStatusRequest) GetPageSize
func (x *FetchDomainVerificationStatusRequest) GetPageSize() int32func (*FetchDomainVerificationStatusRequest) GetPageToken
func (x *FetchDomainVerificationStatusRequest) GetPageToken() stringfunc (*FetchDomainVerificationStatusRequest) GetSiteSearchEngine
func (x *FetchDomainVerificationStatusRequest) GetSiteSearchEngine() stringfunc (*FetchDomainVerificationStatusRequest) ProtoMessage
func (*FetchDomainVerificationStatusRequest) ProtoMessage()func (*FetchDomainVerificationStatusRequest) ProtoReflect
func (x *FetchDomainVerificationStatusRequest) ProtoReflect() protoreflect.Messagefunc (*FetchDomainVerificationStatusRequest) Reset
func (x *FetchDomainVerificationStatusRequest) Reset()func (*FetchDomainVerificationStatusRequest) String
func (x *FetchDomainVerificationStatusRequest) String() stringFetchDomainVerificationStatusResponse
type FetchDomainVerificationStatusResponse struct {
// List of TargetSites containing the site verification status.
TargetSites []*TargetSite `protobuf:"bytes,1,rep,name=target_sites,json=targetSites,proto3" json:"target_sites,omitempty"`
// A token that can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// The total number of items matching the request.
// This will always be populated in the response.
TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// contains filtered or unexported fields
}Response message for [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] method.
func (*FetchDomainVerificationStatusResponse) Descriptor
func (*FetchDomainVerificationStatusResponse) Descriptor() ([]byte, []int)Deprecated: Use FetchDomainVerificationStatusResponse.ProtoReflect.Descriptor instead.
func (*FetchDomainVerificationStatusResponse) GetNextPageToken
func (x *FetchDomainVerificationStatusResponse) GetNextPageToken() stringfunc (*FetchDomainVerificationStatusResponse) GetTargetSites
func (x *FetchDomainVerificationStatusResponse) GetTargetSites() []*TargetSitefunc (*FetchDomainVerificationStatusResponse) GetTotalSize
func (x *FetchDomainVerificationStatusResponse) GetTotalSize() int32func (*FetchDomainVerificationStatusResponse) ProtoMessage
func (*FetchDomainVerificationStatusResponse) ProtoMessage()func (*FetchDomainVerificationStatusResponse) ProtoReflect
func (x *FetchDomainVerificationStatusResponse) ProtoReflect() protoreflect.Messagefunc (*FetchDomainVerificationStatusResponse) Reset
func (x *FetchDomainVerificationStatusResponse) Reset()func (*FetchDomainVerificationStatusResponse) String
func (x *FetchDomainVerificationStatusResponse) String() stringFhirStoreSource
type FhirStoreSource struct {
// Required. The full resource name of the FHIR store to import data from, in
// the format of
// `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
FhirStore string `protobuf:"bytes,1,opt,name=fhir_store,json=fhirStore,proto3" json:"fhir_store,omitempty"`
// Intermediate Cloud Storage directory used for the import with a length
// limit of 2,000 characters. Can be specified if one wants to have the
// FhirStore export to a specific Cloud Storage directory.
GcsStagingDir string `protobuf:"bytes,2,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
// The FHIR resource types to import. The resource types should be a subset of
// all [supported FHIR resource
// types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
// Default to all supported FHIR resource types if empty.
ResourceTypes []string `protobuf:"bytes,3,rep,name=resource_types,json=resourceTypes,proto3" json:"resource_types,omitempty"`
// contains filtered or unexported fields
}Cloud FhirStore source import data from.
func (*FhirStoreSource) Descriptor
func (*FhirStoreSource) Descriptor() ([]byte, []int)Deprecated: Use FhirStoreSource.ProtoReflect.Descriptor instead.
func (*FhirStoreSource) GetFhirStore
func (x *FhirStoreSource) GetFhirStore() stringfunc (*FhirStoreSource) GetGcsStagingDir
func (x *FhirStoreSource) GetGcsStagingDir() stringfunc (*FhirStoreSource) GetResourceTypes
func (x *FhirStoreSource) GetResourceTypes() []stringfunc (*FhirStoreSource) ProtoMessage
func (*FhirStoreSource) ProtoMessage()func (*FhirStoreSource) ProtoReflect
func (x *FhirStoreSource) ProtoReflect() protoreflect.Messagefunc (*FhirStoreSource) Reset
func (x *FhirStoreSource) Reset()func (*FhirStoreSource) String
func (x *FhirStoreSource) String() stringFieldConfig
type FieldConfig struct {
// Required. Field path of the schema field.
// For example: `title`, `description`, `release_info.release_year`.
FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
// Output only. Raw type of the field.
FieldType FieldConfig_FieldType `protobuf:"varint,2,opt,name=field_type,json=fieldType,proto3,enum=google.cloud.discoveryengine.v1alpha.FieldConfig_FieldType" json:"field_type,omitempty"`
// If
// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
// is
// [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED],
// field values are indexed so that it can be filtered or faceted in
// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
//
// If
// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
// is unset, the server behavior defaults to
// [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]
// for fields that support setting indexable options. For those fields that do
// not support setting indexable options, such as `object` and `boolean` and
// key properties, the server will skip
// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
// setting, and setting
// [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
// for those fields will throw `INVALID_ARGUMENT` error.
IndexableOption FieldConfig_IndexableOption `protobuf:"varint,3,opt,name=indexable_option,json=indexableOption,proto3,enum=google.cloud.discoveryengine.v1alpha.FieldConfig_IndexableOption" json:"indexable_option,omitempty"`
// If
// [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
// is
// [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED],
// field values are available for dynamic facet. Could only be
// [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
// if
// [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
// is
// [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED].
// Otherwise, an `INVALID_ARGUMENT` error will be returned.
//
// If
// [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
// is unset, the server behavior defaults to
// [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
// for fields that support setting dynamic facetable options. For those fields
// that do not support setting dynamic facetable options, such as `object` and
// `boolean`, the server will skip dynamic facetable option setting, and
// setting
// [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
// for those fields will throw `INVALID_ARGUMENT` error.
DynamicFacetableOption FieldConfig_DynamicFacetableOption `protobuf:"varint,4,opt,name=dynamic_facetable_option,json=dynamicFacetableOption,proto3,enum=google.cloud.discoveryengine.v1alpha.FieldConfig_DynamicFacetableOption" json:"dynamic_facetable_option,omitempty"`
// If
// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
// is
// [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED],
// field values are searchable by text queries in
// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
//
// If
// [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED]
// but field type is numerical, field values will not be searchable by text
// queries in
// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search],
// as there are no text values associated to numerical fields.
//
// If
// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
// is unset, the server behavior defaults to
// [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED]
// for fields that support setting searchable options. Only `string` fields
// that have no key property mapping support setting
// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option].
//
// For those fields that do not support setting searchable options, the server
// will skip searchable option setting, and setting
// [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
// for those fields will throw `INVALID_ARGUMENT` error.
SearchableOption FieldConfig_SearchableOption `protobuf:"varint,5,opt,name=searchable_option,json=searchableOption,proto3,enum=google.cloud.discoveryengine.v1alpha.FieldConfig_SearchableOption" json:"searchable_option,omitempty"`
// If
// [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
// is
// [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED],
// field values are included in the search results.
//
// If
// [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
// is unset, the server behavior defaults to
// [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED]
// for fields that support setting retrievable options. For those fields
// that do not support setting retrievable options, such as `object` and
// `boolean`, the server will skip retrievable option setting, and setting
// [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
// for those fields will throw `INVALID_ARGUMENT` error.
RetrievableOption FieldConfig_RetrievableOption `protobuf:"varint,6,opt,name=retrievable_option,json=retrievableOption,proto3,enum=google.cloud.discoveryengine.v1alpha.FieldConfig_RetrievableOption" json:"retrievable_option,omitempty"`
// If
// [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
// is
// [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED],
// field values are directly used and returned as suggestions for Autocomplete
// in
// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].
//
// If
// [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
// is unset, the server behavior defaults to
// [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED]
// for fields that support setting completable options, which are just
// `string` fields. For those fields that do not support setting completable
// options, the server will skip completable option setting, and setting
// [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
// for those fields will throw `INVALID_ARGUMENT` error.
CompletableOption FieldConfig_CompletableOption `protobuf:"varint,8,opt,name=completable_option,json=completableOption,proto3,enum=google.cloud.discoveryengine.v1alpha.FieldConfig_CompletableOption" json:"completable_option,omitempty"`
// If
// [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
// is
// [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED],
// field values are filterable by filter expression in
// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
//
// If
// [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED]
// but the field type is numerical, field values are not filterable by text
// queries in
// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
// Only textual fields are supported.
//
// If
// [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
// is unset, the default setting is
// [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED]
// for fields that support setting filterable options.
//
// When a field set to [FILTERABLE_DISABLED] is filtered, a warning is
// generated and an empty result is returned.
RecsFilterableOption FieldConfig_FilterableOption `protobuf:"varint,9,opt,name=recs_filterable_option,json=recsFilterableOption,proto3,enum=google.cloud.discoveryengine.v1alpha.FieldConfig_FilterableOption" json:"recs_filterable_option,omitempty"`
// Output only. Type of the key property that this field is mapped to. Empty
// string if this is not annotated as mapped to a key property.
//
// Example types are `title`, `description`. Full list is defined
// by `keyPropertyMapping` in the schema field annotation.
//
// If the schema field has a `KeyPropertyMapping` annotation,
// `indexable_option` and `searchable_option` of this field cannot be
// modified.
KeyPropertyType string `protobuf:"bytes,7,opt,name=key_property_type,json=keyPropertyType,proto3" json:"key_property_type,omitempty"`
// If this field is set, only the corresponding source will be indexed for
// this field. Otherwise, the values from different sources are merged.
//
// Assuming a page with `Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
func (*FieldConfig) Descriptor
func (*FieldConfig) Descriptor() ([]byte, []int)Deprecated: Use FieldConfig.ProtoReflect.Descriptor instead.
func (*FieldConfig) GetAdvancedSiteSearchDataSources
func (x *FieldConfig) GetAdvancedSiteSearchDataSources() []FieldConfig_AdvancedSiteSearchDataSourcefunc (*FieldConfig) GetCompletableOption
func (x *FieldConfig) GetCompletableOption() FieldConfig_CompletableOptionfunc (*FieldConfig) GetDynamicFacetableOption
func (x *FieldConfig) GetDynamicFacetableOption() FieldConfig_DynamicFacetableOptionfunc (*FieldConfig) GetFieldPath
func (x *FieldConfig) GetFieldPath() stringfunc (*FieldConfig) GetFieldType
func (x *FieldConfig) GetFieldType() FieldConfig_FieldTypefunc (*FieldConfig) GetIndexableOption
func (x *FieldConfig) GetIndexableOption() FieldConfig_IndexableOptionfunc (*FieldConfig) GetKeyPropertyType
func (x *FieldConfig) GetKeyPropertyType() stringfunc (*FieldConfig) GetRecsFilterableOption
func (x *FieldConfig) GetRecsFilterableOption() FieldConfig_FilterableOptionfunc (*FieldConfig) GetRetrievableOption
func (x *FieldConfig) GetRetrievableOption() FieldConfig_RetrievableOptionfunc (*FieldConfig) GetSchemaOrgPaths
func (x *FieldConfig) GetSchemaOrgPaths() []stringfunc (*FieldConfig) GetSearchableOption
func (x *FieldConfig) GetSearchableOption() FieldConfig_SearchableOptionfunc (*FieldConfig) ProtoMessage
func (*FieldConfig) ProtoMessage()func (*FieldConfig) ProtoReflect
func (x *FieldConfig) ProtoReflect() protoreflect.Messagefunc (*FieldConfig) Reset
func (x *FieldConfig) Reset()func (*FieldConfig) String
func (x *FieldConfig) String() stringFieldConfig_AdvancedSiteSearchDataSource
type FieldConfig_AdvancedSiteSearchDataSource int32Optional source of the advanced site search field.
FieldConfig_ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED, FieldConfig_METATAGS, FieldConfig_PAGEMAP, FieldConfig_URI_PATTERN_MAPPING, FieldConfig_SCHEMA_ORG
const (
// Value used when unset.
FieldConfig_ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED FieldConfig_AdvancedSiteSearchDataSource = 0
// Retrieve value from meta tag.
FieldConfig_METATAGS FieldConfig_AdvancedSiteSearchDataSource = 1
// Retrieve value from page map.
FieldConfig_PAGEMAP FieldConfig_AdvancedSiteSearchDataSource = 2
// Retrieve value from the attributes set by
// [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
// API.
FieldConfig_URI_PATTERN_MAPPING FieldConfig_AdvancedSiteSearchDataSource = 3
// Retrieve value from schema.org data.
FieldConfig_SCHEMA_ORG FieldConfig_AdvancedSiteSearchDataSource = 4
)func (FieldConfig_AdvancedSiteSearchDataSource) Descriptor
func (FieldConfig_AdvancedSiteSearchDataSource) Descriptor() protoreflect.EnumDescriptorfunc (FieldConfig_AdvancedSiteSearchDataSource) Enum
func (FieldConfig_AdvancedSiteSearchDataSource) EnumDescriptor
func (FieldConfig_AdvancedSiteSearchDataSource) EnumDescriptor() ([]byte, []int)Deprecated: Use FieldConfig_AdvancedSiteSearchDataSource.Descriptor instead.
func (FieldConfig_AdvancedSiteSearchDataSource) Number
func (x FieldConfig_AdvancedSiteSearchDataSource) Number() protoreflect.EnumNumberfunc (FieldConfig_AdvancedSiteSearchDataSource) String
func (x FieldConfig_AdvancedSiteSearchDataSource) String() stringfunc (FieldConfig_AdvancedSiteSearchDataSource) Type
func (FieldConfig_AdvancedSiteSearchDataSource) Type() protoreflect.EnumTypeFieldConfig_CompletableOption
type FieldConfig_CompletableOption int32The setting of Completable options in schema.
FieldConfig_COMPLETABLE_OPTION_UNSPECIFIED, FieldConfig_COMPLETABLE_ENABLED, FieldConfig_COMPLETABLE_DISABLED
const (
// Value used when unset.
FieldConfig_COMPLETABLE_OPTION_UNSPECIFIED FieldConfig_CompletableOption = 0
// Completable option enabled for a schema field.
FieldConfig_COMPLETABLE_ENABLED FieldConfig_CompletableOption = 1
// Completable option disabled for a schema field.
FieldConfig_COMPLETABLE_DISABLED FieldConfig_CompletableOption = 2
)func (FieldConfig_CompletableOption) Descriptor
func (FieldConfig_CompletableOption) Descriptor() protoreflect.EnumDescriptorfunc (FieldConfig_CompletableOption) Enum
func (x FieldConfig_CompletableOption) Enum() *FieldConfig_CompletableOptionfunc (FieldConfig_CompletableOption) EnumDescriptor
func (FieldConfig_CompletableOption) EnumDescriptor() ([]byte, []int)Deprecated: Use FieldConfig_CompletableOption.Descriptor instead.
func (FieldConfig_CompletableOption) Number
func (x FieldConfig_CompletableOption) Number() protoreflect.EnumNumberfunc (FieldConfig_CompletableOption) String
func (x FieldConfig_CompletableOption) String() stringfunc (FieldConfig_CompletableOption) Type
func (FieldConfig_CompletableOption) Type() protoreflect.EnumTypeFieldConfig_DynamicFacetableOption
type FieldConfig_DynamicFacetableOption int32The status of the dynamic facetable option of a schema field.
FieldConfig_DYNAMIC_FACETABLE_OPTION_UNSPECIFIED, FieldConfig_DYNAMIC_FACETABLE_ENABLED, FieldConfig_DYNAMIC_FACETABLE_DISABLED
const (
// Value used when unset.
FieldConfig_DYNAMIC_FACETABLE_OPTION_UNSPECIFIED FieldConfig_DynamicFacetableOption = 0
// Dynamic facetable option enabled for a schema field.
FieldConfig_DYNAMIC_FACETABLE_ENABLED FieldConfig_DynamicFacetableOption = 1
// Dynamic facetable option disabled for a schema field.
FieldConfig_DYNAMIC_FACETABLE_DISABLED FieldConfig_DynamicFacetableOption = 2
)func (FieldConfig_DynamicFacetableOption) Descriptor
func (FieldConfig_DynamicFacetableOption) Descriptor() protoreflect.EnumDescriptorfunc (FieldConfig_DynamicFacetableOption) Enum
func (x FieldConfig_DynamicFacetableOption) Enum() *FieldConfig_DynamicFacetableOptionfunc (FieldConfig_DynamicFacetableOption) EnumDescriptor
func (FieldConfig_DynamicFacetableOption) EnumDescriptor() ([]byte, []int)Deprecated: Use FieldConfig_DynamicFacetableOption.Descriptor instead.
func (FieldConfig_DynamicFacetableOption) Number
func (x FieldConfig_DynamicFacetableOption) Number() protoreflect.EnumNumberfunc (FieldConfig_DynamicFacetableOption) String
func (x FieldConfig_DynamicFacetableOption) String() stringfunc (FieldConfig_DynamicFacetableOption) Type
func (FieldConfig_DynamicFacetableOption) Type() protoreflect.EnumTypeFieldConfig_FieldType
type FieldConfig_FieldType int32Field value type in the Schema.
FieldConfig_FIELD_TYPE_UNSPECIFIED, FieldConfig_OBJECT, FieldConfig_STRING, FieldConfig_NUMBER, FieldConfig_INTEGER, FieldConfig_BOOLEAN, FieldConfig_GEOLOCATION, FieldConfig_DATETIME
const (
// Field type is unspecified.
FieldConfig_FIELD_TYPE_UNSPECIFIED FieldConfig_FieldType = 0
// Field value type is Object.
FieldConfig_OBJECT FieldConfig_FieldType = 1
// Field value type is String.
FieldConfig_STRING FieldConfig_FieldType = 2
// Field value type is Number.
FieldConfig_NUMBER FieldConfig_FieldType = 3
// Field value type is Integer.
FieldConfig_INTEGER FieldConfig_FieldType = 4
// Field value type is Boolean.
FieldConfig_BOOLEAN FieldConfig_FieldType = 5
// Field value type is Geolocation. Geolocation is expressed as an object
// with the following keys:
//
// * `id`: a string representing the location id
// * `longitude`: a number representing the longitude coordinate of the
// location
// * `latitude`: a number repesenting the latitude coordinate of the
// location
// * `address`: a string representing the full address of the location
//
// `latitude` and `longitude` must always be provided together. At least one
// of a) `address` or b) `latitude`-`longitude` pair must be provided.
FieldConfig_GEOLOCATION FieldConfig_FieldType = 6
// Field value type is Datetime. Datetime can be expressed as either:
//
// * a number representing milliseconds-since-the-epoch
// * a string representing milliseconds-since-the-epoch. e.g.
// `"1420070400001"`
// * a string representing the [ISO
// 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g.
// `"2015-01-01"` or `"2015-01-01T12:10:30Z"`
FieldConfig_DATETIME FieldConfig_FieldType = 7
)func (FieldConfig_FieldType) Descriptor
func (FieldConfig_FieldType) Descriptor() protoreflect.EnumDescriptorfunc (FieldConfig_FieldType) Enum
func (x FieldConfig_FieldType) Enum() *FieldConfig_FieldTypefunc (FieldConfig_FieldType) EnumDescriptor
func (FieldConfig_FieldType) EnumDescriptor() ([]byte, []int)Deprecated: Use FieldConfig_FieldType.Descriptor instead.
func (FieldConfig_FieldType) Number
func (x FieldConfig_FieldType) Number() protoreflect.EnumNumberfunc (FieldConfig_FieldType) String
func (x FieldConfig_FieldType) String() stringfunc (FieldConfig_FieldType) Type
func (FieldConfig_FieldType) Type() protoreflect.EnumTypeFieldConfig_FilterableOption
type FieldConfig_FilterableOption int32Sets the filterable option for schema fields.
FieldConfig_FILTERABLE_OPTION_UNSPECIFIED, FieldConfig_FILTERABLE_ENABLED, FieldConfig_FILTERABLE_DISABLED
const (
// Value used when unset.
FieldConfig_FILTERABLE_OPTION_UNSPECIFIED FieldConfig_FilterableOption = 0
// Filterable option enabled for a schema field.
FieldConfig_FILTERABLE_ENABLED FieldConfig_FilterableOption = 1
// Filterable option disabled for a schema field.
FieldConfig_FILTERABLE_DISABLED FieldConfig_FilterableOption = 2
)func (FieldConfig_FilterableOption) Descriptor
func (FieldConfig_FilterableOption) Descriptor() protoreflect.EnumDescriptorfunc (FieldConfig_FilterableOption) Enum
func (x FieldConfig_FilterableOption) Enum() *FieldConfig_FilterableOptionfunc (FieldConfig_FilterableOption) EnumDescriptor
func (FieldConfig_FilterableOption) EnumDescriptor() ([]byte, []int)Deprecated: Use FieldConfig_FilterableOption.Descriptor instead.
func (FieldConfig_FilterableOption) Number
func (x FieldConfig_FilterableOption) Number() protoreflect.EnumNumberfunc (FieldConfig_FilterableOption) String
func (x FieldConfig_FilterableOption) String() stringfunc (FieldConfig_FilterableOption) Type
func (FieldConfig_FilterableOption) Type() protoreflect.EnumTypeFieldConfig_IndexableOption
type FieldConfig_IndexableOption int32The setting of Indexable options in schema.
FieldConfig_INDEXABLE_OPTION_UNSPECIFIED, FieldConfig_INDEXABLE_ENABLED, FieldConfig_INDEXABLE_DISABLED
const (
// Value used when unset.
FieldConfig_INDEXABLE_OPTION_UNSPECIFIED FieldConfig_IndexableOption = 0
// Indexable option enabled for a schema field.
FieldConfig_INDEXABLE_ENABLED FieldConfig_IndexableOption = 1
// Indexable option disabled for a schema field.
FieldConfig_INDEXABLE_DISABLED FieldConfig_IndexableOption = 2
)func (FieldConfig_IndexableOption) Descriptor
func (FieldConfig_IndexableOption) Descriptor() protoreflect.EnumDescriptorfunc (FieldConfig_IndexableOption) Enum
func (x FieldConfig_IndexableOption) Enum() *FieldConfig_IndexableOptionfunc (FieldConfig_IndexableOption) EnumDescriptor
func (FieldConfig_IndexableOption) EnumDescriptor() ([]byte, []int)Deprecated: Use FieldConfig_IndexableOption.Descriptor instead.
func (FieldConfig_IndexableOption) Number
func (x FieldConfig_IndexableOption) Number() protoreflect.EnumNumberfunc (FieldConfig_IndexableOption) String
func (x FieldConfig_IndexableOption) String() stringfunc (FieldConfig_IndexableOption) Type
func (FieldConfig_IndexableOption) Type() protoreflect.EnumTypeFieldConfig_RetrievableOption
type FieldConfig_RetrievableOption int32The setting of Retrievable options in schema.
FieldConfig_RETRIEVABLE_OPTION_UNSPECIFIED, FieldConfig_RETRIEVABLE_ENABLED, FieldConfig_RETRIEVABLE_DISABLED
const (
// Value used when unset.
FieldConfig_RETRIEVABLE_OPTION_UNSPECIFIED FieldConfig_RetrievableOption = 0
// Retrievable option enabled for a schema field.
FieldConfig_RETRIEVABLE_ENABLED FieldConfig_RetrievableOption = 1
// Retrievable option disabled for a schema field.
FieldConfig_RETRIEVABLE_DISABLED FieldConfig_RetrievableOption = 2
)func (FieldConfig_RetrievableOption) Descriptor
func (FieldConfig_RetrievableOption) Descriptor() protoreflect.EnumDescriptorfunc (FieldConfig_RetrievableOption) Enum
func (x FieldConfig_RetrievableOption) Enum() *FieldConfig_RetrievableOptionfunc (FieldConfig_RetrievableOption) EnumDescriptor
func (FieldConfig_RetrievableOption) EnumDescriptor() ([]byte, []int)Deprecated: Use FieldConfig_RetrievableOption.Descriptor instead.
func (FieldConfig_RetrievableOption) Number
func (x FieldConfig_RetrievableOption) Number() protoreflect.EnumNumberfunc (FieldConfig_RetrievableOption) String
func (x FieldConfig_RetrievableOption) String() stringfunc (FieldConfig_RetrievableOption) Type
func (FieldConfig_RetrievableOption) Type() protoreflect.EnumTypeFieldConfig_SearchableOption
type FieldConfig_SearchableOption int32The setting of Searchable options in schema.
FieldConfig_SEARCHABLE_OPTION_UNSPECIFIED, FieldConfig_SEARCHABLE_ENABLED, FieldConfig_SEARCHABLE_DISABLED
const (
// Value used when unset.
FieldConfig_SEARCHABLE_OPTION_UNSPECIFIED FieldConfig_SearchableOption = 0
// Searchable option enabled for a schema field.
FieldConfig_SEARCHABLE_ENABLED FieldConfig_SearchableOption = 1
// Searchable option disabled for a schema field.
FieldConfig_SEARCHABLE_DISABLED FieldConfig_SearchableOption = 2
)func (FieldConfig_SearchableOption) Descriptor
func (FieldConfig_SearchableOption) Descriptor() protoreflect.EnumDescriptorfunc (FieldConfig_SearchableOption) Enum
func (x FieldConfig_SearchableOption) Enum() *FieldConfig_SearchableOptionfunc (FieldConfig_SearchableOption) EnumDescriptor
func (FieldConfig_SearchableOption) EnumDescriptor() ([]byte, []int)Deprecated: Use FieldConfig_SearchableOption.Descriptor instead.
func (FieldConfig_SearchableOption) Number
func (x FieldConfig_SearchableOption) Number() protoreflect.EnumNumberfunc (FieldConfig_SearchableOption) String
func (x FieldConfig_SearchableOption) String() stringfunc (FieldConfig_SearchableOption) Type
func (FieldConfig_SearchableOption) Type() protoreflect.EnumTypeFileCharacteristics
type FileCharacteristics struct {
// Output only. Generic map of characteristics.
Characteristics map[string]string `protobuf:"bytes,6,rep,name=characteristics,proto3" json:"characteristics,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Caracteristics of other file types.
func (*FileCharacteristics) Descriptor
func (*FileCharacteristics) Descriptor() ([]byte, []int)Deprecated: Use FileCharacteristics.ProtoReflect.Descriptor instead.
func (*FileCharacteristics) GetCharacteristics
func (x *FileCharacteristics) GetCharacteristics() map[string]stringfunc (*FileCharacteristics) ProtoMessage
func (*FileCharacteristics) ProtoMessage()func (*FileCharacteristics) ProtoReflect
func (x *FileCharacteristics) ProtoReflect() protoreflect.Messagefunc (*FileCharacteristics) Reset
func (x *FileCharacteristics) Reset()func (*FileCharacteristics) String
func (x *FileCharacteristics) String() stringFileMetadata
type FileMetadata struct {
// Output only. The ID of the file.
FileId string `protobuf:"bytes,1,opt,name=file_id,json=fileId,proto3" json:"file_id,omitempty"`
// Output only. The name of the file uploaded.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// The content type of the file, see
// https://www.iana.org/assignments/media-types/media-types.xhtml.
MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// Output only. The size of the context file in bytes.
ByteSize int64 `protobuf:"varint,4,opt,name=byte_size,json=byteSize,proto3" json:"byte_size,omitempty"`
// Optional. The original location of the file. It may be a local file path,
// or any other URI that allows accessing the file in an external system.
// There are two scenarios in which this url may be empty:
// 1. If the file was sent as inline data (e.g. pasted from the clipboard).
// 2. If the original location is not available.
//
// Note that there's no guarantee that the URI will be pointing to a valid
// or actually existing file. For example, a file might have been uploaded
// to the session, and then deleted from the original source.
OriginalUri string `protobuf:"bytes,9,opt,name=original_uri,json=originalUri,proto3" json:"original_uri,omitempty"`
// Optional. The type of the original source of the file.
OriginalSourceType FileSource `protobuf:"varint,10,opt,name=original_source_type,json=originalSourceType,proto3,enum=google.cloud.discoveryengine.v1alpha.FileSource" json:"original_source_type,omitempty"`
// Output only. The time the file was uploaded (If this is a file
// generated by an internal process and then made available to the session,
// this indicates the moment it happened).
UploadTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=upload_time,json=uploadTime,proto3" json:"upload_time,omitempty"`
// Output only. The time the file was added to the session. Note that if a
// file was added, then modified externally, then added again, the add time
// will be updated.
LastAddTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=last_add_time,json=lastAddTime,proto3" json:"last_add_time,omitempty"`
// Optional. Represents metadata related to the file that can suit particular
// use cases. The prefix "google." is reserved for the key for use by
// Google, but other prefixes can be freely used.
Metadata map[string]string `protobuf:"bytes,18,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Output only. The
// [AssistantService.DownloadSessionFile][google.cloud.discoveryengine.v1alpha.AssistantService.DownloadSessionFile]
// URL to download the file. This URL will need the same credentials as
// [AssistantService.ListSessionFileMetadata][google.cloud.discoveryengine.v1alpha.AssistantService.ListSessionFileMetadata]
// method and will provide the resource.
DownloadUri string `protobuf:"bytes,20,opt,name=download_uri,json=downloadUri,proto3" json:"download_uri,omitempty"`
// Optional. The origin of the file.
FileOriginType FileOriginType `protobuf:"varint,21,opt,name=file_origin_type,json=fileOriginType,proto3,enum=google.cloud.discoveryengine.v1alpha.FileOriginType" json:"file_origin_type,omitempty"`
// Output only. Alternate views of this file object. Each file view is
// attached to a specific role. Possible example keys:
// - "thumbnail"
// - "mobile_thumbnail"
// - "clip"
// - "summary"
// - "translation"
Views map[string]*FileView `protobuf:"bytes,22,rep,name=views,proto3" json:"views,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Represents a file attached to a session (context file)
func (*FileMetadata) Descriptor
func (*FileMetadata) Descriptor() ([]byte, []int)Deprecated: Use FileMetadata.ProtoReflect.Descriptor instead.
func (*FileMetadata) GetByteSize
func (x *FileMetadata) GetByteSize() int64func (*FileMetadata) GetDownloadUri
func (x *FileMetadata) GetDownloadUri() stringfunc (*FileMetadata) GetFileId
func (x *FileMetadata) GetFileId() stringfunc (*FileMetadata) GetFileOriginType
func (x *FileMetadata) GetFileOriginType() FileOriginTypefunc (*FileMetadata) GetLastAddTime
func (x *FileMetadata) GetLastAddTime() *timestamppb.Timestampfunc (*FileMetadata) GetMetadata
func (x *FileMetadata) GetMetadata() map[string]stringfunc (*FileMetadata) GetMimeType
func (x *FileMetadata) GetMimeType() stringfunc (*FileMetadata) GetName
func (x *FileMetadata) GetName() stringfunc (*FileMetadata) GetOriginalSourceType
func (x *FileMetadata) GetOriginalSourceType() FileSourcefunc (*FileMetadata) GetOriginalUri
func (x *FileMetadata) GetOriginalUri() stringfunc (*FileMetadata) GetUploadTime
func (x *FileMetadata) GetUploadTime() *timestamppb.Timestampfunc (*FileMetadata) GetViews
func (x *FileMetadata) GetViews() map[string]*FileViewfunc (*FileMetadata) ProtoMessage
func (*FileMetadata) ProtoMessage()func (*FileMetadata) ProtoReflect
func (x *FileMetadata) ProtoReflect() protoreflect.Messagefunc (*FileMetadata) Reset
func (x *FileMetadata) Reset()func (*FileMetadata) String
func (x *FileMetadata) String() stringFileOriginType
type FileOriginType int32The origin of the file.
FileOriginType_FILE_ORIGIN_TYPE_UNSPECIFIED, FileOriginType_USER_PROVIDED, FileOriginType_AI_GENERATED, FileOriginType_INTERNALLY_GENERATED
const (
// Default value.
FileOriginType_FILE_ORIGIN_TYPE_UNSPECIFIED FileOriginType = 0
// The file was provided by the user.
FileOriginType_USER_PROVIDED FileOriginType = 1
// The file was generated by an AI model.
FileOriginType_AI_GENERATED FileOriginType = 2
// The file was generated from other files by an internal process.
FileOriginType_INTERNALLY_GENERATED FileOriginType = 3
)func (FileOriginType) Descriptor
func (FileOriginType) Descriptor() protoreflect.EnumDescriptorfunc (FileOriginType) Enum
func (x FileOriginType) Enum() *FileOriginTypefunc (FileOriginType) EnumDescriptor
func (FileOriginType) EnumDescriptor() ([]byte, []int)Deprecated: Use FileOriginType.Descriptor instead.
func (FileOriginType) Number
func (x FileOriginType) Number() protoreflect.EnumNumberfunc (FileOriginType) String
func (x FileOriginType) String() stringfunc (FileOriginType) Type
func (FileOriginType) Type() protoreflect.EnumTypeFileSource
type FileSource int32Original source of the file.
FileSource_FILE_SOURCE_UNSPECIFIED, FileSource_FILE_SOURCE_INLINE, FileSource_FILE_SOURCE_LOCAL, FileSource_FILE_SOURCE_CLOUD_STORAGE, FileSource_FILE_SOURCE_CLOUD_DRIVE, FileSource_FILE_SOURCE_URL
const (
// Default value. Unknown source.
FileSource_FILE_SOURCE_UNSPECIFIED FileSource = 0
// The data of the file was provided inline (e.g. pasted from the clipboard).
FileSource_FILE_SOURCE_INLINE FileSource = 1
// The file was uploaded from a local file.
FileSource_FILE_SOURCE_LOCAL FileSource = 2
// The file was uploaded from Cloud Storage.
FileSource_FILE_SOURCE_CLOUD_STORAGE FileSource = 3
// The file was uploaded from Drive.
FileSource_FILE_SOURCE_CLOUD_DRIVE FileSource = 4
// The file was retrieved from a URL (e.g. public web).
FileSource_FILE_SOURCE_URL FileSource = 5
)func (FileSource) Descriptor
func (FileSource) Descriptor() protoreflect.EnumDescriptorfunc (FileSource) Enum
func (x FileSource) Enum() *FileSourcefunc (FileSource) EnumDescriptor
func (FileSource) EnumDescriptor() ([]byte, []int)Deprecated: Use FileSource.Descriptor instead.
func (FileSource) Number
func (x FileSource) Number() protoreflect.EnumNumberfunc (FileSource) String
func (x FileSource) String() stringfunc (FileSource) Type
func (FileSource) Type() protoreflect.EnumTypeFileView
type FileView struct {
// Characteristics of the media view, allowing for flexible extensions.
// Metadata is always internally generated by the process creating
// the view.
//
// Types that are valid to be assigned to Characteristics:
//
// *FileView_ImageCharacteristics
// *FileView_VideoCharacteristics
// *FileView_FileCharacteristics
Characteristics isFileView_Characteristics `protobuf_oneof:"characteristics"`
// Output only. Globally Unique id for this specific view.
ViewId string `protobuf:"bytes,1,opt,name=view_id,json=viewId,proto3" json:"view_id,omitempty"`
// Output only. The URI to access this media view.
Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
// Output only. MIME type (e.g., "image/jpeg", "image/png", "text/plain",
// "video/mp4")
MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// Output only. The size of the view in bytes.
ByteSize int64 `protobuf:"varint,4,opt,name=byte_size,json=byteSize,proto3" json:"byte_size,omitempty"`
// Output only. The time the view was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}Represents a specific alternate version or "view" of a file object, such as a summary, a thumbnail, a translated version, etc.
func (*FileView) Descriptor
Deprecated: Use FileView.ProtoReflect.Descriptor instead.
func (*FileView) GetByteSize
func (*FileView) GetCharacteristics
func (x *FileView) GetCharacteristics() isFileView_Characteristicsfunc (*FileView) GetCreateTime
func (x *FileView) GetCreateTime() *timestamppb.Timestampfunc (*FileView) GetFileCharacteristics
func (x *FileView) GetFileCharacteristics() *FileCharacteristicsfunc (*FileView) GetImageCharacteristics
func (x *FileView) GetImageCharacteristics() *ImageCharacteristicsfunc (*FileView) GetMimeType
func (*FileView) GetUri
func (*FileView) GetVideoCharacteristics
func (x *FileView) GetVideoCharacteristics() *VideoCharacteristicsfunc (*FileView) GetViewId
func (*FileView) ProtoMessage
func (*FileView) ProtoMessage()func (*FileView) ProtoReflect
func (x *FileView) ProtoReflect() protoreflect.Messagefunc (*FileView) Reset
func (x *FileView) Reset()func (*FileView) String
FileView_FileCharacteristics
type FileView_FileCharacteristics struct {
// Output only. Characteristics of other file types.
FileCharacteristics *FileCharacteristics `protobuf:"bytes,8,opt,name=file_characteristics,json=fileCharacteristics,proto3,oneof"`
}FileView_ImageCharacteristics
type FileView_ImageCharacteristics struct {
// Output only. Characteristics of an image media view.
ImageCharacteristics *ImageCharacteristics `protobuf:"bytes,6,opt,name=image_characteristics,json=imageCharacteristics,proto3,oneof"`
}FileView_VideoCharacteristics
type FileView_VideoCharacteristics struct {
// Output only. Characteristics of a video media view.
VideoCharacteristics *VideoCharacteristics `protobuf:"bytes,7,opt,name=video_characteristics,json=videoCharacteristics,proto3,oneof"`
}FirestoreSource
type FirestoreSource struct {
// The project ID that the Cloud SQL source is in with a length limit of 128
// characters. If not specified, inherits the project ID from the parent
// request.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Required. The Firestore database to copy the data from with a length limit
// of 256 characters.
DatabaseId string `protobuf:"bytes,2,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// Required. The Firestore collection (or entity) to copy the data from with a
// length limit of 1,500 characters.
CollectionId string `protobuf:"bytes,3,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
// Intermediate Cloud Storage directory used for the import with a length
// limit of 2,000 characters. Can be specified if one wants to have the
// Firestore export to a specific Cloud Storage directory.
//
// Ensure that the Firestore service account has the necessary Cloud
// Storage Admin permissions to access the specified Cloud Storage directory.
GcsStagingDir string `protobuf:"bytes,4,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
// contains filtered or unexported fields
}Firestore source import data from.
func (*FirestoreSource) Descriptor
func (*FirestoreSource) Descriptor() ([]byte, []int)Deprecated: Use FirestoreSource.ProtoReflect.Descriptor instead.
func (*FirestoreSource) GetCollectionId
func (x *FirestoreSource) GetCollectionId() stringfunc (*FirestoreSource) GetDatabaseId
func (x *FirestoreSource) GetDatabaseId() stringfunc (*FirestoreSource) GetGcsStagingDir
func (x *FirestoreSource) GetGcsStagingDir() stringfunc (*FirestoreSource) GetProjectId
func (x *FirestoreSource) GetProjectId() stringfunc (*FirestoreSource) ProtoMessage
func (*FirestoreSource) ProtoMessage()func (*FirestoreSource) ProtoReflect
func (x *FirestoreSource) ProtoReflect() protoreflect.Messagefunc (*FirestoreSource) Reset
func (x *FirestoreSource) Reset()func (*FirestoreSource) String
func (x *FirestoreSource) String() stringGcsSource
type GcsSource struct {
// Required. Cloud Storage URIs to input files. Each URI can be up to
// 2000 characters long. URIs can match the full object path (for example,
// `gs://bucket/directory/object.json`) or a pattern matching one or more
// files, such as `gs://bucket/directory/*.json`.
//
// A request can contain at most 100 files (or 100,000 files if `data_schema`
// is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
// `content`).
InputUris []string `protobuf:"bytes,1,rep,name=input_uris,json=inputUris,proto3" json:"input_uris,omitempty"`
// The schema to use when parsing the data from the source.
//
// Supported values for document imports:
//
// * `document` (default): One JSON
// [Document][google.cloud.discoveryengine.v1alpha.Document] per line. Each
// document must
//
// have a valid
// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id].
// - `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
// `input_uris` becomes a document, with the ID set to the first 128
// bits of SHA256(URI) encoded as a hex string.
// - `custom`: One custom data JSON per row in arbitrary format that conforms
// to the defined [Schema][google.cloud.discoveryengine.v1alpha.Schema] of
// the data store. This can only be used by the GENERIC Data Store vertical.
// - `csv`: A CSV file with header conforming to the defined
//
// [Schema][google.cloud.discoveryengine.v1alpha.Schema] of the
//
// data store. Each entry after the header is imported as a Document.
// This can only be used by the GENERIC Data Store vertical.
//
// Supported values for user event imports:
//
// * `user_event` (default): One JSON
// [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] per line.
DataSchema string `protobuf:"bytes,2,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
// contains filtered or unexported fields
}Cloud Storage location for input content.
func (*GcsSource) Descriptor
Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.
func (*GcsSource) GetDataSchema
func (*GcsSource) GetInputUris
func (*GcsSource) ProtoMessage
func (*GcsSource) ProtoMessage()func (*GcsSource) ProtoReflect
func (x *GcsSource) ProtoReflect() protoreflect.Messagefunc (*GcsSource) Reset
func (x *GcsSource) Reset()func (*GcsSource) String
GetAclConfigRequest
type GetAclConfigRequest struct {
// Required. Resource name of
// [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], such as
// `projects/*/locations/*/aclConfig`.
//
// If the caller does not have permission to access the
// [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], regardless of
// whether or not it exists, a PERMISSION_DENIED error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for GetAclConfigRequest method.
func (*GetAclConfigRequest) Descriptor
func (*GetAclConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use GetAclConfigRequest.ProtoReflect.Descriptor instead.
func (*GetAclConfigRequest) GetName
func (x *GetAclConfigRequest) GetName() stringfunc (*GetAclConfigRequest) ProtoMessage
func (*GetAclConfigRequest) ProtoMessage()func (*GetAclConfigRequest) ProtoReflect
func (x *GetAclConfigRequest) ProtoReflect() protoreflect.Messagefunc (*GetAclConfigRequest) Reset
func (x *GetAclConfigRequest) Reset()func (*GetAclConfigRequest) String
func (x *GetAclConfigRequest) String() stringGetAnswerRequest
type GetAnswerRequest struct {
// Required. The resource name of the Answer to get. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for GetAnswer method.
func (*GetAnswerRequest) Descriptor
func (*GetAnswerRequest) Descriptor() ([]byte, []int)Deprecated: Use GetAnswerRequest.ProtoReflect.Descriptor instead.
func (*GetAnswerRequest) GetName
func (x *GetAnswerRequest) GetName() stringfunc (*GetAnswerRequest) ProtoMessage
func (*GetAnswerRequest) ProtoMessage()func (*GetAnswerRequest) ProtoReflect
func (x *GetAnswerRequest) ProtoReflect() protoreflect.Messagefunc (*GetAnswerRequest) Reset
func (x *GetAnswerRequest) Reset()func (*GetAnswerRequest) String
func (x *GetAnswerRequest) String() stringGetChunkRequest
type GetChunkRequest struct {
// Required. Full resource name of
// [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`.
//
// If the caller does not have permission to access the
// [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], regardless of whether
// or not it exists, a `PERMISSION_DENIED` error is returned.
//
// If the requested [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] does
// not exist, a `NOT_FOUND` error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [ChunkService.GetChunk][google.cloud.discoveryengine.v1alpha.ChunkService.GetChunk] method.
func (*GetChunkRequest) Descriptor
func (*GetChunkRequest) Descriptor() ([]byte, []int)Deprecated: Use GetChunkRequest.ProtoReflect.Descriptor instead.
func (*GetChunkRequest) GetName
func (x *GetChunkRequest) GetName() stringfunc (*GetChunkRequest) ProtoMessage
func (*GetChunkRequest) ProtoMessage()func (*GetChunkRequest) ProtoReflect
func (x *GetChunkRequest) ProtoReflect() protoreflect.Messagefunc (*GetChunkRequest) Reset
func (x *GetChunkRequest) Reset()func (*GetChunkRequest) String
func (x *GetChunkRequest) String() stringGetControlRequest
type GetControlRequest struct {
// Required. The resource name of the Control to get. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for GetControl method.
func (*GetControlRequest) Descriptor
func (*GetControlRequest) Descriptor() ([]byte, []int)Deprecated: Use GetControlRequest.ProtoReflect.Descriptor instead.
func (*GetControlRequest) GetName
func (x *GetControlRequest) GetName() stringfunc (*GetControlRequest) ProtoMessage
func (*GetControlRequest) ProtoMessage()func (*GetControlRequest) ProtoReflect
func (x *GetControlRequest) ProtoReflect() protoreflect.Messagefunc (*GetControlRequest) Reset
func (x *GetControlRequest) Reset()func (*GetControlRequest) String
func (x *GetControlRequest) String() stringGetConversationRequest
type GetConversationRequest struct {
// Required. The resource name of the Conversation to get. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for GetConversation method.
func (*GetConversationRequest) Descriptor
func (*GetConversationRequest) Descriptor() ([]byte, []int)Deprecated: Use GetConversationRequest.ProtoReflect.Descriptor instead.
func (*GetConversationRequest) GetName
func (x *GetConversationRequest) GetName() stringfunc (*GetConversationRequest) ProtoMessage
func (*GetConversationRequest) ProtoMessage()func (*GetConversationRequest) ProtoReflect
func (x *GetConversationRequest) ProtoReflect() protoreflect.Messagefunc (*GetConversationRequest) Reset
func (x *GetConversationRequest) Reset()func (*GetConversationRequest) String
func (x *GetConversationRequest) String() stringGetDataStoreRequest
type GetDataStoreRequest struct {
// Required. Full resource name of
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], such as
// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
//
// If the caller does not have permission to access the
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], regardless of
// whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the requested
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] does not exist,
// a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore] method.
func (*GetDataStoreRequest) Descriptor
func (*GetDataStoreRequest) Descriptor() ([]byte, []int)Deprecated: Use GetDataStoreRequest.ProtoReflect.Descriptor instead.
func (*GetDataStoreRequest) GetName
func (x *GetDataStoreRequest) GetName() stringfunc (*GetDataStoreRequest) ProtoMessage
func (*GetDataStoreRequest) ProtoMessage()func (*GetDataStoreRequest) ProtoReflect
func (x *GetDataStoreRequest) ProtoReflect() protoreflect.Messagefunc (*GetDataStoreRequest) Reset
func (x *GetDataStoreRequest) Reset()func (*GetDataStoreRequest) String
func (x *GetDataStoreRequest) String() stringGetDocumentProcessingConfigRequest
type GetDocumentProcessingConfigRequest struct {
// Required. Full DocumentProcessingConfig resource name. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for [DataStoreService.GetDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDocumentProcessingConfig] method.
func (*GetDocumentProcessingConfigRequest) Descriptor
func (*GetDocumentProcessingConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use GetDocumentProcessingConfigRequest.ProtoReflect.Descriptor instead.
func (*GetDocumentProcessingConfigRequest) GetName
func (x *GetDocumentProcessingConfigRequest) GetName() stringfunc (*GetDocumentProcessingConfigRequest) ProtoMessage
func (*GetDocumentProcessingConfigRequest) ProtoMessage()func (*GetDocumentProcessingConfigRequest) ProtoReflect
func (x *GetDocumentProcessingConfigRequest) ProtoReflect() protoreflect.Messagefunc (*GetDocumentProcessingConfigRequest) Reset
func (x *GetDocumentProcessingConfigRequest) Reset()func (*GetDocumentProcessingConfigRequest) String
func (x *GetDocumentProcessingConfigRequest) String() stringGetDocumentRequest
type GetDocumentRequest struct {
// Required. Full resource name of
// [Document][google.cloud.discoveryengine.v1alpha.Document], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
//
// If the caller does not have permission to access the
// [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
// whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
// does not exist, a `NOT_FOUND` error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] method.
func (*GetDocumentRequest) Descriptor
func (*GetDocumentRequest) Descriptor() ([]byte, []int)Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.
func (*GetDocumentRequest) GetName
func (x *GetDocumentRequest) GetName() stringfunc (*GetDocumentRequest) ProtoMessage
func (*GetDocumentRequest) ProtoMessage()func (*GetDocumentRequest) ProtoReflect
func (x *GetDocumentRequest) ProtoReflect() protoreflect.Messagefunc (*GetDocumentRequest) Reset
func (x *GetDocumentRequest) Reset()func (*GetDocumentRequest) String
func (x *GetDocumentRequest) String() stringGetEngineRequest
type GetEngineRequest struct {
// Required. Full resource name of
// [Engine][google.cloud.discoveryengine.v1alpha.Engine], such as
// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] method.
func (*GetEngineRequest) Descriptor
func (*GetEngineRequest) Descriptor() ([]byte, []int)Deprecated: Use GetEngineRequest.ProtoReflect.Descriptor instead.
func (*GetEngineRequest) GetName
func (x *GetEngineRequest) GetName() stringfunc (*GetEngineRequest) ProtoMessage
func (*GetEngineRequest) ProtoMessage()func (*GetEngineRequest) ProtoReflect
func (x *GetEngineRequest) ProtoReflect() protoreflect.Messagefunc (*GetEngineRequest) Reset
func (x *GetEngineRequest) Reset()func (*GetEngineRequest) String
func (x *GetEngineRequest) String() stringGetEvaluationRequest
type GetEvaluationRequest struct {
// Required. Full resource name of
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], such as
// `projects/{project}/locations/{location}/evaluations/{evaluation}`.
//
// If the caller does not have permission to access the
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], regardless
// of whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the requested
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] does not
// exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.GetEvaluation] method.
func (*GetEvaluationRequest) Descriptor
func (*GetEvaluationRequest) Descriptor() ([]byte, []int)Deprecated: Use GetEvaluationRequest.ProtoReflect.Descriptor instead.
func (*GetEvaluationRequest) GetName
func (x *GetEvaluationRequest) GetName() stringfunc (*GetEvaluationRequest) ProtoMessage
func (*GetEvaluationRequest) ProtoMessage()func (*GetEvaluationRequest) ProtoReflect
func (x *GetEvaluationRequest) ProtoReflect() protoreflect.Messagefunc (*GetEvaluationRequest) Reset
func (x *GetEvaluationRequest) Reset()func (*GetEvaluationRequest) String
func (x *GetEvaluationRequest) String() stringGetProcessedDocumentRequest
type GetProcessedDocumentRequest struct {
// Required. Full resource name of
// [Document][google.cloud.discoveryengine.v1alpha.Document], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
//
// If the caller does not have permission to access the
// [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
// whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
// does not exist, a `NOT_FOUND` error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. What type of processing to return.
ProcessedDocumentType GetProcessedDocumentRequest_ProcessedDocumentType `protobuf:"varint,2,opt,name=processed_document_type,json=processedDocumentType,proto3,enum=google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest_ProcessedDocumentType" json:"processed_document_type,omitempty"`
// What format output should be. If unspecified, defaults to JSON.
ProcessedDocumentFormat GetProcessedDocumentRequest_ProcessedDocumentFormat `protobuf:"varint,3,opt,name=processed_document_format,json=processedDocumentFormat,proto3,enum=google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest_ProcessedDocumentFormat" json:"processed_document_format,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] method.
func (*GetProcessedDocumentRequest) Descriptor
func (*GetProcessedDocumentRequest) Descriptor() ([]byte, []int)Deprecated: Use GetProcessedDocumentRequest.ProtoReflect.Descriptor instead.
func (*GetProcessedDocumentRequest) GetName
func (x *GetProcessedDocumentRequest) GetName() stringfunc (*GetProcessedDocumentRequest) GetProcessedDocumentFormat
func (x *GetProcessedDocumentRequest) GetProcessedDocumentFormat() GetProcessedDocumentRequest_ProcessedDocumentFormatfunc (*GetProcessedDocumentRequest) GetProcessedDocumentType
func (x *GetProcessedDocumentRequest) GetProcessedDocumentType() GetProcessedDocumentRequest_ProcessedDocumentTypefunc (*GetProcessedDocumentRequest) ProtoMessage
func (*GetProcessedDocumentRequest) ProtoMessage()func (*GetProcessedDocumentRequest) ProtoReflect
func (x *GetProcessedDocumentRequest) ProtoReflect() protoreflect.Messagefunc (*GetProcessedDocumentRequest) Reset
func (x *GetProcessedDocumentRequest) Reset()func (*GetProcessedDocumentRequest) String
func (x *GetProcessedDocumentRequest) String() stringGetProcessedDocumentRequest_ProcessedDocumentFormat
type GetProcessedDocumentRequest_ProcessedDocumentFormat int32The format of the returned processed document. If unspecified, defaults to JSON.
GetProcessedDocumentRequest_PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED, GetProcessedDocumentRequest_JSON
const (
// Default value.
GetProcessedDocumentRequest_PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED GetProcessedDocumentRequest_ProcessedDocumentFormat = 0
// Output format is a JSON string representation of processed document.
GetProcessedDocumentRequest_JSON GetProcessedDocumentRequest_ProcessedDocumentFormat = 1
)func (GetProcessedDocumentRequest_ProcessedDocumentFormat) Descriptor
func (GetProcessedDocumentRequest_ProcessedDocumentFormat) Descriptor() protoreflect.EnumDescriptorfunc (GetProcessedDocumentRequest_ProcessedDocumentFormat) Enum
func (x GetProcessedDocumentRequest_ProcessedDocumentFormat) Enum() *GetProcessedDocumentRequest_ProcessedDocumentFormatfunc (GetProcessedDocumentRequest_ProcessedDocumentFormat) EnumDescriptor
func (GetProcessedDocumentRequest_ProcessedDocumentFormat) EnumDescriptor() ([]byte, []int)Deprecated: Use GetProcessedDocumentRequest_ProcessedDocumentFormat.Descriptor instead.
func (GetProcessedDocumentRequest_ProcessedDocumentFormat) Number
func (x GetProcessedDocumentRequest_ProcessedDocumentFormat) Number() protoreflect.EnumNumberfunc (GetProcessedDocumentRequest_ProcessedDocumentFormat) String
func (x GetProcessedDocumentRequest_ProcessedDocumentFormat) String() stringfunc (GetProcessedDocumentRequest_ProcessedDocumentFormat) Type
GetProcessedDocumentRequest_ProcessedDocumentType
type GetProcessedDocumentRequest_ProcessedDocumentType int32The type of processing to return in the response.
GetProcessedDocumentRequest_PROCESSED_DOCUMENT_TYPE_UNSPECIFIED, GetProcessedDocumentRequest_PARSED_DOCUMENT, GetProcessedDocumentRequest_CHUNKED_DOCUMENT, GetProcessedDocumentRequest_PNG_CONVERTED_DOCUMENT
const (
// Default value.
GetProcessedDocumentRequest_PROCESSED_DOCUMENT_TYPE_UNSPECIFIED GetProcessedDocumentRequest_ProcessedDocumentType = 0
// Available for all data store parsing configs.
GetProcessedDocumentRequest_PARSED_DOCUMENT GetProcessedDocumentRequest_ProcessedDocumentType = 1
// Only available if ChunkingConfig is enabled on the data store.
GetProcessedDocumentRequest_CHUNKED_DOCUMENT GetProcessedDocumentRequest_ProcessedDocumentType = 2
// Returns the converted Image bytes (as JPEG or PNG) if available.
GetProcessedDocumentRequest_PNG_CONVERTED_DOCUMENT GetProcessedDocumentRequest_ProcessedDocumentType = 3
)func (GetProcessedDocumentRequest_ProcessedDocumentType) Descriptor
func (GetProcessedDocumentRequest_ProcessedDocumentType) Descriptor() protoreflect.EnumDescriptorfunc (GetProcessedDocumentRequest_ProcessedDocumentType) Enum
func (x GetProcessedDocumentRequest_ProcessedDocumentType) Enum() *GetProcessedDocumentRequest_ProcessedDocumentTypefunc (GetProcessedDocumentRequest_ProcessedDocumentType) EnumDescriptor
func (GetProcessedDocumentRequest_ProcessedDocumentType) EnumDescriptor() ([]byte, []int)Deprecated: Use GetProcessedDocumentRequest_ProcessedDocumentType.Descriptor instead.
func (GetProcessedDocumentRequest_ProcessedDocumentType) Number
func (x GetProcessedDocumentRequest_ProcessedDocumentType) Number() protoreflect.EnumNumberfunc (GetProcessedDocumentRequest_ProcessedDocumentType) String
func (x GetProcessedDocumentRequest_ProcessedDocumentType) String() stringfunc (GetProcessedDocumentRequest_ProcessedDocumentType) Type
GetProjectRequest
type GetProjectRequest struct {
// Required. Full resource name of a
// [Project][google.cloud.discoveryengine.v1alpha.Project], such as
// `projects/{project_id_or_number}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [ProjectService.GetProject][google.cloud.discoveryengine.v1alpha.ProjectService.GetProject] method.
func (*GetProjectRequest) Descriptor
func (*GetProjectRequest) Descriptor() ([]byte, []int)Deprecated: Use GetProjectRequest.ProtoReflect.Descriptor instead.
func (*GetProjectRequest) GetName
func (x *GetProjectRequest) GetName() stringfunc (*GetProjectRequest) ProtoMessage
func (*GetProjectRequest) ProtoMessage()func (*GetProjectRequest) ProtoReflect
func (x *GetProjectRequest) ProtoReflect() protoreflect.Messagefunc (*GetProjectRequest) Reset
func (x *GetProjectRequest) Reset()func (*GetProjectRequest) String
func (x *GetProjectRequest) String() stringGetSampleQueryRequest
type GetSampleQueryRequest struct {
// Required. Full resource name of
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
//
// If the caller does not have permission to access the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
// of whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the requested
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] does not
// exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.GetSampleQuery] method.
func (*GetSampleQueryRequest) Descriptor
func (*GetSampleQueryRequest) Descriptor() ([]byte, []int)Deprecated: Use GetSampleQueryRequest.ProtoReflect.Descriptor instead.
func (*GetSampleQueryRequest) GetName
func (x *GetSampleQueryRequest) GetName() stringfunc (*GetSampleQueryRequest) ProtoMessage
func (*GetSampleQueryRequest) ProtoMessage()func (*GetSampleQueryRequest) ProtoReflect
func (x *GetSampleQueryRequest) ProtoReflect() protoreflect.Messagefunc (*GetSampleQueryRequest) Reset
func (x *GetSampleQueryRequest) Reset()func (*GetSampleQueryRequest) String
func (x *GetSampleQueryRequest) String() stringGetSampleQuerySetRequest
type GetSampleQuerySetRequest struct {
// Required. Full resource name of
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], such
// as
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
//
// If the caller does not have permission to access the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
// regardless of whether or not it exists, a PERMISSION_DENIED error is
// returned.
//
// If the requested
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] does
// not exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.GetSampleQuerySet] method.
func (*GetSampleQuerySetRequest) Descriptor
func (*GetSampleQuerySetRequest) Descriptor() ([]byte, []int)Deprecated: Use GetSampleQuerySetRequest.ProtoReflect.Descriptor instead.
func (*GetSampleQuerySetRequest) GetName
func (x *GetSampleQuerySetRequest) GetName() stringfunc (*GetSampleQuerySetRequest) ProtoMessage
func (*GetSampleQuerySetRequest) ProtoMessage()func (*GetSampleQuerySetRequest) ProtoReflect
func (x *GetSampleQuerySetRequest) ProtoReflect() protoreflect.Messagefunc (*GetSampleQuerySetRequest) Reset
func (x *GetSampleQuerySetRequest) Reset()func (*GetSampleQuerySetRequest) String
func (x *GetSampleQuerySetRequest) String() stringGetSchemaRequest
type GetSchemaRequest struct {
// Required. The full resource name of the schema, in the format of
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema] method.
func (*GetSchemaRequest) Descriptor
func (*GetSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use GetSchemaRequest.ProtoReflect.Descriptor instead.
func (*GetSchemaRequest) GetName
func (x *GetSchemaRequest) GetName() stringfunc (*GetSchemaRequest) ProtoMessage
func (*GetSchemaRequest) ProtoMessage()func (*GetSchemaRequest) ProtoReflect
func (x *GetSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*GetSchemaRequest) Reset
func (x *GetSchemaRequest) Reset()func (*GetSchemaRequest) String
func (x *GetSchemaRequest) String() stringGetServingConfigRequest
type GetServingConfigRequest struct {
// Required. The resource name of the ServingConfig to get. Format:
// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for GetServingConfig method.
func (*GetServingConfigRequest) Descriptor
func (*GetServingConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use GetServingConfigRequest.ProtoReflect.Descriptor instead.
func (*GetServingConfigRequest) GetName
func (x *GetServingConfigRequest) GetName() stringfunc (*GetServingConfigRequest) ProtoMessage
func (*GetServingConfigRequest) ProtoMessage()func (*GetServingConfigRequest) ProtoReflect
func (x *GetServingConfigRequest) ProtoReflect() protoreflect.Messagefunc (*GetServingConfigRequest) Reset
func (x *GetServingConfigRequest) Reset()func (*GetServingConfigRequest) String
func (x *GetServingConfigRequest) String() stringGetSessionRequest
type GetSessionRequest struct {
// Required. The resource name of the Session to get. Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. If set to true, the full session including all answer details
// will be returned.
IncludeAnswerDetails bool `protobuf:"varint,2,opt,name=include_answer_details,json=includeAnswerDetails,proto3" json:"include_answer_details,omitempty"`
// contains filtered or unexported fields
}Request for GetSession method.
func (*GetSessionRequest) Descriptor
func (*GetSessionRequest) Descriptor() ([]byte, []int)Deprecated: Use GetSessionRequest.ProtoReflect.Descriptor instead.
func (*GetSessionRequest) GetIncludeAnswerDetails
func (x *GetSessionRequest) GetIncludeAnswerDetails() boolfunc (*GetSessionRequest) GetName
func (x *GetSessionRequest) GetName() stringfunc (*GetSessionRequest) ProtoMessage
func (*GetSessionRequest) ProtoMessage()func (*GetSessionRequest) ProtoReflect
func (x *GetSessionRequest) ProtoReflect() protoreflect.Messagefunc (*GetSessionRequest) Reset
func (x *GetSessionRequest) Reset()func (*GetSessionRequest) String
func (x *GetSessionRequest) String() stringGetSiteSearchEngineRequest
type GetSiteSearchEngineRequest struct {
// Required. Resource name of
// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
// such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
//
// If the caller does not have permission to access the [SiteSearchEngine],
// regardless of whether or not it exists, a PERMISSION_DENIED error is
// returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetSiteSearchEngine] method.
func (*GetSiteSearchEngineRequest) Descriptor
func (*GetSiteSearchEngineRequest) Descriptor() ([]byte, []int)Deprecated: Use GetSiteSearchEngineRequest.ProtoReflect.Descriptor instead.
func (*GetSiteSearchEngineRequest) GetName
func (x *GetSiteSearchEngineRequest) GetName() stringfunc (*GetSiteSearchEngineRequest) ProtoMessage
func (*GetSiteSearchEngineRequest) ProtoMessage()func (*GetSiteSearchEngineRequest) ProtoReflect
func (x *GetSiteSearchEngineRequest) ProtoReflect() protoreflect.Messagefunc (*GetSiteSearchEngineRequest) Reset
func (x *GetSiteSearchEngineRequest) Reset()func (*GetSiteSearchEngineRequest) String
func (x *GetSiteSearchEngineRequest) String() stringGetTargetSiteRequest
type GetTargetSiteRequest struct {
// Required. Full resource name of
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
//
// If the caller does not have permission to access the
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], regardless
// of whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the requested
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] does not
// exist, a NOT_FOUND error is returned.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetTargetSite] method.
func (*GetTargetSiteRequest) Descriptor
func (*GetTargetSiteRequest) Descriptor() ([]byte, []int)Deprecated: Use GetTargetSiteRequest.ProtoReflect.Descriptor instead.
func (*GetTargetSiteRequest) GetName
func (x *GetTargetSiteRequest) GetName() stringfunc (*GetTargetSiteRequest) ProtoMessage
func (*GetTargetSiteRequest) ProtoMessage()func (*GetTargetSiteRequest) ProtoReflect
func (x *GetTargetSiteRequest) ProtoReflect() protoreflect.Messagefunc (*GetTargetSiteRequest) Reset
func (x *GetTargetSiteRequest) Reset()func (*GetTargetSiteRequest) String
func (x *GetTargetSiteRequest) String() stringGetUriPatternDocumentDataRequest
type GetUriPatternDocumentDataRequest struct {
// Required. Full resource name of the
// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
// such as
// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] method.
func (*GetUriPatternDocumentDataRequest) Descriptor
func (*GetUriPatternDocumentDataRequest) Descriptor() ([]byte, []int)Deprecated: Use GetUriPatternDocumentDataRequest.ProtoReflect.Descriptor instead.
func (*GetUriPatternDocumentDataRequest) GetSiteSearchEngine
func (x *GetUriPatternDocumentDataRequest) GetSiteSearchEngine() stringfunc (*GetUriPatternDocumentDataRequest) ProtoMessage
func (*GetUriPatternDocumentDataRequest) ProtoMessage()func (*GetUriPatternDocumentDataRequest) ProtoReflect
func (x *GetUriPatternDocumentDataRequest) ProtoReflect() protoreflect.Messagefunc (*GetUriPatternDocumentDataRequest) Reset
func (x *GetUriPatternDocumentDataRequest) Reset()func (*GetUriPatternDocumentDataRequest) String
func (x *GetUriPatternDocumentDataRequest) String() stringGetUriPatternDocumentDataResponse
type GetUriPatternDocumentDataResponse struct {
// Document data keyed by URI pattern. For example:
//
// document_data_map = {
// "www.url1.com/*": {
// "Categories": ["category1", "category2"]
// },
// "www.url2.com/*": {
// "Categories": ["category3"]
// }
// }
DocumentDataMap map[string]*structpb.Struct `protobuf:"bytes,1,rep,name=document_data_map,json=documentDataMap,proto3" json:"document_data_map,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Response message for [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] method.
func (*GetUriPatternDocumentDataResponse) Descriptor
func (*GetUriPatternDocumentDataResponse) Descriptor() ([]byte, []int)Deprecated: Use GetUriPatternDocumentDataResponse.ProtoReflect.Descriptor instead.
func (*GetUriPatternDocumentDataResponse) GetDocumentDataMap
func (x *GetUriPatternDocumentDataResponse) GetDocumentDataMap() map[string]*structpb.Structfunc (*GetUriPatternDocumentDataResponse) ProtoMessage
func (*GetUriPatternDocumentDataResponse) ProtoMessage()func (*GetUriPatternDocumentDataResponse) ProtoReflect
func (x *GetUriPatternDocumentDataResponse) ProtoReflect() protoreflect.Messagefunc (*GetUriPatternDocumentDataResponse) Reset
func (x *GetUriPatternDocumentDataResponse) Reset()func (*GetUriPatternDocumentDataResponse) String
func (x *GetUriPatternDocumentDataResponse) String() stringGroundedGenerationServiceClient
type GroundedGenerationServiceClient interface {
// Performs a grounding check.
CheckGrounding(ctx context.Context, in *CheckGroundingRequest, opts ...grpc.CallOption) (*CheckGroundingResponse, error)
}GroundedGenerationServiceClient is the client API for GroundedGenerationService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewGroundedGenerationServiceClient
func NewGroundedGenerationServiceClient(cc grpc.ClientConnInterface) GroundedGenerationServiceClientGroundedGenerationServiceServer
type GroundedGenerationServiceServer interface {
// Performs a grounding check.
CheckGrounding(context.Context, *CheckGroundingRequest) (*CheckGroundingResponse, error)
}GroundedGenerationServiceServer is the server API for GroundedGenerationService service. All implementations should embed UnimplementedGroundedGenerationServiceServer for forward compatibility
GroundingFact
type GroundingFact struct {
// Text content of the fact. Can be at most 10K characters long.
FactText string `protobuf:"bytes,1,opt,name=fact_text,json=factText,proto3" json:"fact_text,omitempty"`
// Attributes associated with the fact.
// Common attributes include `source` (indicating where the fact was sourced
// from), `author` (indicating the author of the fact), and so on.
Attributes map[string]string `protobuf:"bytes,2,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Grounding Fact.
func (*GroundingFact) Descriptor
func (*GroundingFact) Descriptor() ([]byte, []int)Deprecated: Use GroundingFact.ProtoReflect.Descriptor instead.
func (*GroundingFact) GetAttributes
func (x *GroundingFact) GetAttributes() map[string]stringfunc (*GroundingFact) GetFactText
func (x *GroundingFact) GetFactText() stringfunc (*GroundingFact) ProtoMessage
func (*GroundingFact) ProtoMessage()func (*GroundingFact) ProtoReflect
func (x *GroundingFact) ProtoReflect() protoreflect.Messagefunc (*GroundingFact) Reset
func (x *GroundingFact) Reset()func (*GroundingFact) String
func (x *GroundingFact) String() stringGuidedSearchSpec
type GuidedSearchSpec struct {
// Whether or not to enable and include refinement attributes in gudied search
// result.
EnableRefinementAttributes bool `protobuf:"varint,1,opt,name=enable_refinement_attributes,json=enableRefinementAttributes,proto3" json:"enable_refinement_attributes,omitempty"`
// Whether or not to enable and include related questions in search response.
EnableRelatedQuestions bool `protobuf:"varint,2,opt,name=enable_related_questions,json=enableRelatedQuestions,proto3" json:"enable_related_questions,omitempty"`
// Max number of related questions to be returned. The valid range is [1, 5].
// If enable_related_questions is true, the default value is 3.
MaxRelatedQuestions int32 `protobuf:"varint,3,opt,name=max_related_questions,json=maxRelatedQuestions,proto3" json:"max_related_questions,omitempty"`
// contains filtered or unexported fields
}Defines guided search spec.
func (*GuidedSearchSpec) Descriptor
func (*GuidedSearchSpec) Descriptor() ([]byte, []int)Deprecated: Use GuidedSearchSpec.ProtoReflect.Descriptor instead.
func (*GuidedSearchSpec) GetEnableRefinementAttributes
func (x *GuidedSearchSpec) GetEnableRefinementAttributes() boolfunc (*GuidedSearchSpec) GetEnableRelatedQuestions
func (x *GuidedSearchSpec) GetEnableRelatedQuestions() boolfunc (*GuidedSearchSpec) GetMaxRelatedQuestions
func (x *GuidedSearchSpec) GetMaxRelatedQuestions() int32func (*GuidedSearchSpec) ProtoMessage
func (*GuidedSearchSpec) ProtoMessage()func (*GuidedSearchSpec) ProtoReflect
func (x *GuidedSearchSpec) ProtoReflect() protoreflect.Messagefunc (*GuidedSearchSpec) Reset
func (x *GuidedSearchSpec) Reset()func (*GuidedSearchSpec) String
func (x *GuidedSearchSpec) String() stringIdpConfig
type IdpConfig struct {
// Identity provider type configured.
IdpType IdpConfig_IdpType `protobuf:"varint,1,opt,name=idp_type,json=idpType,proto3,enum=google.cloud.discoveryengine.v1alpha.IdpConfig_IdpType" json:"idp_type,omitempty"`
// External Identity provider config.
ExternalIdpConfig *IdpConfig_ExternalIdpConfig `protobuf:"bytes,2,opt,name=external_idp_config,json=externalIdpConfig,proto3" json:"external_idp_config,omitempty"`
// contains filtered or unexported fields
}Identity Provider Config.
func (*IdpConfig) Descriptor
Deprecated: Use IdpConfig.ProtoReflect.Descriptor instead.
func (*IdpConfig) GetExternalIdpConfig
func (x *IdpConfig) GetExternalIdpConfig() *IdpConfig_ExternalIdpConfigfunc (*IdpConfig) GetIdpType
func (x *IdpConfig) GetIdpType() IdpConfig_IdpTypefunc (*IdpConfig) ProtoMessage
func (*IdpConfig) ProtoMessage()func (*IdpConfig) ProtoReflect
func (x *IdpConfig) ProtoReflect() protoreflect.Messagefunc (*IdpConfig) Reset
func (x *IdpConfig) Reset()func (*IdpConfig) String
IdpConfig_ExternalIdpConfig
type IdpConfig_ExternalIdpConfig struct {
// Workforce pool name.
// Example: "locations/global/workforcePools/pool_id"
WorkforcePoolName string `protobuf:"bytes,1,opt,name=workforce_pool_name,json=workforcePoolName,proto3" json:"workforce_pool_name,omitempty"`
// contains filtered or unexported fields
}Third party IDP Config.
func (*IdpConfig_ExternalIdpConfig) Descriptor
func (*IdpConfig_ExternalIdpConfig) Descriptor() ([]byte, []int)Deprecated: Use IdpConfig_ExternalIdpConfig.ProtoReflect.Descriptor instead.
func (*IdpConfig_ExternalIdpConfig) GetWorkforcePoolName
func (x *IdpConfig_ExternalIdpConfig) GetWorkforcePoolName() stringfunc (*IdpConfig_ExternalIdpConfig) ProtoMessage
func (*IdpConfig_ExternalIdpConfig) ProtoMessage()func (*IdpConfig_ExternalIdpConfig) ProtoReflect
func (x *IdpConfig_ExternalIdpConfig) ProtoReflect() protoreflect.Messagefunc (*IdpConfig_ExternalIdpConfig) Reset
func (x *IdpConfig_ExternalIdpConfig) Reset()func (*IdpConfig_ExternalIdpConfig) String
func (x *IdpConfig_ExternalIdpConfig) String() stringIdpConfig_IdpType
type IdpConfig_IdpType int32Identity Provider Type.
IdpConfig_IDP_TYPE_UNSPECIFIED, IdpConfig_GSUITE, IdpConfig_THIRD_PARTY
const (
// Default value. ACL search not enabled.
IdpConfig_IDP_TYPE_UNSPECIFIED IdpConfig_IdpType = 0
// Google 1P provider.
IdpConfig_GSUITE IdpConfig_IdpType = 1
// Third party provider.
IdpConfig_THIRD_PARTY IdpConfig_IdpType = 2
)func (IdpConfig_IdpType) Descriptor
func (IdpConfig_IdpType) Descriptor() protoreflect.EnumDescriptorfunc (IdpConfig_IdpType) Enum
func (x IdpConfig_IdpType) Enum() *IdpConfig_IdpTypefunc (IdpConfig_IdpType) EnumDescriptor
func (IdpConfig_IdpType) EnumDescriptor() ([]byte, []int)Deprecated: Use IdpConfig_IdpType.Descriptor instead.
func (IdpConfig_IdpType) Number
func (x IdpConfig_IdpType) Number() protoreflect.EnumNumberfunc (IdpConfig_IdpType) String
func (x IdpConfig_IdpType) String() stringfunc (IdpConfig_IdpType) Type
func (IdpConfig_IdpType) Type() protoreflect.EnumTypeImageCharacteristics
type ImageCharacteristics struct {
// Output only. Image width in pixels.
Width int32 `protobuf:"varint,1,opt,name=width,proto3" json:"width,omitempty"`
// Output only. Image height in pixels.
Height int32 `protobuf:"varint,2,opt,name=height,proto3" json:"height,omitempty"`
// Output only. Color space of the image (e.g., "RGB", "CMYK", "Grayscale").
ColorSpace ImageCharacteristics_ColorSpace `protobuf:"varint,3,opt,name=color_space,json=colorSpace,proto3,enum=google.cloud.discoveryengine.v1alpha.ImageCharacteristics_ColorSpace" json:"color_space,omitempty"`
// Output only. Bit depth of the image (e.g., 8-bit, 16-bit).
BitDepth int32 `protobuf:"varint,4,opt,name=bit_depth,json=bitDepth,proto3" json:"bit_depth,omitempty"`
// contains filtered or unexported fields
}Standard characteristics of an image media view.
func (*ImageCharacteristics) Descriptor
func (*ImageCharacteristics) Descriptor() ([]byte, []int)Deprecated: Use ImageCharacteristics.ProtoReflect.Descriptor instead.
func (*ImageCharacteristics) GetBitDepth
func (x *ImageCharacteristics) GetBitDepth() int32func (*ImageCharacteristics) GetColorSpace
func (x *ImageCharacteristics) GetColorSpace() ImageCharacteristics_ColorSpacefunc (*ImageCharacteristics) GetHeight
func (x *ImageCharacteristics) GetHeight() int32func (*ImageCharacteristics) GetWidth
func (x *ImageCharacteristics) GetWidth() int32func (*ImageCharacteristics) ProtoMessage
func (*ImageCharacteristics) ProtoMessage()func (*ImageCharacteristics) ProtoReflect
func (x *ImageCharacteristics) ProtoReflect() protoreflect.Messagefunc (*ImageCharacteristics) Reset
func (x *ImageCharacteristics) Reset()func (*ImageCharacteristics) String
func (x *ImageCharacteristics) String() stringImageCharacteristics_ColorSpace
type ImageCharacteristics_ColorSpace int32Possible color spaces of an image (e.g., "RGB", "CMYK", "Grayscale").
ImageCharacteristics_COLOR_SPACE_UNSPECIFIED, ImageCharacteristics_RGB, ImageCharacteristics_CMYK, ImageCharacteristics_GRAYSCALE, ImageCharacteristics_YUV, ImageCharacteristics_OTHER_COLOR_SPACE
const (
// Default value. Unknown color space.
ImageCharacteristics_COLOR_SPACE_UNSPECIFIED ImageCharacteristics_ColorSpace = 0
// Red, green, blue colorspace.
ImageCharacteristics_RGB ImageCharacteristics_ColorSpace = 1
// Cyan, magenta, yellow, and black colorspace.
ImageCharacteristics_CMYK ImageCharacteristics_ColorSpace = 2
// Grayscale colorspace.
ImageCharacteristics_GRAYSCALE ImageCharacteristics_ColorSpace = 3
// YUV colorspace.
ImageCharacteristics_YUV ImageCharacteristics_ColorSpace = 4
// Other colorspace.
ImageCharacteristics_OTHER_COLOR_SPACE ImageCharacteristics_ColorSpace = 5
)func (ImageCharacteristics_ColorSpace) Descriptor
func (ImageCharacteristics_ColorSpace) Descriptor() protoreflect.EnumDescriptorfunc (ImageCharacteristics_ColorSpace) Enum
func (x ImageCharacteristics_ColorSpace) Enum() *ImageCharacteristics_ColorSpacefunc (ImageCharacteristics_ColorSpace) EnumDescriptor
func (ImageCharacteristics_ColorSpace) EnumDescriptor() ([]byte, []int)Deprecated: Use ImageCharacteristics_ColorSpace.Descriptor instead.
func (ImageCharacteristics_ColorSpace) Number
func (x ImageCharacteristics_ColorSpace) Number() protoreflect.EnumNumberfunc (ImageCharacteristics_ColorSpace) String
func (x ImageCharacteristics_ColorSpace) String() stringfunc (ImageCharacteristics_ColorSpace) Type
func (ImageCharacteristics_ColorSpace) Type() protoreflect.EnumTypeImportCompletionSuggestionsMetadata
type ImportCompletionSuggestionsMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Count of
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
// successfully imported.
SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
// Count of
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
// that failed to be imported.
FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*ImportCompletionSuggestionsMetadata) Descriptor
func (*ImportCompletionSuggestionsMetadata) Descriptor() ([]byte, []int)Deprecated: Use ImportCompletionSuggestionsMetadata.ProtoReflect.Descriptor instead.
func (*ImportCompletionSuggestionsMetadata) GetCreateTime
func (x *ImportCompletionSuggestionsMetadata) GetCreateTime() *timestamppb.Timestampfunc (*ImportCompletionSuggestionsMetadata) GetFailureCount
func (x *ImportCompletionSuggestionsMetadata) GetFailureCount() int64func (*ImportCompletionSuggestionsMetadata) GetSuccessCount
func (x *ImportCompletionSuggestionsMetadata) GetSuccessCount() int64func (*ImportCompletionSuggestionsMetadata) GetUpdateTime
func (x *ImportCompletionSuggestionsMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*ImportCompletionSuggestionsMetadata) ProtoMessage
func (*ImportCompletionSuggestionsMetadata) ProtoMessage()func (*ImportCompletionSuggestionsMetadata) ProtoReflect
func (x *ImportCompletionSuggestionsMetadata) ProtoReflect() protoreflect.Messagefunc (*ImportCompletionSuggestionsMetadata) Reset
func (x *ImportCompletionSuggestionsMetadata) Reset()func (*ImportCompletionSuggestionsMetadata) String
func (x *ImportCompletionSuggestionsMetadata) String() stringImportCompletionSuggestionsRequest
type ImportCompletionSuggestionsRequest struct {
// The source of the autocomplete suggestions.
//
// Types that are valid to be assigned to Source:
//
// *ImportCompletionSuggestionsRequest_InlineSource_
// *ImportCompletionSuggestionsRequest_GcsSource
// *ImportCompletionSuggestionsRequest_BigquerySource
Source isImportCompletionSuggestionsRequest_Source `protobuf_oneof:"source"`
// Required. The parent data store resource name for which to import customer
// autocomplete suggestions.
//
// Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The desired location of errors incurred during the Import.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// contains filtered or unexported fields
}Request message for [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] method.
func (*ImportCompletionSuggestionsRequest) Descriptor
func (*ImportCompletionSuggestionsRequest) Descriptor() ([]byte, []int)Deprecated: Use ImportCompletionSuggestionsRequest.ProtoReflect.Descriptor instead.
func (*ImportCompletionSuggestionsRequest) GetBigquerySource
func (x *ImportCompletionSuggestionsRequest) GetBigquerySource() *BigQuerySourcefunc (*ImportCompletionSuggestionsRequest) GetErrorConfig
func (x *ImportCompletionSuggestionsRequest) GetErrorConfig() *ImportErrorConfigfunc (*ImportCompletionSuggestionsRequest) GetGcsSource
func (x *ImportCompletionSuggestionsRequest) GetGcsSource() *GcsSourcefunc (*ImportCompletionSuggestionsRequest) GetInlineSource
func (x *ImportCompletionSuggestionsRequest) GetInlineSource() *ImportCompletionSuggestionsRequest_InlineSourcefunc (*ImportCompletionSuggestionsRequest) GetParent
func (x *ImportCompletionSuggestionsRequest) GetParent() stringfunc (*ImportCompletionSuggestionsRequest) GetSource
func (x *ImportCompletionSuggestionsRequest) GetSource() isImportCompletionSuggestionsRequest_Sourcefunc (*ImportCompletionSuggestionsRequest) ProtoMessage
func (*ImportCompletionSuggestionsRequest) ProtoMessage()func (*ImportCompletionSuggestionsRequest) ProtoReflect
func (x *ImportCompletionSuggestionsRequest) ProtoReflect() protoreflect.Messagefunc (*ImportCompletionSuggestionsRequest) Reset
func (x *ImportCompletionSuggestionsRequest) Reset()func (*ImportCompletionSuggestionsRequest) String
func (x *ImportCompletionSuggestionsRequest) String() stringImportCompletionSuggestionsRequest_BigquerySource
type ImportCompletionSuggestionsRequest_BigquerySource struct {
// BigQuery input source.
BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}ImportCompletionSuggestionsRequest_GcsSource
type ImportCompletionSuggestionsRequest_GcsSource struct {
// Cloud Storage location for the input content.
GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}ImportCompletionSuggestionsRequest_InlineSource
type ImportCompletionSuggestionsRequest_InlineSource struct {
// Required. A list of all denylist entries to import. Max of 1000 items.
Suggestions []*CompletionSuggestion `protobuf:"bytes,1,rep,name=suggestions,proto3" json:"suggestions,omitempty"`
// contains filtered or unexported fields
}The inline source for CompletionSuggestions.
func (*ImportCompletionSuggestionsRequest_InlineSource) Descriptor
func (*ImportCompletionSuggestionsRequest_InlineSource) Descriptor() ([]byte, []int)Deprecated: Use ImportCompletionSuggestionsRequest_InlineSource.ProtoReflect.Descriptor instead.
func (*ImportCompletionSuggestionsRequest_InlineSource) GetSuggestions
func (x *ImportCompletionSuggestionsRequest_InlineSource) GetSuggestions() []*CompletionSuggestionfunc (*ImportCompletionSuggestionsRequest_InlineSource) ProtoMessage
func (*ImportCompletionSuggestionsRequest_InlineSource) ProtoMessage()func (*ImportCompletionSuggestionsRequest_InlineSource) ProtoReflect
func (x *ImportCompletionSuggestionsRequest_InlineSource) ProtoReflect() protoreflect.Messagefunc (*ImportCompletionSuggestionsRequest_InlineSource) Reset
func (x *ImportCompletionSuggestionsRequest_InlineSource) Reset()func (*ImportCompletionSuggestionsRequest_InlineSource) String
func (x *ImportCompletionSuggestionsRequest_InlineSource) String() stringImportCompletionSuggestionsRequest_InlineSource_
type ImportCompletionSuggestionsRequest_InlineSource_ struct {
// The Inline source for suggestion entries.
InlineSource *ImportCompletionSuggestionsRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}ImportCompletionSuggestionsResponse
type ImportCompletionSuggestionsResponse struct {
// A sample of errors encountered while processing the request.
ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// The desired location of errors incurred during the Import.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// contains filtered or unexported fields
}Response of the [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.
func (*ImportCompletionSuggestionsResponse) Descriptor
func (*ImportCompletionSuggestionsResponse) Descriptor() ([]byte, []int)Deprecated: Use ImportCompletionSuggestionsResponse.ProtoReflect.Descriptor instead.
func (*ImportCompletionSuggestionsResponse) GetErrorConfig
func (x *ImportCompletionSuggestionsResponse) GetErrorConfig() *ImportErrorConfigfunc (*ImportCompletionSuggestionsResponse) GetErrorSamples
func (x *ImportCompletionSuggestionsResponse) GetErrorSamples() []*status.Statusfunc (*ImportCompletionSuggestionsResponse) ProtoMessage
func (*ImportCompletionSuggestionsResponse) ProtoMessage()func (*ImportCompletionSuggestionsResponse) ProtoReflect
func (x *ImportCompletionSuggestionsResponse) ProtoReflect() protoreflect.Messagefunc (*ImportCompletionSuggestionsResponse) Reset
func (x *ImportCompletionSuggestionsResponse) Reset()func (*ImportCompletionSuggestionsResponse) String
func (x *ImportCompletionSuggestionsResponse) String() stringImportDocumentsMetadata
type ImportDocumentsMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Count of entries that were processed successfully.
SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
// Count of entries that encountered errors while processing.
FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
// Total count of entries that were processed.
TotalCount int64 `protobuf:"varint,5,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
func (*ImportDocumentsMetadata) Descriptor
func (*ImportDocumentsMetadata) Descriptor() ([]byte, []int)Deprecated: Use ImportDocumentsMetadata.ProtoReflect.Descriptor instead.
func (*ImportDocumentsMetadata) GetCreateTime
func (x *ImportDocumentsMetadata) GetCreateTime() *timestamppb.Timestampfunc (*ImportDocumentsMetadata) GetFailureCount
func (x *ImportDocumentsMetadata) GetFailureCount() int64func (*ImportDocumentsMetadata) GetSuccessCount
func (x *ImportDocumentsMetadata) GetSuccessCount() int64func (*ImportDocumentsMetadata) GetTotalCount
func (x *ImportDocumentsMetadata) GetTotalCount() int64func (*ImportDocumentsMetadata) GetUpdateTime
func (x *ImportDocumentsMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*ImportDocumentsMetadata) ProtoMessage
func (*ImportDocumentsMetadata) ProtoMessage()func (*ImportDocumentsMetadata) ProtoReflect
func (x *ImportDocumentsMetadata) ProtoReflect() protoreflect.Messagefunc (*ImportDocumentsMetadata) Reset
func (x *ImportDocumentsMetadata) Reset()func (*ImportDocumentsMetadata) String
func (x *ImportDocumentsMetadata) String() stringImportDocumentsRequest
type ImportDocumentsRequest struct {
// Required. The source of the input.
//
// Types that are valid to be assigned to Source:
//
// *ImportDocumentsRequest_InlineSource_
// *ImportDocumentsRequest_GcsSource
// *ImportDocumentsRequest_BigquerySource
// *ImportDocumentsRequest_FhirStoreSource
// *ImportDocumentsRequest_SpannerSource
// *ImportDocumentsRequest_CloudSqlSource
// *ImportDocumentsRequest_FirestoreSource
// *ImportDocumentsRequest_AlloyDbSource
// *ImportDocumentsRequest_BigtableSource
Source isImportDocumentsRequest_Source `protobuf_oneof:"source"`
// Required. The parent branch resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
// Requires create/update permission.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The desired location of errors incurred during the Import.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// The mode of reconciliation between existing documents and the documents to
// be imported. Defaults to
// [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
ReconciliationMode ImportDocumentsRequest_ReconciliationMode `protobuf:"varint,6,opt,name=reconciliation_mode,json=reconciliationMode,proto3,enum=google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest_ReconciliationMode" json:"reconciliation_mode,omitempty"`
// Indicates which fields in the provided imported documents to update. If
// not set, the default is to update all fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,7,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Whether to automatically generate IDs for the documents if absent.
//
// If set to `true`,
// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s are
// automatically generated based on the hash of the payload, where IDs may not
// be consistent during multiple imports. In which case
// [ReconciliationMode.FULL][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.FULL]
// is highly recommended to avoid duplicate contents. If unset or set to
// `false`, [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s
// have to be specified using
// [id_field][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.id_field],
// otherwise, documents without IDs fail to be imported.
//
// Supported data sources:
//
// * [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource].
// [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
// * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
// * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
// * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
// * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
// * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
AutoGenerateIds bool `protobuf:"varint,8,opt,name=auto_generate_ids,json=autoGenerateIds,proto3" json:"auto_generate_ids,omitempty"`
// The field indicates the ID field or column to be used as unique IDs of
// the documents.
//
// For [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource] it is the
// key of the JSON field. For instance, `my_id` for JSON `{"my_id":
// "some_uuid"}`. For others, it may be the column name of the table where the
// unique ids are stored.
//
// The values of the JSON field or the table column are used as the
// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s. The JSON
// field or the table column must be of string type, and the values must be
// set as valid strings conform to
// [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
// Otherwise, documents without valid IDs fail to be imported.
//
// Only set this field when
// [auto_generate_ids][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.auto_generate_ids]
// is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
//
// If it is unset, a default value `_id` is used when importing from the
// allowed data sources.
//
// Supported data sources:
//
// * [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource].
// [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
// * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
// [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
// must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
// * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
// * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
// * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
// * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
IdField string `protobuf:"bytes,9,opt,name=id_field,json=idField,proto3" json:"id_field,omitempty"`
// contains filtered or unexported fields
}Request message for Import methods.
func (*ImportDocumentsRequest) Descriptor
func (*ImportDocumentsRequest) Descriptor() ([]byte, []int)Deprecated: Use ImportDocumentsRequest.ProtoReflect.Descriptor instead.
func (*ImportDocumentsRequest) GetAlloyDbSource
func (x *ImportDocumentsRequest) GetAlloyDbSource() *AlloyDbSourcefunc (*ImportDocumentsRequest) GetAutoGenerateIds
func (x *ImportDocumentsRequest) GetAutoGenerateIds() boolfunc (*ImportDocumentsRequest) GetBigquerySource
func (x *ImportDocumentsRequest) GetBigquerySource() *BigQuerySourcefunc (*ImportDocumentsRequest) GetBigtableSource
func (x *ImportDocumentsRequest) GetBigtableSource() *BigtableSourcefunc (*ImportDocumentsRequest) GetCloudSqlSource
func (x *ImportDocumentsRequest) GetCloudSqlSource() *CloudSqlSourcefunc (*ImportDocumentsRequest) GetErrorConfig
func (x *ImportDocumentsRequest) GetErrorConfig() *ImportErrorConfigfunc (*ImportDocumentsRequest) GetFhirStoreSource
func (x *ImportDocumentsRequest) GetFhirStoreSource() *FhirStoreSourcefunc (*ImportDocumentsRequest) GetFirestoreSource
func (x *ImportDocumentsRequest) GetFirestoreSource() *FirestoreSourcefunc (*ImportDocumentsRequest) GetGcsSource
func (x *ImportDocumentsRequest) GetGcsSource() *GcsSourcefunc (*ImportDocumentsRequest) GetIdField
func (x *ImportDocumentsRequest) GetIdField() stringfunc (*ImportDocumentsRequest) GetInlineSource
func (x *ImportDocumentsRequest) GetInlineSource() *ImportDocumentsRequest_InlineSourcefunc (*ImportDocumentsRequest) GetParent
func (x *ImportDocumentsRequest) GetParent() stringfunc (*ImportDocumentsRequest) GetReconciliationMode
func (x *ImportDocumentsRequest) GetReconciliationMode() ImportDocumentsRequest_ReconciliationModefunc (*ImportDocumentsRequest) GetSource
func (x *ImportDocumentsRequest) GetSource() isImportDocumentsRequest_Sourcefunc (*ImportDocumentsRequest) GetSpannerSource
func (x *ImportDocumentsRequest) GetSpannerSource() *SpannerSourcefunc (*ImportDocumentsRequest) GetUpdateMask
func (x *ImportDocumentsRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*ImportDocumentsRequest) ProtoMessage
func (*ImportDocumentsRequest) ProtoMessage()func (*ImportDocumentsRequest) ProtoReflect
func (x *ImportDocumentsRequest) ProtoReflect() protoreflect.Messagefunc (*ImportDocumentsRequest) Reset
func (x *ImportDocumentsRequest) Reset()func (*ImportDocumentsRequest) String
func (x *ImportDocumentsRequest) String() stringImportDocumentsRequest_AlloyDbSource
type ImportDocumentsRequest_AlloyDbSource struct {
// AlloyDB input source.
AlloyDbSource *AlloyDbSource `protobuf:"bytes,14,opt,name=alloy_db_source,json=alloyDbSource,proto3,oneof"`
}ImportDocumentsRequest_BigquerySource
type ImportDocumentsRequest_BigquerySource struct {
// BigQuery input source.
BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}ImportDocumentsRequest_BigtableSource
type ImportDocumentsRequest_BigtableSource struct {
// Cloud Bigtable input source.
BigtableSource *BigtableSource `protobuf:"bytes,15,opt,name=bigtable_source,json=bigtableSource,proto3,oneof"`
}ImportDocumentsRequest_CloudSqlSource
type ImportDocumentsRequest_CloudSqlSource struct {
// Cloud SQL input source.
CloudSqlSource *CloudSqlSource `protobuf:"bytes,12,opt,name=cloud_sql_source,json=cloudSqlSource,proto3,oneof"`
}ImportDocumentsRequest_FhirStoreSource
type ImportDocumentsRequest_FhirStoreSource struct {
// FhirStore input source.
FhirStoreSource *FhirStoreSource `protobuf:"bytes,10,opt,name=fhir_store_source,json=fhirStoreSource,proto3,oneof"`
}ImportDocumentsRequest_FirestoreSource
type ImportDocumentsRequest_FirestoreSource struct {
// Firestore input source.
FirestoreSource *FirestoreSource `protobuf:"bytes,13,opt,name=firestore_source,json=firestoreSource,proto3,oneof"`
}ImportDocumentsRequest_GcsSource
type ImportDocumentsRequest_GcsSource struct {
// Cloud Storage location for the input content.
GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}ImportDocumentsRequest_InlineSource
type ImportDocumentsRequest_InlineSource struct {
// Required. A list of documents to update/create. Each document must have a
// valid [Document.id][google.cloud.discoveryengine.v1alpha.Document.id].
// Recommended max of 100 items.
Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
// contains filtered or unexported fields
}The inline source for the input config for ImportDocuments method.
func (*ImportDocumentsRequest_InlineSource) Descriptor
func (*ImportDocumentsRequest_InlineSource) Descriptor() ([]byte, []int)Deprecated: Use ImportDocumentsRequest_InlineSource.ProtoReflect.Descriptor instead.
func (*ImportDocumentsRequest_InlineSource) GetDocuments
func (x *ImportDocumentsRequest_InlineSource) GetDocuments() []*Documentfunc (*ImportDocumentsRequest_InlineSource) ProtoMessage
func (*ImportDocumentsRequest_InlineSource) ProtoMessage()func (*ImportDocumentsRequest_InlineSource) ProtoReflect
func (x *ImportDocumentsRequest_InlineSource) ProtoReflect() protoreflect.Messagefunc (*ImportDocumentsRequest_InlineSource) Reset
func (x *ImportDocumentsRequest_InlineSource) Reset()func (*ImportDocumentsRequest_InlineSource) String
func (x *ImportDocumentsRequest_InlineSource) String() stringImportDocumentsRequest_InlineSource_
type ImportDocumentsRequest_InlineSource_ struct {
// The Inline source for the input content for documents.
InlineSource *ImportDocumentsRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}ImportDocumentsRequest_ReconciliationMode
type ImportDocumentsRequest_ReconciliationMode int32Indicates how imported documents are reconciled with the existing documents created or imported before.
ImportDocumentsRequest_RECONCILIATION_MODE_UNSPECIFIED, ImportDocumentsRequest_INCREMENTAL, ImportDocumentsRequest_FULL
const (
// Defaults to `INCREMENTAL`.
ImportDocumentsRequest_RECONCILIATION_MODE_UNSPECIFIED ImportDocumentsRequest_ReconciliationMode = 0
// Inserts new documents or updates existing documents.
ImportDocumentsRequest_INCREMENTAL ImportDocumentsRequest_ReconciliationMode = 1
// Calculates diff and replaces the entire document dataset. Existing
// documents may be deleted if they are not present in the source location.
ImportDocumentsRequest_FULL ImportDocumentsRequest_ReconciliationMode = 2
)func (ImportDocumentsRequest_ReconciliationMode) Descriptor
func (ImportDocumentsRequest_ReconciliationMode) Descriptor() protoreflect.EnumDescriptorfunc (ImportDocumentsRequest_ReconciliationMode) Enum
func (x ImportDocumentsRequest_ReconciliationMode) Enum() *ImportDocumentsRequest_ReconciliationModefunc (ImportDocumentsRequest_ReconciliationMode) EnumDescriptor
func (ImportDocumentsRequest_ReconciliationMode) EnumDescriptor() ([]byte, []int)Deprecated: Use ImportDocumentsRequest_ReconciliationMode.Descriptor instead.
func (ImportDocumentsRequest_ReconciliationMode) Number
func (x ImportDocumentsRequest_ReconciliationMode) Number() protoreflect.EnumNumberfunc (ImportDocumentsRequest_ReconciliationMode) String
func (x ImportDocumentsRequest_ReconciliationMode) String() stringfunc (ImportDocumentsRequest_ReconciliationMode) Type
func (ImportDocumentsRequest_ReconciliationMode) Type() protoreflect.EnumTypeImportDocumentsRequest_SpannerSource
type ImportDocumentsRequest_SpannerSource struct {
// Spanner input source.
SpannerSource *SpannerSource `protobuf:"bytes,11,opt,name=spanner_source,json=spannerSource,proto3,oneof"`
}ImportDocumentsResponse
type ImportDocumentsResponse struct {
// A sample of errors encountered while processing the request.
ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// Echoes the destination for the complete errors in the request if set.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// contains filtered or unexported fields
}Response of the [ImportDocumentsRequest][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest]. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
func (*ImportDocumentsResponse) Descriptor
func (*ImportDocumentsResponse) Descriptor() ([]byte, []int)Deprecated: Use ImportDocumentsResponse.ProtoReflect.Descriptor instead.
func (*ImportDocumentsResponse) GetErrorConfig
func (x *ImportDocumentsResponse) GetErrorConfig() *ImportErrorConfigfunc (*ImportDocumentsResponse) GetErrorSamples
func (x *ImportDocumentsResponse) GetErrorSamples() []*status.Statusfunc (*ImportDocumentsResponse) ProtoMessage
func (*ImportDocumentsResponse) ProtoMessage()func (*ImportDocumentsResponse) ProtoReflect
func (x *ImportDocumentsResponse) ProtoReflect() protoreflect.Messagefunc (*ImportDocumentsResponse) Reset
func (x *ImportDocumentsResponse) Reset()func (*ImportDocumentsResponse) String
func (x *ImportDocumentsResponse) String() stringImportErrorConfig
type ImportErrorConfig struct {
// Required. Errors destination.
//
// Types that are valid to be assigned to Destination:
//
// *ImportErrorConfig_GcsPrefix
Destination isImportErrorConfig_Destination `protobuf_oneof:"destination"`
// contains filtered or unexported fields
}Configuration of destination for Import related errors.
func (*ImportErrorConfig) Descriptor
func (*ImportErrorConfig) Descriptor() ([]byte, []int)Deprecated: Use ImportErrorConfig.ProtoReflect.Descriptor instead.
func (*ImportErrorConfig) GetDestination
func (x *ImportErrorConfig) GetDestination() isImportErrorConfig_Destinationfunc (*ImportErrorConfig) GetGcsPrefix
func (x *ImportErrorConfig) GetGcsPrefix() stringfunc (*ImportErrorConfig) ProtoMessage
func (*ImportErrorConfig) ProtoMessage()func (*ImportErrorConfig) ProtoReflect
func (x *ImportErrorConfig) ProtoReflect() protoreflect.Messagefunc (*ImportErrorConfig) Reset
func (x *ImportErrorConfig) Reset()func (*ImportErrorConfig) String
func (x *ImportErrorConfig) String() stringImportErrorConfig_GcsPrefix
type ImportErrorConfig_GcsPrefix struct {
// Cloud Storage prefix for import errors. This must be an empty,
// existing Cloud Storage directory. Import errors are written to
// sharded files in this directory, one per line, as a JSON-encoded
// `google.rpc.Status` message.
GcsPrefix string `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}ImportSampleQueriesMetadata
type ImportSampleQueriesMetadata struct {
// ImportSampleQueries operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// ImportSampleQueries operation last update time. If the operation is done,
// this is also the finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Count of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s
// successfully imported.
SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
// Count of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s
// that failed to be imported.
FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
// Total count of
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s that were
// processed.
TotalCount int64 `protobuf:"varint,5,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*ImportSampleQueriesMetadata) Descriptor
func (*ImportSampleQueriesMetadata) Descriptor() ([]byte, []int)Deprecated: Use ImportSampleQueriesMetadata.ProtoReflect.Descriptor instead.
func (*ImportSampleQueriesMetadata) GetCreateTime
func (x *ImportSampleQueriesMetadata) GetCreateTime() *timestamppb.Timestampfunc (*ImportSampleQueriesMetadata) GetFailureCount
func (x *ImportSampleQueriesMetadata) GetFailureCount() int64func (*ImportSampleQueriesMetadata) GetSuccessCount
func (x *ImportSampleQueriesMetadata) GetSuccessCount() int64func (*ImportSampleQueriesMetadata) GetTotalCount
func (x *ImportSampleQueriesMetadata) GetTotalCount() int64func (*ImportSampleQueriesMetadata) GetUpdateTime
func (x *ImportSampleQueriesMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*ImportSampleQueriesMetadata) ProtoMessage
func (*ImportSampleQueriesMetadata) ProtoMessage()func (*ImportSampleQueriesMetadata) ProtoReflect
func (x *ImportSampleQueriesMetadata) ProtoReflect() protoreflect.Messagefunc (*ImportSampleQueriesMetadata) Reset
func (x *ImportSampleQueriesMetadata) Reset()func (*ImportSampleQueriesMetadata) String
func (x *ImportSampleQueriesMetadata) String() stringImportSampleQueriesRequest
type ImportSampleQueriesRequest struct {
// The source of the sample queries.
//
// Types that are valid to be assigned to Source:
//
// *ImportSampleQueriesRequest_InlineSource_
// *ImportSampleQueriesRequest_GcsSource
// *ImportSampleQueriesRequest_BigquerySource
Source isImportSampleQueriesRequest_Source `protobuf_oneof:"source"`
// Required. The parent sample query set resource name, such as
// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
//
// If the caller does not have permission to list
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s under this
// sample query set, regardless of whether or not this sample query set
// exists, a `PERMISSION_DENIED` error is returned.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The desired location of errors incurred during the Import.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] method.
func (*ImportSampleQueriesRequest) Descriptor
func (*ImportSampleQueriesRequest) Descriptor() ([]byte, []int)Deprecated: Use ImportSampleQueriesRequest.ProtoReflect.Descriptor instead.
func (*ImportSampleQueriesRequest) GetBigquerySource
func (x *ImportSampleQueriesRequest) GetBigquerySource() *BigQuerySourcefunc (*ImportSampleQueriesRequest) GetErrorConfig
func (x *ImportSampleQueriesRequest) GetErrorConfig() *ImportErrorConfigfunc (*ImportSampleQueriesRequest) GetGcsSource
func (x *ImportSampleQueriesRequest) GetGcsSource() *GcsSourcefunc (*ImportSampleQueriesRequest) GetInlineSource
func (x *ImportSampleQueriesRequest) GetInlineSource() *ImportSampleQueriesRequest_InlineSourcefunc (*ImportSampleQueriesRequest) GetParent
func (x *ImportSampleQueriesRequest) GetParent() stringfunc (*ImportSampleQueriesRequest) GetSource
func (x *ImportSampleQueriesRequest) GetSource() isImportSampleQueriesRequest_Sourcefunc (*ImportSampleQueriesRequest) ProtoMessage
func (*ImportSampleQueriesRequest) ProtoMessage()func (*ImportSampleQueriesRequest) ProtoReflect
func (x *ImportSampleQueriesRequest) ProtoReflect() protoreflect.Messagefunc (*ImportSampleQueriesRequest) Reset
func (x *ImportSampleQueriesRequest) Reset()func (*ImportSampleQueriesRequest) String
func (x *ImportSampleQueriesRequest) String() stringImportSampleQueriesRequest_BigquerySource
type ImportSampleQueriesRequest_BigquerySource struct {
// BigQuery input source.
BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}ImportSampleQueriesRequest_GcsSource
type ImportSampleQueriesRequest_GcsSource struct {
// Cloud Storage location for the input content.
GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}ImportSampleQueriesRequest_InlineSource
type ImportSampleQueriesRequest_InlineSource struct {
// Required. A list of
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s to
// import. Max of 1000 items.
SampleQueries []*SampleQuery `protobuf:"bytes,1,rep,name=sample_queries,json=sampleQueries,proto3" json:"sample_queries,omitempty"`
// contains filtered or unexported fields
}The inline source for [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
func (*ImportSampleQueriesRequest_InlineSource) Descriptor
func (*ImportSampleQueriesRequest_InlineSource) Descriptor() ([]byte, []int)Deprecated: Use ImportSampleQueriesRequest_InlineSource.ProtoReflect.Descriptor instead.
func (*ImportSampleQueriesRequest_InlineSource) GetSampleQueries
func (x *ImportSampleQueriesRequest_InlineSource) GetSampleQueries() []*SampleQueryfunc (*ImportSampleQueriesRequest_InlineSource) ProtoMessage
func (*ImportSampleQueriesRequest_InlineSource) ProtoMessage()func (*ImportSampleQueriesRequest_InlineSource) ProtoReflect
func (x *ImportSampleQueriesRequest_InlineSource) ProtoReflect() protoreflect.Messagefunc (*ImportSampleQueriesRequest_InlineSource) Reset
func (x *ImportSampleQueriesRequest_InlineSource) Reset()func (*ImportSampleQueriesRequest_InlineSource) String
func (x *ImportSampleQueriesRequest_InlineSource) String() stringImportSampleQueriesRequest_InlineSource_
type ImportSampleQueriesRequest_InlineSource_ struct {
// The Inline source for sample query entries.
InlineSource *ImportSampleQueriesRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}ImportSampleQueriesResponse
type ImportSampleQueriesResponse struct {
// A sample of errors encountered while processing the request.
ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// The desired location of errors incurred during the Import.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// contains filtered or unexported fields
}Response of the [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.
func (*ImportSampleQueriesResponse) Descriptor
func (*ImportSampleQueriesResponse) Descriptor() ([]byte, []int)Deprecated: Use ImportSampleQueriesResponse.ProtoReflect.Descriptor instead.
func (*ImportSampleQueriesResponse) GetErrorConfig
func (x *ImportSampleQueriesResponse) GetErrorConfig() *ImportErrorConfigfunc (*ImportSampleQueriesResponse) GetErrorSamples
func (x *ImportSampleQueriesResponse) GetErrorSamples() []*status.Statusfunc (*ImportSampleQueriesResponse) ProtoMessage
func (*ImportSampleQueriesResponse) ProtoMessage()func (*ImportSampleQueriesResponse) ProtoReflect
func (x *ImportSampleQueriesResponse) ProtoReflect() protoreflect.Messagefunc (*ImportSampleQueriesResponse) Reset
func (x *ImportSampleQueriesResponse) Reset()func (*ImportSampleQueriesResponse) String
func (x *ImportSampleQueriesResponse) String() stringImportSuggestionDenyListEntriesMetadata
type ImportSuggestionDenyListEntriesMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
func (*ImportSuggestionDenyListEntriesMetadata) Descriptor
func (*ImportSuggestionDenyListEntriesMetadata) Descriptor() ([]byte, []int)Deprecated: Use ImportSuggestionDenyListEntriesMetadata.ProtoReflect.Descriptor instead.
func (*ImportSuggestionDenyListEntriesMetadata) GetCreateTime
func (x *ImportSuggestionDenyListEntriesMetadata) GetCreateTime() *timestamppb.Timestampfunc (*ImportSuggestionDenyListEntriesMetadata) GetUpdateTime
func (x *ImportSuggestionDenyListEntriesMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*ImportSuggestionDenyListEntriesMetadata) ProtoMessage
func (*ImportSuggestionDenyListEntriesMetadata) ProtoMessage()func (*ImportSuggestionDenyListEntriesMetadata) ProtoReflect
func (x *ImportSuggestionDenyListEntriesMetadata) ProtoReflect() protoreflect.Messagefunc (*ImportSuggestionDenyListEntriesMetadata) Reset
func (x *ImportSuggestionDenyListEntriesMetadata) Reset()func (*ImportSuggestionDenyListEntriesMetadata) String
func (x *ImportSuggestionDenyListEntriesMetadata) String() stringImportSuggestionDenyListEntriesRequest
type ImportSuggestionDenyListEntriesRequest struct {
// The source of the updated SuggestionDenyList.
//
// Types that are valid to be assigned to Source:
//
// *ImportSuggestionDenyListEntriesRequest_InlineSource_
// *ImportSuggestionDenyListEntriesRequest_GcsSource
Source isImportSuggestionDenyListEntriesRequest_Source `protobuf_oneof:"source"`
// Required. The parent data store resource name for which to import denylist
// entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// contains filtered or unexported fields
}Request message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] method.
func (*ImportSuggestionDenyListEntriesRequest) Descriptor
func (*ImportSuggestionDenyListEntriesRequest) Descriptor() ([]byte, []int)Deprecated: Use ImportSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.
func (*ImportSuggestionDenyListEntriesRequest) GetGcsSource
func (x *ImportSuggestionDenyListEntriesRequest) GetGcsSource() *GcsSourcefunc (*ImportSuggestionDenyListEntriesRequest) GetInlineSource
func (x *ImportSuggestionDenyListEntriesRequest) GetInlineSource() *ImportSuggestionDenyListEntriesRequest_InlineSourcefunc (*ImportSuggestionDenyListEntriesRequest) GetParent
func (x *ImportSuggestionDenyListEntriesRequest) GetParent() stringfunc (*ImportSuggestionDenyListEntriesRequest) GetSource
func (x *ImportSuggestionDenyListEntriesRequest) GetSource() isImportSuggestionDenyListEntriesRequest_Sourcefunc (*ImportSuggestionDenyListEntriesRequest) ProtoMessage
func (*ImportSuggestionDenyListEntriesRequest) ProtoMessage()func (*ImportSuggestionDenyListEntriesRequest) ProtoReflect
func (x *ImportSuggestionDenyListEntriesRequest) ProtoReflect() protoreflect.Messagefunc (*ImportSuggestionDenyListEntriesRequest) Reset
func (x *ImportSuggestionDenyListEntriesRequest) Reset()func (*ImportSuggestionDenyListEntriesRequest) String
func (x *ImportSuggestionDenyListEntriesRequest) String() stringImportSuggestionDenyListEntriesRequest_GcsSource
type ImportSuggestionDenyListEntriesRequest_GcsSource struct {
// Cloud Storage location for the input content.
//
// Only 1 file can be specified that contains all entries to import.
// Supported values `gcs_source.schema` for autocomplete suggestion deny
// list entry imports:
//
// * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
// per line.
GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}ImportSuggestionDenyListEntriesRequest_InlineSource
type ImportSuggestionDenyListEntriesRequest_InlineSource struct {
// Required. A list of all denylist entries to import. Max of 1000 items.
Entries []*SuggestionDenyListEntry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
// contains filtered or unexported fields
}The inline source for SuggestionDenyListEntry.
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Descriptor
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) Descriptor() ([]byte, []int)Deprecated: Use ImportSuggestionDenyListEntriesRequest_InlineSource.ProtoReflect.Descriptor instead.
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) GetEntries
func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) GetEntries() []*SuggestionDenyListEntryfunc (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoMessage
func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoMessage()func (*ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoReflect
func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) ProtoReflect() protoreflect.Messagefunc (*ImportSuggestionDenyListEntriesRequest_InlineSource) Reset
func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) Reset()func (*ImportSuggestionDenyListEntriesRequest_InlineSource) String
func (x *ImportSuggestionDenyListEntriesRequest_InlineSource) String() stringImportSuggestionDenyListEntriesRequest_InlineSource_
type ImportSuggestionDenyListEntriesRequest_InlineSource_ struct {
// The Inline source for the input content for suggestion deny list entries.
InlineSource *ImportSuggestionDenyListEntriesRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}ImportSuggestionDenyListEntriesResponse
type ImportSuggestionDenyListEntriesResponse struct {
// A sample of errors encountered while processing the request.
ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// Count of deny list entries successfully imported.
ImportedEntriesCount int64 `protobuf:"varint,2,opt,name=imported_entries_count,json=importedEntriesCount,proto3" json:"imported_entries_count,omitempty"`
// Count of deny list entries that failed to be imported.
FailedEntriesCount int64 `protobuf:"varint,3,opt,name=failed_entries_count,json=failedEntriesCount,proto3" json:"failed_entries_count,omitempty"`
// contains filtered or unexported fields
}Response message for [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] method.
func (*ImportSuggestionDenyListEntriesResponse) Descriptor
func (*ImportSuggestionDenyListEntriesResponse) Descriptor() ([]byte, []int)Deprecated: Use ImportSuggestionDenyListEntriesResponse.ProtoReflect.Descriptor instead.
func (*ImportSuggestionDenyListEntriesResponse) GetErrorSamples
func (x *ImportSuggestionDenyListEntriesResponse) GetErrorSamples() []*status.Statusfunc (*ImportSuggestionDenyListEntriesResponse) GetFailedEntriesCount
func (x *ImportSuggestionDenyListEntriesResponse) GetFailedEntriesCount() int64func (*ImportSuggestionDenyListEntriesResponse) GetImportedEntriesCount
func (x *ImportSuggestionDenyListEntriesResponse) GetImportedEntriesCount() int64func (*ImportSuggestionDenyListEntriesResponse) ProtoMessage
func (*ImportSuggestionDenyListEntriesResponse) ProtoMessage()func (*ImportSuggestionDenyListEntriesResponse) ProtoReflect
func (x *ImportSuggestionDenyListEntriesResponse) ProtoReflect() protoreflect.Messagefunc (*ImportSuggestionDenyListEntriesResponse) Reset
func (x *ImportSuggestionDenyListEntriesResponse) Reset()func (*ImportSuggestionDenyListEntriesResponse) String
func (x *ImportSuggestionDenyListEntriesResponse) String() stringImportUserEventsMetadata
type ImportUserEventsMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Count of entries that were processed successfully.
SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
// Count of entries that encountered errors while processing.
FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
func (*ImportUserEventsMetadata) Descriptor
func (*ImportUserEventsMetadata) Descriptor() ([]byte, []int)Deprecated: Use ImportUserEventsMetadata.ProtoReflect.Descriptor instead.
func (*ImportUserEventsMetadata) GetCreateTime
func (x *ImportUserEventsMetadata) GetCreateTime() *timestamppb.Timestampfunc (*ImportUserEventsMetadata) GetFailureCount
func (x *ImportUserEventsMetadata) GetFailureCount() int64func (*ImportUserEventsMetadata) GetSuccessCount
func (x *ImportUserEventsMetadata) GetSuccessCount() int64func (*ImportUserEventsMetadata) GetUpdateTime
func (x *ImportUserEventsMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*ImportUserEventsMetadata) ProtoMessage
func (*ImportUserEventsMetadata) ProtoMessage()func (*ImportUserEventsMetadata) ProtoReflect
func (x *ImportUserEventsMetadata) ProtoReflect() protoreflect.Messagefunc (*ImportUserEventsMetadata) Reset
func (x *ImportUserEventsMetadata) Reset()func (*ImportUserEventsMetadata) String
func (x *ImportUserEventsMetadata) String() stringImportUserEventsRequest
type ImportUserEventsRequest struct {
// Required - The desired input source of the user event data.
//
// Types that are valid to be assigned to Source:
//
// *ImportUserEventsRequest_InlineSource_
// *ImportUserEventsRequest_GcsSource
// *ImportUserEventsRequest_BigquerySource
Source isImportUserEventsRequest_Source `protobuf_oneof:"source"`
// Required. Parent DataStore resource name, of the form
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The desired location of errors incurred during the Import. Cannot be set
// for inline user event imports.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,5,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// contains filtered or unexported fields
}Request message for the ImportUserEvents request.
func (*ImportUserEventsRequest) Descriptor
func (*ImportUserEventsRequest) Descriptor() ([]byte, []int)Deprecated: Use ImportUserEventsRequest.ProtoReflect.Descriptor instead.
func (*ImportUserEventsRequest) GetBigquerySource
func (x *ImportUserEventsRequest) GetBigquerySource() *BigQuerySourcefunc (*ImportUserEventsRequest) GetErrorConfig
func (x *ImportUserEventsRequest) GetErrorConfig() *ImportErrorConfigfunc (*ImportUserEventsRequest) GetGcsSource
func (x *ImportUserEventsRequest) GetGcsSource() *GcsSourcefunc (*ImportUserEventsRequest) GetInlineSource
func (x *ImportUserEventsRequest) GetInlineSource() *ImportUserEventsRequest_InlineSourcefunc (*ImportUserEventsRequest) GetParent
func (x *ImportUserEventsRequest) GetParent() stringfunc (*ImportUserEventsRequest) GetSource
func (x *ImportUserEventsRequest) GetSource() isImportUserEventsRequest_Sourcefunc (*ImportUserEventsRequest) ProtoMessage
func (*ImportUserEventsRequest) ProtoMessage()func (*ImportUserEventsRequest) ProtoReflect
func (x *ImportUserEventsRequest) ProtoReflect() protoreflect.Messagefunc (*ImportUserEventsRequest) Reset
func (x *ImportUserEventsRequest) Reset()func (*ImportUserEventsRequest) String
func (x *ImportUserEventsRequest) String() stringImportUserEventsRequest_BigquerySource
type ImportUserEventsRequest_BigquerySource struct {
// BigQuery input source.
BigquerySource *BigQuerySource `protobuf:"bytes,4,opt,name=bigquery_source,json=bigquerySource,proto3,oneof"`
}ImportUserEventsRequest_GcsSource
type ImportUserEventsRequest_GcsSource struct {
// Cloud Storage location for the input content.
GcsSource *GcsSource `protobuf:"bytes,3,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}ImportUserEventsRequest_InlineSource
type ImportUserEventsRequest_InlineSource struct {
// Required. A list of user events to import. Recommended max of 10k items.
UserEvents []*UserEvent `protobuf:"bytes,1,rep,name=user_events,json=userEvents,proto3" json:"user_events,omitempty"`
// contains filtered or unexported fields
}The inline source for the input config for ImportUserEvents method.
func (*ImportUserEventsRequest_InlineSource) Descriptor
func (*ImportUserEventsRequest_InlineSource) Descriptor() ([]byte, []int)Deprecated: Use ImportUserEventsRequest_InlineSource.ProtoReflect.Descriptor instead.
func (*ImportUserEventsRequest_InlineSource) GetUserEvents
func (x *ImportUserEventsRequest_InlineSource) GetUserEvents() []*UserEventfunc (*ImportUserEventsRequest_InlineSource) ProtoMessage
func (*ImportUserEventsRequest_InlineSource) ProtoMessage()func (*ImportUserEventsRequest_InlineSource) ProtoReflect
func (x *ImportUserEventsRequest_InlineSource) ProtoReflect() protoreflect.Messagefunc (*ImportUserEventsRequest_InlineSource) Reset
func (x *ImportUserEventsRequest_InlineSource) Reset()func (*ImportUserEventsRequest_InlineSource) String
func (x *ImportUserEventsRequest_InlineSource) String() stringImportUserEventsRequest_InlineSource_
type ImportUserEventsRequest_InlineSource_ struct {
// The Inline source for the input content for UserEvents.
InlineSource *ImportUserEventsRequest_InlineSource `protobuf:"bytes,2,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}ImportUserEventsResponse
type ImportUserEventsResponse struct {
// A sample of errors encountered while processing the request.
ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// Echoes the destination for the complete errors if this field was set in
// the request.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// Count of user events imported with complete existing Documents.
JoinedEventsCount int64 `protobuf:"varint,3,opt,name=joined_events_count,json=joinedEventsCount,proto3" json:"joined_events_count,omitempty"`
// Count of user events imported, but with Document information not found
// in the existing Branch.
UnjoinedEventsCount int64 `protobuf:"varint,4,opt,name=unjoined_events_count,json=unjoinedEventsCount,proto3" json:"unjoined_events_count,omitempty"`
// contains filtered or unexported fields
}Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
func (*ImportUserEventsResponse) Descriptor
func (*ImportUserEventsResponse) Descriptor() ([]byte, []int)Deprecated: Use ImportUserEventsResponse.ProtoReflect.Descriptor instead.
func (*ImportUserEventsResponse) GetErrorConfig
func (x *ImportUserEventsResponse) GetErrorConfig() *ImportErrorConfigfunc (*ImportUserEventsResponse) GetErrorSamples
func (x *ImportUserEventsResponse) GetErrorSamples() []*status.Statusfunc (*ImportUserEventsResponse) GetJoinedEventsCount
func (x *ImportUserEventsResponse) GetJoinedEventsCount() int64func (*ImportUserEventsResponse) GetUnjoinedEventsCount
func (x *ImportUserEventsResponse) GetUnjoinedEventsCount() int64func (*ImportUserEventsResponse) ProtoMessage
func (*ImportUserEventsResponse) ProtoMessage()func (*ImportUserEventsResponse) ProtoReflect
func (x *ImportUserEventsResponse) ProtoReflect() protoreflect.Messagefunc (*ImportUserEventsResponse) Reset
func (x *ImportUserEventsResponse) Reset()func (*ImportUserEventsResponse) String
func (x *ImportUserEventsResponse) String() stringIndustryVertical
type IndustryVertical int32The industry vertical associated with the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
IndustryVertical_INDUSTRY_VERTICAL_UNSPECIFIED, IndustryVertical_GENERIC, IndustryVertical_MEDIA, IndustryVertical_HEALTHCARE_FHIR
const (
// Value used when unset.
IndustryVertical_INDUSTRY_VERTICAL_UNSPECIFIED IndustryVertical = 0
// The generic vertical for documents that are not specific to any industry
// vertical.
IndustryVertical_GENERIC IndustryVertical = 1
// The media industry vertical.
IndustryVertical_MEDIA IndustryVertical = 2
// The healthcare FHIR vertical.
IndustryVertical_HEALTHCARE_FHIR IndustryVertical = 7
)func (IndustryVertical) Descriptor
func (IndustryVertical) Descriptor() protoreflect.EnumDescriptorfunc (IndustryVertical) Enum
func (x IndustryVertical) Enum() *IndustryVerticalfunc (IndustryVertical) EnumDescriptor
func (IndustryVertical) EnumDescriptor() ([]byte, []int)Deprecated: Use IndustryVertical.Descriptor instead.
func (IndustryVertical) Number
func (x IndustryVertical) Number() protoreflect.EnumNumberfunc (IndustryVertical) String
func (x IndustryVertical) String() stringfunc (IndustryVertical) Type
func (IndustryVertical) Type() protoreflect.EnumTypeInterval
type Interval struct {
// The lower bound of the interval. If neither of the min fields are
// set, then the lower bound is negative infinity.
//
// This field must be not larger than max.
// Otherwise, an `INVALID_ARGUMENT` error is returned.
//
// Types that are valid to be assigned to Min:
//
// *Interval_Minimum
// *Interval_ExclusiveMinimum
Min isInterval_Min `protobuf_oneof:"min"`
// The upper bound of the interval. If neither of the max fields are
// set, then the upper bound is positive infinity.
//
// This field must be not smaller than min.
// Otherwise, an `INVALID_ARGUMENT` error is returned.
//
// Types that are valid to be assigned to Max:
//
// *Interval_Maximum
// *Interval_ExclusiveMaximum
Max isInterval_Max `protobuf_oneof:"max"`
// contains filtered or unexported fields
}A floating point interval.
func (*Interval) Descriptor
Deprecated: Use Interval.ProtoReflect.Descriptor instead.
func (*Interval) GetExclusiveMaximum
func (*Interval) GetExclusiveMinimum
func (*Interval) GetMax
func (x *Interval) GetMax() isInterval_Maxfunc (*Interval) GetMaximum
func (*Interval) GetMin
func (x *Interval) GetMin() isInterval_Minfunc (*Interval) GetMinimum
func (*Interval) ProtoMessage
func (*Interval) ProtoMessage()func (*Interval) ProtoReflect
func (x *Interval) ProtoReflect() protoreflect.Messagefunc (*Interval) Reset
func (x *Interval) Reset()func (*Interval) String
Interval_ExclusiveMaximum
type Interval_ExclusiveMaximum struct {
// Exclusive upper bound.
ExclusiveMaximum float64 `protobuf:"fixed64,4,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3,oneof"`
}Interval_ExclusiveMinimum
type Interval_ExclusiveMinimum struct {
// Exclusive lower bound.
ExclusiveMinimum float64 `protobuf:"fixed64,2,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3,oneof"`
}Interval_Maximum
type Interval_Maximum struct {
// Inclusive upper bound.
Maximum float64 `protobuf:"fixed64,3,opt,name=maximum,proto3,oneof"`
}Interval_Minimum
type Interval_Minimum struct {
// Inclusive lower bound.
Minimum float64 `protobuf:"fixed64,1,opt,name=minimum,proto3,oneof"`
}LanguageInfo
type LanguageInfo struct {
// The language code for the DataStore.
LanguageCode string `protobuf:"bytes,1,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// Output only. This is the normalized form of language_code.
// E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb`
// will have normalized_language_code of `en-GB`.
NormalizedLanguageCode string `protobuf:"bytes,2,opt,name=normalized_language_code,json=normalizedLanguageCode,proto3" json:"normalized_language_code,omitempty"`
// Output only. Language part of normalized_language_code.
// E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.
Language string `protobuf:"bytes,3,opt,name=language,proto3" json:"language,omitempty"`
// Output only. Region part of normalized_language_code, if present.
// E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> “.
Region string `protobuf:"bytes,4,opt,name=region,proto3" json:"region,omitempty"`
// contains filtered or unexported fields
}Language info for DataStore.
func (*LanguageInfo) Descriptor
func (*LanguageInfo) Descriptor() ([]byte, []int)Deprecated: Use LanguageInfo.ProtoReflect.Descriptor instead.
func (*LanguageInfo) GetLanguage
func (x *LanguageInfo) GetLanguage() stringfunc (*LanguageInfo) GetLanguageCode
func (x *LanguageInfo) GetLanguageCode() stringfunc (*LanguageInfo) GetNormalizedLanguageCode
func (x *LanguageInfo) GetNormalizedLanguageCode() stringfunc (*LanguageInfo) GetRegion
func (x *LanguageInfo) GetRegion() stringfunc (*LanguageInfo) ProtoMessage
func (*LanguageInfo) ProtoMessage()func (*LanguageInfo) ProtoReflect
func (x *LanguageInfo) ProtoReflect() protoreflect.Messagefunc (*LanguageInfo) Reset
func (x *LanguageInfo) Reset()func (*LanguageInfo) String
func (x *LanguageInfo) String() stringListChunksRequest
type ListChunksRequest struct {
// Required. The parent document resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
//
// If the caller does not have permission to list
// [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s under this document,
// regardless of whether or not this document exists, a `PERMISSION_DENIED`
// error is returned.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s to
// return. If unspecified, defaults to 100. The maximum allowed value is 1000.
// Values above 1000 will be coerced to 1000.
//
// If this field is negative, an `INVALID_ARGUMENT` error is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token
// [ListChunksResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListChunksResponse.next_page_token],
// received from a previous
// [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks]
// must match the call that provided the page token. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request message for [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] method.
func (*ListChunksRequest) Descriptor
func (*ListChunksRequest) Descriptor() ([]byte, []int)Deprecated: Use ListChunksRequest.ProtoReflect.Descriptor instead.
func (*ListChunksRequest) GetPageSize
func (x *ListChunksRequest) GetPageSize() int32func (*ListChunksRequest) GetPageToken
func (x *ListChunksRequest) GetPageToken() stringfunc (*ListChunksRequest) GetParent
func (x *ListChunksRequest) GetParent() stringfunc (*ListChunksRequest) ProtoMessage
func (*ListChunksRequest) ProtoMessage()func (*ListChunksRequest) ProtoReflect
func (x *ListChunksRequest) ProtoReflect() protoreflect.Messagefunc (*ListChunksRequest) Reset
func (x *ListChunksRequest) Reset()func (*ListChunksRequest) String
func (x *ListChunksRequest) String() stringListChunksResponse
type ListChunksResponse struct {
// The [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s.
Chunks []*Chunk `protobuf:"bytes,1,rep,name=chunks,proto3" json:"chunks,omitempty"`
// A token that can be sent as
// [ListChunksRequest.page_token][google.cloud.discoveryengine.v1alpha.ListChunksRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] method.
func (*ListChunksResponse) Descriptor
func (*ListChunksResponse) Descriptor() ([]byte, []int)Deprecated: Use ListChunksResponse.ProtoReflect.Descriptor instead.
func (*ListChunksResponse) GetChunks
func (x *ListChunksResponse) GetChunks() []*Chunkfunc (*ListChunksResponse) GetNextPageToken
func (x *ListChunksResponse) GetNextPageToken() stringfunc (*ListChunksResponse) ProtoMessage
func (*ListChunksResponse) ProtoMessage()func (*ListChunksResponse) ProtoReflect
func (x *ListChunksResponse) ProtoReflect() protoreflect.Messagefunc (*ListChunksResponse) Reset
func (x *ListChunksResponse) Reset()func (*ListChunksResponse) String
func (x *ListChunksResponse) String() stringListControlsRequest
type ListControlsRequest struct {
// Required. The data store resource name. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
// or
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Maximum number of results to return. If unspecified, defaults
// to 50. Max allowed value is 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListControls` call.
// Provide this to retrieve the subsequent page.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. A filter to apply on the list results. Supported features:
//
// * List all the products under the parent branch if
// [filter][google.cloud.discoveryengine.v1alpha.ListControlsRequest.filter]
// is unset. Currently this field is unsupported.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}Request for ListControls method.
func (*ListControlsRequest) Descriptor
func (*ListControlsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListControlsRequest.ProtoReflect.Descriptor instead.
func (*ListControlsRequest) GetFilter
func (x *ListControlsRequest) GetFilter() stringfunc (*ListControlsRequest) GetPageSize
func (x *ListControlsRequest) GetPageSize() int32func (*ListControlsRequest) GetPageToken
func (x *ListControlsRequest) GetPageToken() stringfunc (*ListControlsRequest) GetParent
func (x *ListControlsRequest) GetParent() stringfunc (*ListControlsRequest) ProtoMessage
func (*ListControlsRequest) ProtoMessage()func (*ListControlsRequest) ProtoReflect
func (x *ListControlsRequest) ProtoReflect() protoreflect.Messagefunc (*ListControlsRequest) Reset
func (x *ListControlsRequest) Reset()func (*ListControlsRequest) String
func (x *ListControlsRequest) String() stringListControlsResponse
type ListControlsResponse struct {
// All the Controls for a given data store.
Controls []*Control `protobuf:"bytes,1,rep,name=controls,proto3" json:"controls,omitempty"`
// Pagination token, if not returned indicates the last page.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for ListControls method.
func (*ListControlsResponse) Descriptor
func (*ListControlsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListControlsResponse.ProtoReflect.Descriptor instead.
func (*ListControlsResponse) GetControls
func (x *ListControlsResponse) GetControls() []*Controlfunc (*ListControlsResponse) GetNextPageToken
func (x *ListControlsResponse) GetNextPageToken() stringfunc (*ListControlsResponse) ProtoMessage
func (*ListControlsResponse) ProtoMessage()func (*ListControlsResponse) ProtoReflect
func (x *ListControlsResponse) ProtoReflect() protoreflect.Messagefunc (*ListControlsResponse) Reset
func (x *ListControlsResponse) Reset()func (*ListControlsResponse) String
func (x *ListControlsResponse) String() stringListConversationsRequest
type ListConversationsRequest struct {
// Required. The data store resource name. Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of results to return. If unspecified, defaults
// to 50. Max allowed value is 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListConversations` call.
// Provide this to retrieve the subsequent page.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// A filter to apply on the list results. The supported features are:
// user_pseudo_id, state.
//
// Example:
// "user_pseudo_id = some_id"
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// A comma-separated list of fields to order by, sorted in ascending order.
// Use "desc" after a field name for descending.
// Supported fields:
// - `update_time`
// - `create_time`
// - `conversation_name`
//
// Example:
// "update_time desc"
// "create_time"
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request for ListConversations method.
func (*ListConversationsRequest) Descriptor
func (*ListConversationsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListConversationsRequest.ProtoReflect.Descriptor instead.
func (*ListConversationsRequest) GetFilter
func (x *ListConversationsRequest) GetFilter() stringfunc (*ListConversationsRequest) GetOrderBy
func (x *ListConversationsRequest) GetOrderBy() stringfunc (*ListConversationsRequest) GetPageSize
func (x *ListConversationsRequest) GetPageSize() int32func (*ListConversationsRequest) GetPageToken
func (x *ListConversationsRequest) GetPageToken() stringfunc (*ListConversationsRequest) GetParent
func (x *ListConversationsRequest) GetParent() stringfunc (*ListConversationsRequest) ProtoMessage
func (*ListConversationsRequest) ProtoMessage()func (*ListConversationsRequest) ProtoReflect
func (x *ListConversationsRequest) ProtoReflect() protoreflect.Messagefunc (*ListConversationsRequest) Reset
func (x *ListConversationsRequest) Reset()func (*ListConversationsRequest) String
func (x *ListConversationsRequest) String() stringListConversationsResponse
type ListConversationsResponse struct {
// All the Conversations for a given data store.
Conversations []*Conversation `protobuf:"bytes,1,rep,name=conversations,proto3" json:"conversations,omitempty"`
// Pagination token, if not returned indicates the last page.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for ListConversations method.
func (*ListConversationsResponse) Descriptor
func (*ListConversationsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListConversationsResponse.ProtoReflect.Descriptor instead.
func (*ListConversationsResponse) GetConversations
func (x *ListConversationsResponse) GetConversations() []*Conversationfunc (*ListConversationsResponse) GetNextPageToken
func (x *ListConversationsResponse) GetNextPageToken() stringfunc (*ListConversationsResponse) ProtoMessage
func (*ListConversationsResponse) ProtoMessage()func (*ListConversationsResponse) ProtoReflect
func (x *ListConversationsResponse) ProtoReflect() protoreflect.Messagefunc (*ListConversationsResponse) Reset
func (x *ListConversationsResponse) Reset()func (*ListConversationsResponse) String
func (x *ListConversationsResponse) String() stringListCustomModelsRequest
type ListCustomModelsRequest struct {
// Required. The resource name of the parent Data Store, such as
// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
// This field is used to identify the data store where to fetch the models
// from.
DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// contains filtered or unexported fields
}Request message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] method.
func (*ListCustomModelsRequest) Descriptor
func (*ListCustomModelsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListCustomModelsRequest.ProtoReflect.Descriptor instead.
func (*ListCustomModelsRequest) GetDataStore
func (x *ListCustomModelsRequest) GetDataStore() stringfunc (*ListCustomModelsRequest) ProtoMessage
func (*ListCustomModelsRequest) ProtoMessage()func (*ListCustomModelsRequest) ProtoReflect
func (x *ListCustomModelsRequest) ProtoReflect() protoreflect.Messagefunc (*ListCustomModelsRequest) Reset
func (x *ListCustomModelsRequest) Reset()func (*ListCustomModelsRequest) String
func (x *ListCustomModelsRequest) String() stringListCustomModelsResponse
type ListCustomModelsResponse struct {
// List of custom tuning models.
Models []*CustomTuningModel `protobuf:"bytes,1,rep,name=models,proto3" json:"models,omitempty"`
// contains filtered or unexported fields
}Response message for [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] method.
func (*ListCustomModelsResponse) Descriptor
func (*ListCustomModelsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListCustomModelsResponse.ProtoReflect.Descriptor instead.
func (*ListCustomModelsResponse) GetModels
func (x *ListCustomModelsResponse) GetModels() []*CustomTuningModelfunc (*ListCustomModelsResponse) ProtoMessage
func (*ListCustomModelsResponse) ProtoMessage()func (*ListCustomModelsResponse) ProtoReflect
func (x *ListCustomModelsResponse) ProtoReflect() protoreflect.Messagefunc (*ListCustomModelsResponse) Reset
func (x *ListCustomModelsResponse) Reset()func (*ListCustomModelsResponse) String
func (x *ListCustomModelsResponse) String() stringListDataStoresRequest
type ListDataStoresRequest struct {
// Required. The parent branch resource name, such as
// `projects/{project}/locations/{location}/collections/{collection_id}`.
//
// If the caller does not have permission to list
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s under this
// location, regardless of whether or not this data store exists, a
// PERMISSION_DENIED error is returned.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s to return. If
// unspecified, defaults to 10. The maximum allowed value is 50. Values above
// 50 will be coerced to 50.
//
// If this field is negative, an INVALID_ARGUMENT is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token
// [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListDataStoresResponse.next_page_token],
// received from a previous
// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores]
// must match the call that provided the page token. Otherwise, an
// INVALID_ARGUMENT error is returned.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Filter by solution type .
// For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}Request message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] method.
func (*ListDataStoresRequest) Descriptor
func (*ListDataStoresRequest) Descriptor() ([]byte, []int)Deprecated: Use ListDataStoresRequest.ProtoReflect.Descriptor instead.
func (*ListDataStoresRequest) GetFilter
func (x *ListDataStoresRequest) GetFilter() stringfunc (*ListDataStoresRequest) GetPageSize
func (x *ListDataStoresRequest) GetPageSize() int32func (*ListDataStoresRequest) GetPageToken
func (x *ListDataStoresRequest) GetPageToken() stringfunc (*ListDataStoresRequest) GetParent
func (x *ListDataStoresRequest) GetParent() stringfunc (*ListDataStoresRequest) ProtoMessage
func (*ListDataStoresRequest) ProtoMessage()func (*ListDataStoresRequest) ProtoReflect
func (x *ListDataStoresRequest) ProtoReflect() protoreflect.Messagefunc (*ListDataStoresRequest) Reset
func (x *ListDataStoresRequest) Reset()func (*ListDataStoresRequest) String
func (x *ListDataStoresRequest) String() stringListDataStoresResponse
type ListDataStoresResponse struct {
// All the customer's
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s.
DataStores []*DataStore `protobuf:"bytes,1,rep,name=data_stores,json=dataStores,proto3" json:"data_stores,omitempty"`
// A token that can be sent as
// [ListDataStoresRequest.page_token][google.cloud.discoveryengine.v1alpha.ListDataStoresRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] method.
func (*ListDataStoresResponse) Descriptor
func (*ListDataStoresResponse) Descriptor() ([]byte, []int)Deprecated: Use ListDataStoresResponse.ProtoReflect.Descriptor instead.
func (*ListDataStoresResponse) GetDataStores
func (x *ListDataStoresResponse) GetDataStores() []*DataStorefunc (*ListDataStoresResponse) GetNextPageToken
func (x *ListDataStoresResponse) GetNextPageToken() stringfunc (*ListDataStoresResponse) ProtoMessage
func (*ListDataStoresResponse) ProtoMessage()func (*ListDataStoresResponse) ProtoReflect
func (x *ListDataStoresResponse) ProtoReflect() protoreflect.Messagefunc (*ListDataStoresResponse) Reset
func (x *ListDataStoresResponse) Reset()func (*ListDataStoresResponse) String
func (x *ListDataStoresResponse) String() stringListDocumentsRequest
type ListDocumentsRequest struct {
// Required. The parent branch resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
// Use `default_branch` as the branch ID, to list documents under the default
// branch.
//
// If the caller does not have permission to list
// [Document][google.cloud.discoveryengine.v1alpha.Document]s under this
// branch, regardless of whether or not this branch exists, a
// `PERMISSION_DENIED` error is returned.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of
// [Document][google.cloud.discoveryengine.v1alpha.Document]s to return. If
// unspecified, defaults to 100. The maximum allowed value is 1000. Values
// above 1000 are set to 1000.
//
// If this field is negative, an `INVALID_ARGUMENT` error is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token
// [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.next_page_token],
// received from a previous
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]
// must match the call that provided the page token. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] method.
func (*ListDocumentsRequest) Descriptor
func (*ListDocumentsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListDocumentsRequest.ProtoReflect.Descriptor instead.
func (*ListDocumentsRequest) GetPageSize
func (x *ListDocumentsRequest) GetPageSize() int32func (*ListDocumentsRequest) GetPageToken
func (x *ListDocumentsRequest) GetPageToken() stringfunc (*ListDocumentsRequest) GetParent
func (x *ListDocumentsRequest) GetParent() stringfunc (*ListDocumentsRequest) ProtoMessage
func (*ListDocumentsRequest) ProtoMessage()func (*ListDocumentsRequest) ProtoReflect
func (x *ListDocumentsRequest) ProtoReflect() protoreflect.Messagefunc (*ListDocumentsRequest) Reset
func (x *ListDocumentsRequest) Reset()func (*ListDocumentsRequest) String
func (x *ListDocumentsRequest) String() stringListDocumentsResponse
type ListDocumentsResponse struct {
// The [Document][google.cloud.discoveryengine.v1alpha.Document]s.
Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
// A token that can be sent as
// [ListDocumentsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListDocumentsRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] method.
func (*ListDocumentsResponse) Descriptor
func (*ListDocumentsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListDocumentsResponse.ProtoReflect.Descriptor instead.
func (*ListDocumentsResponse) GetDocuments
func (x *ListDocumentsResponse) GetDocuments() []*Documentfunc (*ListDocumentsResponse) GetNextPageToken
func (x *ListDocumentsResponse) GetNextPageToken() stringfunc (*ListDocumentsResponse) ProtoMessage
func (*ListDocumentsResponse) ProtoMessage()func (*ListDocumentsResponse) ProtoReflect
func (x *ListDocumentsResponse) ProtoReflect() protoreflect.Messagefunc (*ListDocumentsResponse) Reset
func (x *ListDocumentsResponse) Reset()func (*ListDocumentsResponse) String
func (x *ListDocumentsResponse) String() stringListEnginesRequest
type ListEnginesRequest struct {
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection_id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Not supported.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. Not supported.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter by solution type. For example:
// solution_type=SOLUTION_TYPE_SEARCH
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}Request message for [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] method.
func (*ListEnginesRequest) Descriptor
func (*ListEnginesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListEnginesRequest.ProtoReflect.Descriptor instead.
func (*ListEnginesRequest) GetFilter
func (x *ListEnginesRequest) GetFilter() stringfunc (*ListEnginesRequest) GetPageSize
func (x *ListEnginesRequest) GetPageSize() int32func (*ListEnginesRequest) GetPageToken
func (x *ListEnginesRequest) GetPageToken() stringfunc (*ListEnginesRequest) GetParent
func (x *ListEnginesRequest) GetParent() stringfunc (*ListEnginesRequest) ProtoMessage
func (*ListEnginesRequest) ProtoMessage()func (*ListEnginesRequest) ProtoReflect
func (x *ListEnginesRequest) ProtoReflect() protoreflect.Messagefunc (*ListEnginesRequest) Reset
func (x *ListEnginesRequest) Reset()func (*ListEnginesRequest) String
func (x *ListEnginesRequest) String() stringListEnginesResponse
type ListEnginesResponse struct {
// All the customer's [Engine][google.cloud.discoveryengine.v1alpha.Engine]s.
Engines []*Engine `protobuf:"bytes,1,rep,name=engines,proto3" json:"engines,omitempty"`
// Not supported.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] method.
func (*ListEnginesResponse) Descriptor
func (*ListEnginesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListEnginesResponse.ProtoReflect.Descriptor instead.
func (*ListEnginesResponse) GetEngines
func (x *ListEnginesResponse) GetEngines() []*Enginefunc (*ListEnginesResponse) GetNextPageToken
func (x *ListEnginesResponse) GetNextPageToken() stringfunc (*ListEnginesResponse) ProtoMessage
func (*ListEnginesResponse) ProtoMessage()func (*ListEnginesResponse) ProtoReflect
func (x *ListEnginesResponse) ProtoReflect() protoreflect.Messagefunc (*ListEnginesResponse) Reset
func (x *ListEnginesResponse) Reset()func (*ListEnginesResponse) String
func (x *ListEnginesResponse) String() stringListEvaluationResultsRequest
type ListEvaluationResultsRequest struct {
// Required. The evaluation resource name, such as
// `projects/{project}/locations/{location}/evaluations/{evaluation}`.
//
// If the caller does not have permission to list [EvaluationResult][]
// under this evaluation, regardless of whether or not this evaluation
// set exists, a `PERMISSION_DENIED` error is returned.
Evaluation string `protobuf:"bytes,1,opt,name=evaluation,proto3" json:"evaluation,omitempty"`
// Maximum number of [EvaluationResult][] to return. If unspecified,
// defaults to 100. The maximum allowed value is 1000. Values above 1000 will
// be coerced to 1000.
//
// If this field is negative, an `INVALID_ARGUMENT` error is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token
// [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.next_page_token],
// received from a previous
// [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults]
// must match the call that provided the page token. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request message for [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] method.
func (*ListEvaluationResultsRequest) Descriptor
func (*ListEvaluationResultsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListEvaluationResultsRequest.ProtoReflect.Descriptor instead.
func (*ListEvaluationResultsRequest) GetEvaluation
func (x *ListEvaluationResultsRequest) GetEvaluation() stringfunc (*ListEvaluationResultsRequest) GetPageSize
func (x *ListEvaluationResultsRequest) GetPageSize() int32func (*ListEvaluationResultsRequest) GetPageToken
func (x *ListEvaluationResultsRequest) GetPageToken() stringfunc (*ListEvaluationResultsRequest) ProtoMessage
func (*ListEvaluationResultsRequest) ProtoMessage()func (*ListEvaluationResultsRequest) ProtoReflect
func (x *ListEvaluationResultsRequest) ProtoReflect() protoreflect.Messagefunc (*ListEvaluationResultsRequest) Reset
func (x *ListEvaluationResultsRequest) Reset()func (*ListEvaluationResultsRequest) String
func (x *ListEvaluationResultsRequest) String() stringListEvaluationResultsResponse
type ListEvaluationResultsResponse struct {
// The
// [EvaluationResult][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.EvaluationResult]s.
EvaluationResults []*ListEvaluationResultsResponse_EvaluationResult `protobuf:"bytes,1,rep,name=evaluation_results,json=evaluationResults,proto3" json:"evaluation_results,omitempty"`
// A token that can be sent as
// [ListEvaluationResultsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] method.
func (*ListEvaluationResultsResponse) Descriptor
func (*ListEvaluationResultsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListEvaluationResultsResponse.ProtoReflect.Descriptor instead.
func (*ListEvaluationResultsResponse) GetEvaluationResults
func (x *ListEvaluationResultsResponse) GetEvaluationResults() []*ListEvaluationResultsResponse_EvaluationResultfunc (*ListEvaluationResultsResponse) GetNextPageToken
func (x *ListEvaluationResultsResponse) GetNextPageToken() stringfunc (*ListEvaluationResultsResponse) ProtoMessage
func (*ListEvaluationResultsResponse) ProtoMessage()func (*ListEvaluationResultsResponse) ProtoReflect
func (x *ListEvaluationResultsResponse) ProtoReflect() protoreflect.Messagefunc (*ListEvaluationResultsResponse) Reset
func (x *ListEvaluationResultsResponse) Reset()func (*ListEvaluationResultsResponse) String
func (x *ListEvaluationResultsResponse) String() stringListEvaluationResultsResponse_EvaluationResult
type ListEvaluationResultsResponse_EvaluationResult struct {
// Output only. The
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] that was
// evaluated.
SampleQuery *SampleQuery `protobuf:"bytes,1,opt,name=sample_query,json=sampleQuery,proto3" json:"sample_query,omitempty"`
// Output only. The metrics produced by the evaluation, for a given
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
QualityMetrics *QualityMetrics `protobuf:"bytes,2,opt,name=quality_metrics,json=qualityMetrics,proto3" json:"quality_metrics,omitempty"`
// contains filtered or unexported fields
}Represents the results of an evaluation for a single [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
func (*ListEvaluationResultsResponse_EvaluationResult) Descriptor
func (*ListEvaluationResultsResponse_EvaluationResult) Descriptor() ([]byte, []int)Deprecated: Use ListEvaluationResultsResponse_EvaluationResult.ProtoReflect.Descriptor instead.
func (*ListEvaluationResultsResponse_EvaluationResult) GetQualityMetrics
func (x *ListEvaluationResultsResponse_EvaluationResult) GetQualityMetrics() *QualityMetricsfunc (*ListEvaluationResultsResponse_EvaluationResult) GetSampleQuery
func (x *ListEvaluationResultsResponse_EvaluationResult) GetSampleQuery() *SampleQueryfunc (*ListEvaluationResultsResponse_EvaluationResult) ProtoMessage
func (*ListEvaluationResultsResponse_EvaluationResult) ProtoMessage()func (*ListEvaluationResultsResponse_EvaluationResult) ProtoReflect
func (x *ListEvaluationResultsResponse_EvaluationResult) ProtoReflect() protoreflect.Messagefunc (*ListEvaluationResultsResponse_EvaluationResult) Reset
func (x *ListEvaluationResultsResponse_EvaluationResult) Reset()func (*ListEvaluationResultsResponse_EvaluationResult) String
func (x *ListEvaluationResultsResponse_EvaluationResult) String() stringListEvaluationsRequest
type ListEvaluationsRequest struct {
// Required. The parent location resource name, such as
// `projects/{project}/locations/{location}`.
//
// If the caller does not have permission to list
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s under this
// location, regardless of whether or not this location exists, a
// `PERMISSION_DENIED` error is returned.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s to return.
// If unspecified, defaults to 100. The maximum allowed value is 1000. Values
// above 1000 will be coerced to 1000.
//
// If this field is negative, an `INVALID_ARGUMENT` error is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token
// [ListEvaluationsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationsResponse.next_page_token],
// received from a previous
// [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations]
// must match the call that provided the page token. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request message for [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] method.
func (*ListEvaluationsRequest) Descriptor
func (*ListEvaluationsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListEvaluationsRequest.ProtoReflect.Descriptor instead.
func (*ListEvaluationsRequest) GetPageSize
func (x *ListEvaluationsRequest) GetPageSize() int32func (*ListEvaluationsRequest) GetPageToken
func (x *ListEvaluationsRequest) GetPageToken() stringfunc (*ListEvaluationsRequest) GetParent
func (x *ListEvaluationsRequest) GetParent() stringfunc (*ListEvaluationsRequest) ProtoMessage
func (*ListEvaluationsRequest) ProtoMessage()func (*ListEvaluationsRequest) ProtoReflect
func (x *ListEvaluationsRequest) ProtoReflect() protoreflect.Messagefunc (*ListEvaluationsRequest) Reset
func (x *ListEvaluationsRequest) Reset()func (*ListEvaluationsRequest) String
func (x *ListEvaluationsRequest) String() stringListEvaluationsResponse
type ListEvaluationsResponse struct {
// The [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
Evaluations []*Evaluation `protobuf:"bytes,1,rep,name=evaluations,proto3" json:"evaluations,omitempty"`
// A token that can be sent as
// [ListEvaluationsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationsRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] method.
func (*ListEvaluationsResponse) Descriptor
func (*ListEvaluationsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListEvaluationsResponse.ProtoReflect.Descriptor instead.
func (*ListEvaluationsResponse) GetEvaluations
func (x *ListEvaluationsResponse) GetEvaluations() []*Evaluationfunc (*ListEvaluationsResponse) GetNextPageToken
func (x *ListEvaluationsResponse) GetNextPageToken() stringfunc (*ListEvaluationsResponse) ProtoMessage
func (*ListEvaluationsResponse) ProtoMessage()func (*ListEvaluationsResponse) ProtoReflect
func (x *ListEvaluationsResponse) ProtoReflect() protoreflect.Messagefunc (*ListEvaluationsResponse) Reset
func (x *ListEvaluationsResponse) Reset()func (*ListEvaluationsResponse) String
func (x *ListEvaluationsResponse) String() stringListFilesRequest
type ListFilesRequest struct {
// Required. The resource name of the Session.
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
// Name of the session resource to which the file belong.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The filter syntax consists of an expression language for
// constructing a predicate from one or more fields of the files being
// filtered. Filter expression is case-sensitive. Currently supported field
// names are:
// * upload_time
// * last_add_time
// * last_use_time
// * file_name
// * mime_type
//
// Some examples of filters would be:
// * "file_name = 'file_1'"
// * "file_name = 'file_1' AND mime_type = 'text/plain'"
// * "last_use_time > '2025-06-14T12:00:00Z'"
//
// For a full description of the filter format, please
// see https://google.aip.dev/160.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The maximum number of files to return. The service may return
// fewer than this value. If unspecified, at most 100 files will be returned.
// The maximum value is 1000; values above 1000 will be coerced to 1000.
// If user specifies a value less than or equal to 0 - the request will be
// rejected with an INVALID_ARGUMENT error.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token received from a previous `ListFiles` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListFiles`
// must match the call that provided the page token (except `page_size`, which
// may differ).
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request message for [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] method.
func (*ListFilesRequest) Descriptor
func (*ListFilesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListFilesRequest.ProtoReflect.Descriptor instead.
func (*ListFilesRequest) GetFilter
func (x *ListFilesRequest) GetFilter() stringfunc (*ListFilesRequest) GetPageSize
func (x *ListFilesRequest) GetPageSize() int32func (*ListFilesRequest) GetPageToken
func (x *ListFilesRequest) GetPageToken() stringfunc (*ListFilesRequest) GetParent
func (x *ListFilesRequest) GetParent() stringfunc (*ListFilesRequest) ProtoMessage
func (*ListFilesRequest) ProtoMessage()func (*ListFilesRequest) ProtoReflect
func (x *ListFilesRequest) ProtoReflect() protoreflect.Messagefunc (*ListFilesRequest) Reset
func (x *ListFilesRequest) Reset()func (*ListFilesRequest) String
func (x *ListFilesRequest) String() stringListFilesResponse
type ListFilesResponse struct {
// The [FileMetadata][google.cloud.discoveryengine.v1alpha.FileMetadata]s.
Files []*FileMetadata `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"`
// A token to retrieve next page of results.
// Pass this value in the
// [ListFilesRequest.page_token][google.cloud.discoveryengine.v1main.ListFilesRequest.page_token]
// field in the subsequent call to `ListFiles` method to
// retrieve the next page of results.
NextPageToken string `protobuf:"bytes,3,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] method.
func (*ListFilesResponse) Descriptor
func (*ListFilesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListFilesResponse.ProtoReflect.Descriptor instead.
func (*ListFilesResponse) GetFiles
func (x *ListFilesResponse) GetFiles() []*FileMetadatafunc (*ListFilesResponse) GetNextPageToken
func (x *ListFilesResponse) GetNextPageToken() stringfunc (*ListFilesResponse) ProtoMessage
func (*ListFilesResponse) ProtoMessage()func (*ListFilesResponse) ProtoReflect
func (x *ListFilesResponse) ProtoReflect() protoreflect.Messagefunc (*ListFilesResponse) Reset
func (x *ListFilesResponse) Reset()func (*ListFilesResponse) String
func (x *ListFilesResponse) String() stringListSampleQueriesRequest
type ListSampleQueriesRequest struct {
// Required. The parent sample query set resource name, such as
// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
//
// If the caller does not have permission to list
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s under this
// sample query set, regardless of whether or not this sample query set
// exists, a `PERMISSION_DENIED` error is returned.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s to return.
// If unspecified, defaults to 100. The maximum allowed value is 1000. Values
// above 1000 will be coerced to 1000.
//
// If this field is negative, an `INVALID_ARGUMENT` error is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token
// [ListSampleQueriesResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse.next_page_token],
// received from a previous
// [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries]
// must match the call that provided the page token. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] method.
func (*ListSampleQueriesRequest) Descriptor
func (*ListSampleQueriesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSampleQueriesRequest.ProtoReflect.Descriptor instead.
func (*ListSampleQueriesRequest) GetPageSize
func (x *ListSampleQueriesRequest) GetPageSize() int32func (*ListSampleQueriesRequest) GetPageToken
func (x *ListSampleQueriesRequest) GetPageToken() stringfunc (*ListSampleQueriesRequest) GetParent
func (x *ListSampleQueriesRequest) GetParent() stringfunc (*ListSampleQueriesRequest) ProtoMessage
func (*ListSampleQueriesRequest) ProtoMessage()func (*ListSampleQueriesRequest) ProtoReflect
func (x *ListSampleQueriesRequest) ProtoReflect() protoreflect.Messagefunc (*ListSampleQueriesRequest) Reset
func (x *ListSampleQueriesRequest) Reset()func (*ListSampleQueriesRequest) String
func (x *ListSampleQueriesRequest) String() stringListSampleQueriesResponse
type ListSampleQueriesResponse struct {
// The [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
SampleQueries []*SampleQuery `protobuf:"bytes,1,rep,name=sample_queries,json=sampleQueries,proto3" json:"sample_queries,omitempty"`
// A token that can be sent as
// [ListSampleQueriesRequest.page_token][google.cloud.discoveryengine.v1alpha.ListSampleQueriesRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] method.
func (*ListSampleQueriesResponse) Descriptor
func (*ListSampleQueriesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSampleQueriesResponse.ProtoReflect.Descriptor instead.
func (*ListSampleQueriesResponse) GetNextPageToken
func (x *ListSampleQueriesResponse) GetNextPageToken() stringfunc (*ListSampleQueriesResponse) GetSampleQueries
func (x *ListSampleQueriesResponse) GetSampleQueries() []*SampleQueryfunc (*ListSampleQueriesResponse) ProtoMessage
func (*ListSampleQueriesResponse) ProtoMessage()func (*ListSampleQueriesResponse) ProtoReflect
func (x *ListSampleQueriesResponse) ProtoReflect() protoreflect.Messagefunc (*ListSampleQueriesResponse) Reset
func (x *ListSampleQueriesResponse) Reset()func (*ListSampleQueriesResponse) String
func (x *ListSampleQueriesResponse) String() stringListSampleQuerySetsRequest
type ListSampleQuerySetsRequest struct {
// Required. The parent location resource name, such as
// `projects/{project}/locations/{location}`.
//
// If the caller does not have permission to list
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s
// under this location, regardless of whether or not this location exists, a
// `PERMISSION_DENIED` error is returned.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s to
// return. If unspecified, defaults to 100. The maximum allowed value is 1000.
// Values above 1000 will be coerced to 1000.
//
// If this field is negative, an `INVALID_ARGUMENT` error is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token
// [ListSampleQuerySetsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsResponse.next_page_token],
// received from a previous
// [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets]
// must match the call that provided the page token. Otherwise, an
// `INVALID_ARGUMENT` error is returned.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] method.
func (*ListSampleQuerySetsRequest) Descriptor
func (*ListSampleQuerySetsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSampleQuerySetsRequest.ProtoReflect.Descriptor instead.
func (*ListSampleQuerySetsRequest) GetPageSize
func (x *ListSampleQuerySetsRequest) GetPageSize() int32func (*ListSampleQuerySetsRequest) GetPageToken
func (x *ListSampleQuerySetsRequest) GetPageToken() stringfunc (*ListSampleQuerySetsRequest) GetParent
func (x *ListSampleQuerySetsRequest) GetParent() stringfunc (*ListSampleQuerySetsRequest) ProtoMessage
func (*ListSampleQuerySetsRequest) ProtoMessage()func (*ListSampleQuerySetsRequest) ProtoReflect
func (x *ListSampleQuerySetsRequest) ProtoReflect() protoreflect.Messagefunc (*ListSampleQuerySetsRequest) Reset
func (x *ListSampleQuerySetsRequest) Reset()func (*ListSampleQuerySetsRequest) String
func (x *ListSampleQuerySetsRequest) String() stringListSampleQuerySetsResponse
type ListSampleQuerySetsResponse struct {
// The [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s.
SampleQuerySets []*SampleQuerySet `protobuf:"bytes,1,rep,name=sample_query_sets,json=sampleQuerySets,proto3" json:"sample_query_sets,omitempty"`
// A token that can be sent as
// [ListSampleQuerySetsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] method.
func (*ListSampleQuerySetsResponse) Descriptor
func (*ListSampleQuerySetsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSampleQuerySetsResponse.ProtoReflect.Descriptor instead.
func (*ListSampleQuerySetsResponse) GetNextPageToken
func (x *ListSampleQuerySetsResponse) GetNextPageToken() stringfunc (*ListSampleQuerySetsResponse) GetSampleQuerySets
func (x *ListSampleQuerySetsResponse) GetSampleQuerySets() []*SampleQuerySetfunc (*ListSampleQuerySetsResponse) ProtoMessage
func (*ListSampleQuerySetsResponse) ProtoMessage()func (*ListSampleQuerySetsResponse) ProtoReflect
func (x *ListSampleQuerySetsResponse) ProtoReflect() protoreflect.Messagefunc (*ListSampleQuerySetsResponse) Reset
func (x *ListSampleQuerySetsResponse) Reset()func (*ListSampleQuerySetsResponse) String
func (x *ListSampleQuerySetsResponse) String() stringListSchemasRequest
type ListSchemasRequest struct {
// Required. The parent data store resource name, in the format of
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of
// [Schema][google.cloud.discoveryengine.v1alpha.Schema]s to return. The
// service may return fewer than this value.
//
// If unspecified, at most 100
// [Schema][google.cloud.discoveryengine.v1alpha.Schema]s are returned.
//
// The maximum value is 1000; values above 1000 are set to 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous
// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas]
// must match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] method.
func (*ListSchemasRequest) Descriptor
func (*ListSchemasRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSchemasRequest.ProtoReflect.Descriptor instead.
func (*ListSchemasRequest) GetPageSize
func (x *ListSchemasRequest) GetPageSize() int32func (*ListSchemasRequest) GetPageToken
func (x *ListSchemasRequest) GetPageToken() stringfunc (*ListSchemasRequest) GetParent
func (x *ListSchemasRequest) GetParent() stringfunc (*ListSchemasRequest) ProtoMessage
func (*ListSchemasRequest) ProtoMessage()func (*ListSchemasRequest) ProtoReflect
func (x *ListSchemasRequest) ProtoReflect() protoreflect.Messagefunc (*ListSchemasRequest) Reset
func (x *ListSchemasRequest) Reset()func (*ListSchemasRequest) String
func (x *ListSchemasRequest) String() stringListSchemasResponse
type ListSchemasResponse struct {
// The [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.
Schemas []*Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
// A token that can be sent as
// [ListSchemasRequest.page_token][google.cloud.discoveryengine.v1alpha.ListSchemasRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] method.
func (*ListSchemasResponse) Descriptor
func (*ListSchemasResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSchemasResponse.ProtoReflect.Descriptor instead.
func (*ListSchemasResponse) GetNextPageToken
func (x *ListSchemasResponse) GetNextPageToken() stringfunc (*ListSchemasResponse) GetSchemas
func (x *ListSchemasResponse) GetSchemas() []*Schemafunc (*ListSchemasResponse) ProtoMessage
func (*ListSchemasResponse) ProtoMessage()func (*ListSchemasResponse) ProtoReflect
func (x *ListSchemasResponse) ProtoReflect() protoreflect.Messagefunc (*ListSchemasResponse) Reset
func (x *ListSchemasResponse) Reset()func (*ListSchemasResponse) String
func (x *ListSchemasResponse) String() stringListServingConfigsRequest
type ListServingConfigsRequest struct {
// Required. Full resource name of the parent resource. Format:
// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Maximum number of results to return. If unspecified, defaults
// to 100. If a value greater than 100 is provided, at most 100 results are
// returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListServingConfigs` call.
// Provide this to retrieve the subsequent page.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request for ListServingConfigs method.
func (*ListServingConfigsRequest) Descriptor
func (*ListServingConfigsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListServingConfigsRequest.ProtoReflect.Descriptor instead.
func (*ListServingConfigsRequest) GetPageSize
func (x *ListServingConfigsRequest) GetPageSize() int32func (*ListServingConfigsRequest) GetPageToken
func (x *ListServingConfigsRequest) GetPageToken() stringfunc (*ListServingConfigsRequest) GetParent
func (x *ListServingConfigsRequest) GetParent() stringfunc (*ListServingConfigsRequest) ProtoMessage
func (*ListServingConfigsRequest) ProtoMessage()func (*ListServingConfigsRequest) ProtoReflect
func (x *ListServingConfigsRequest) ProtoReflect() protoreflect.Messagefunc (*ListServingConfigsRequest) Reset
func (x *ListServingConfigsRequest) Reset()func (*ListServingConfigsRequest) String
func (x *ListServingConfigsRequest) String() stringListServingConfigsResponse
type ListServingConfigsResponse struct {
// All the ServingConfigs for a given dataStore.
ServingConfigs []*ServingConfig `protobuf:"bytes,1,rep,name=serving_configs,json=servingConfigs,proto3" json:"serving_configs,omitempty"`
// Pagination token, if not returned indicates the last page.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for ListServingConfigs method.
func (*ListServingConfigsResponse) Descriptor
func (*ListServingConfigsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListServingConfigsResponse.ProtoReflect.Descriptor instead.
func (*ListServingConfigsResponse) GetNextPageToken
func (x *ListServingConfigsResponse) GetNextPageToken() stringfunc (*ListServingConfigsResponse) GetServingConfigs
func (x *ListServingConfigsResponse) GetServingConfigs() []*ServingConfigfunc (*ListServingConfigsResponse) ProtoMessage
func (*ListServingConfigsResponse) ProtoMessage()func (*ListServingConfigsResponse) ProtoReflect
func (x *ListServingConfigsResponse) ProtoReflect() protoreflect.Messagefunc (*ListServingConfigsResponse) Reset
func (x *ListServingConfigsResponse) Reset()func (*ListServingConfigsResponse) String
func (x *ListServingConfigsResponse) String() stringListSessionsRequest
type ListSessionsRequest struct {
// Required. The data store resource name. Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of results to return. If unspecified, defaults
// to 50. Max allowed value is 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListSessions` call.
// Provide this to retrieve the subsequent page.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// A comma-separated list of fields to filter by, in EBNF grammar.
// The supported fields are:
// * `user_pseudo_id`
// * `state`
// * `display_name`
// * `starred`
// * `is_pinned`
// * `labels`
// * `create_time`
// * `update_time`
//
// Examples:
// "user_pseudo_id = some_id"
// "display_name = \"some_name\""
// "starred = true"
// "is_pinned=true AND (NOT labels:hidden)"
// "create_time > \"1970-01-01T12:00:00Z\""
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// A comma-separated list of fields to order by, sorted in ascending order.
// Use "desc" after a field name for descending.
// Supported fields:
//
// - `update_time`
// - `create_time`
// - `session_name`
// - `is_pinned`
//
// Example:
//
// - "update_time desc"
// - "create_time"
// - "is_pinned desc,update_time desc": list sessions by is_pinned first, then
// by update_time.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request for ListSessions method.
func (*ListSessionsRequest) Descriptor
func (*ListSessionsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSessionsRequest.ProtoReflect.Descriptor instead.
func (*ListSessionsRequest) GetFilter
func (x *ListSessionsRequest) GetFilter() stringfunc (*ListSessionsRequest) GetOrderBy
func (x *ListSessionsRequest) GetOrderBy() stringfunc (*ListSessionsRequest) GetPageSize
func (x *ListSessionsRequest) GetPageSize() int32func (*ListSessionsRequest) GetPageToken
func (x *ListSessionsRequest) GetPageToken() stringfunc (*ListSessionsRequest) GetParent
func (x *ListSessionsRequest) GetParent() stringfunc (*ListSessionsRequest) ProtoMessage
func (*ListSessionsRequest) ProtoMessage()func (*ListSessionsRequest) ProtoReflect
func (x *ListSessionsRequest) ProtoReflect() protoreflect.Messagefunc (*ListSessionsRequest) Reset
func (x *ListSessionsRequest) Reset()func (*ListSessionsRequest) String
func (x *ListSessionsRequest) String() stringListSessionsResponse
type ListSessionsResponse struct {
// All the Sessions for a given data store.
Sessions []*Session `protobuf:"bytes,1,rep,name=sessions,proto3" json:"sessions,omitempty"`
// Pagination token, if not returned indicates the last page.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for ListSessions method.
func (*ListSessionsResponse) Descriptor
func (*ListSessionsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSessionsResponse.ProtoReflect.Descriptor instead.
func (*ListSessionsResponse) GetNextPageToken
func (x *ListSessionsResponse) GetNextPageToken() stringfunc (*ListSessionsResponse) GetSessions
func (x *ListSessionsResponse) GetSessions() []*Sessionfunc (*ListSessionsResponse) ProtoMessage
func (*ListSessionsResponse) ProtoMessage()func (*ListSessionsResponse) ProtoReflect
func (x *ListSessionsResponse) ProtoReflect() protoreflect.Messagefunc (*ListSessionsResponse) Reset
func (x *ListSessionsResponse) Reset()func (*ListSessionsResponse) String
func (x *ListSessionsResponse) String() stringListTargetSitesRequest
type ListTargetSitesRequest struct {
// Required. The parent site search engine resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
//
// If the caller does not have permission to list
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s under this
// site search engine, regardless of whether or not this branch exists, a
// PERMISSION_DENIED error is returned.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Requested page size. Server may return fewer items than requested. If
// unspecified, server will pick an appropriate default. The maximum value is
// 1000; values above 1000 will be coerced to 1000.
//
// If this field is negative, an INVALID_ARGUMENT error is returned.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListTargetSites` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListTargetSites`
// must match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] method.
func (*ListTargetSitesRequest) Descriptor
func (*ListTargetSitesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListTargetSitesRequest.ProtoReflect.Descriptor instead.
func (*ListTargetSitesRequest) GetPageSize
func (x *ListTargetSitesRequest) GetPageSize() int32func (*ListTargetSitesRequest) GetPageToken
func (x *ListTargetSitesRequest) GetPageToken() stringfunc (*ListTargetSitesRequest) GetParent
func (x *ListTargetSitesRequest) GetParent() stringfunc (*ListTargetSitesRequest) ProtoMessage
func (*ListTargetSitesRequest) ProtoMessage()func (*ListTargetSitesRequest) ProtoReflect
func (x *ListTargetSitesRequest) ProtoReflect() protoreflect.Messagefunc (*ListTargetSitesRequest) Reset
func (x *ListTargetSitesRequest) Reset()func (*ListTargetSitesRequest) String
func (x *ListTargetSitesRequest) String() stringListTargetSitesResponse
type ListTargetSitesResponse struct {
// List of TargetSites.
TargetSites []*TargetSite `protobuf:"bytes,1,rep,name=target_sites,json=targetSites,proto3" json:"target_sites,omitempty"`
// A token that can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// The total number of items matching the request.
// This will always be populated in the response.
TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// contains filtered or unexported fields
}Response message for [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] method.
func (*ListTargetSitesResponse) Descriptor
func (*ListTargetSitesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListTargetSitesResponse.ProtoReflect.Descriptor instead.
func (*ListTargetSitesResponse) GetNextPageToken
func (x *ListTargetSitesResponse) GetNextPageToken() stringfunc (*ListTargetSitesResponse) GetTargetSites
func (x *ListTargetSitesResponse) GetTargetSites() []*TargetSitefunc (*ListTargetSitesResponse) GetTotalSize
func (x *ListTargetSitesResponse) GetTotalSize() int32func (*ListTargetSitesResponse) ProtoMessage
func (*ListTargetSitesResponse) ProtoMessage()func (*ListTargetSitesResponse) ProtoReflect
func (x *ListTargetSitesResponse) ProtoReflect() protoreflect.Messagefunc (*ListTargetSitesResponse) Reset
func (x *ListTargetSitesResponse) Reset()func (*ListTargetSitesResponse) String
func (x *ListTargetSitesResponse) String() stringMediaInfo
type MediaInfo struct {
// The media progress time in seconds, if applicable.
// For example, if the end user has finished 90 seconds of a playback video,
// then
// [MediaInfo.media_progress_duration.seconds][google.protobuf.Duration.seconds]
// should be set to 90.
MediaProgressDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=media_progress_duration,json=mediaProgressDuration,proto3" json:"media_progress_duration,omitempty"`
// Media progress should be computed using only the
// [media_progress_duration][google.cloud.discoveryengine.v1alpha.MediaInfo.media_progress_duration]
// relative to the media total length.
//
// This value must be between `[0, 1.0]` inclusive.
//
// If this is not a playback or the progress cannot be computed (e.g. ongoing
// livestream), this field should be unset.
MediaProgressPercentage *float32 `protobuf:"fixed32,2,opt,name=media_progress_percentage,json=mediaProgressPercentage,proto3,oneof" json:"media_progress_percentage,omitempty"`
// contains filtered or unexported fields
}Media-specific user event information.
func (*MediaInfo) Descriptor
Deprecated: Use MediaInfo.ProtoReflect.Descriptor instead.
func (*MediaInfo) GetMediaProgressDuration
func (x *MediaInfo) GetMediaProgressDuration() *durationpb.Durationfunc (*MediaInfo) GetMediaProgressPercentage
func (*MediaInfo) ProtoMessage
func (*MediaInfo) ProtoMessage()func (*MediaInfo) ProtoReflect
func (x *MediaInfo) ProtoReflect() protoreflect.Messagefunc (*MediaInfo) Reset
func (x *MediaInfo) Reset()func (*MediaInfo) String
PageInfo
type PageInfo struct {
// A unique ID of a web page view.
//
// This should be kept the same for all user events triggered from the same
// pageview. For example, an item detail page view could trigger multiple
// events as the user is browsing the page. The `pageview_id` property should
// be kept the same for all these events so that they can be grouped together
// properly.
//
// When using the client side event reporting with JavaScript pixel and Google
// Tag Manager, this value is filled in automatically.
PageviewId string `protobuf:"bytes,1,opt,name=pageview_id,json=pageviewId,proto3" json:"pageview_id,omitempty"`
// The most specific category associated with a category page.
//
// To represent full path of category, use '>' sign to separate different
// hierarchies. If '>' is part of the category name, replace it with
// other character(s).
//
// Category pages include special pages such as sales or promotions. For
// instance, a special sale page may have the category hierarchy:
// `"pageCategory" : "Sales > 2017 Black Friday Deals"`.
//
// Required for `view-category-page` events. Other event types should not set
// this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
PageCategory string `protobuf:"bytes,2,opt,name=page_category,json=pageCategory,proto3" json:"page_category,omitempty"`
// Complete URL (window.location.href) of the user's current page.
//
// When using the client side event reporting with JavaScript pixel and Google
// Tag Manager, this value is filled in automatically. Maximum length 5,000
// characters.
Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
// The referrer URL of the current page.
//
// When using the client side event reporting with JavaScript pixel and Google
// Tag Manager, this value is filled in automatically. However, some browser
// privacy restrictions may cause this field to be empty.
ReferrerUri string `protobuf:"bytes,4,opt,name=referrer_uri,json=referrerUri,proto3" json:"referrer_uri,omitempty"`
// contains filtered or unexported fields
}Detailed page information.
func (*PageInfo) Descriptor
Deprecated: Use PageInfo.ProtoReflect.Descriptor instead.
func (*PageInfo) GetPageCategory
func (*PageInfo) GetPageviewId
func (*PageInfo) GetReferrerUri
func (*PageInfo) GetUri
func (*PageInfo) ProtoMessage
func (*PageInfo) ProtoMessage()func (*PageInfo) ProtoReflect
func (x *PageInfo) ProtoReflect() protoreflect.Messagefunc (*PageInfo) Reset
func (x *PageInfo) Reset()func (*PageInfo) String
PanelInfo
type PanelInfo struct {
// Required. The panel ID.
PanelId string `protobuf:"bytes,2,opt,name=panel_id,json=panelId,proto3" json:"panel_id,omitempty"`
// The display name of the panel.
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The ordered position of the panel, if shown to the user with other panels.
// If set, then
// [total_panels][google.cloud.discoveryengine.v1alpha.PanelInfo.total_panels]
// must also be set.
PanelPosition *int32 `protobuf:"varint,4,opt,name=panel_position,json=panelPosition,proto3,oneof" json:"panel_position,omitempty"`
// The total number of panels, including this one, shown to the user.
// Must be set if
// [panel_position][google.cloud.discoveryengine.v1alpha.PanelInfo.panel_position]
// is set.
TotalPanels *int32 `protobuf:"varint,5,opt,name=total_panels,json=totalPanels,proto3,oneof" json:"total_panels,omitempty"`
// contains filtered or unexported fields
}Detailed panel information associated with a user event.
func (*PanelInfo) Descriptor
Deprecated: Use PanelInfo.ProtoReflect.Descriptor instead.
func (*PanelInfo) GetDisplayName
func (*PanelInfo) GetPanelId
func (*PanelInfo) GetPanelPosition
func (*PanelInfo) GetTotalPanels
func (*PanelInfo) ProtoMessage
func (*PanelInfo) ProtoMessage()func (*PanelInfo) ProtoReflect
func (x *PanelInfo) ProtoReflect() protoreflect.Messagefunc (*PanelInfo) Reset
func (x *PanelInfo) Reset()func (*PanelInfo) String
PauseEngineRequest
type PauseEngineRequest struct {
// Required. The name of the engine to pause.
// Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for pausing training of an engine.
func (*PauseEngineRequest) Descriptor
func (*PauseEngineRequest) Descriptor() ([]byte, []int)Deprecated: Use PauseEngineRequest.ProtoReflect.Descriptor instead.
func (*PauseEngineRequest) GetName
func (x *PauseEngineRequest) GetName() stringfunc (*PauseEngineRequest) ProtoMessage
func (*PauseEngineRequest) ProtoMessage()func (*PauseEngineRequest) ProtoReflect
func (x *PauseEngineRequest) ProtoReflect() protoreflect.Messagefunc (*PauseEngineRequest) Reset
func (x *PauseEngineRequest) Reset()func (*PauseEngineRequest) String
func (x *PauseEngineRequest) String() stringPrincipal
type Principal struct {
// Union field principal. Principal can be a user or a group.
//
// Types that are valid to be assigned to Principal:
//
// *Principal_UserId
// *Principal_GroupId
Principal isPrincipal_Principal `protobuf_oneof:"principal"`
// contains filtered or unexported fields
}Principal identifier of a user or a group.
func (*Principal) Descriptor
Deprecated: Use Principal.ProtoReflect.Descriptor instead.
func (*Principal) GetGroupId
func (*Principal) GetPrincipal
func (x *Principal) GetPrincipal() isPrincipal_Principalfunc (*Principal) GetUserId
func (*Principal) ProtoMessage
func (*Principal) ProtoMessage()func (*Principal) ProtoReflect
func (x *Principal) ProtoReflect() protoreflect.Messagefunc (*Principal) Reset
func (x *Principal) Reset()func (*Principal) String
Principal_GroupId
type Principal_GroupId struct {
// Group identifier.
// For Google Workspace user account, group_id should be the google
// workspace group email.
// For non-google identity provider user account, group_id is the mapped
// group identifier configured during the workforcepool config.
GroupId string `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3,oneof"`
}Principal_UserId
type Principal_UserId struct {
// User identifier.
// For Google Workspace user account, user_id should be the google workspace
// user email.
// For non-google identity provider user account, user_id is the mapped user
// identifier configured during the workforcepool config.
UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3,oneof"`
}ProcessedDocument
type ProcessedDocument struct {
// Output format of the processed document.
//
// Types that are valid to be assigned to ProcessedDataFormat:
//
// *ProcessedDocument_JsonData
ProcessedDataFormat isProcessedDocument_ProcessedDataFormat `protobuf_oneof:"processed_data_format"`
// Required. Full resource name of the referenced document, in the format
// `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// contains filtered or unexported fields
}Document captures all raw metadata information of items to be recommended or searched.
func (*ProcessedDocument) Descriptor
func (*ProcessedDocument) Descriptor() ([]byte, []int)Deprecated: Use ProcessedDocument.ProtoReflect.Descriptor instead.
func (*ProcessedDocument) GetDocument
func (x *ProcessedDocument) GetDocument() stringfunc (*ProcessedDocument) GetJsonData
func (x *ProcessedDocument) GetJsonData() stringfunc (*ProcessedDocument) GetProcessedDataFormat
func (x *ProcessedDocument) GetProcessedDataFormat() isProcessedDocument_ProcessedDataFormatfunc (*ProcessedDocument) ProtoMessage
func (*ProcessedDocument) ProtoMessage()func (*ProcessedDocument) ProtoReflect
func (x *ProcessedDocument) ProtoReflect() protoreflect.Messagefunc (*ProcessedDocument) Reset
func (x *ProcessedDocument) Reset()func (*ProcessedDocument) String
func (x *ProcessedDocument) String() stringProcessedDocument_JsonData
type ProcessedDocument_JsonData struct {
// The JSON string representation of the processed document.
JsonData string `protobuf:"bytes,2,opt,name=json_data,json=jsonData,proto3,oneof"`
}Project
type Project struct {
// Output only. Full resource name of the project, for example
// `projects/{project_number}`.
// Note that when making requests, project number and project id are both
// acceptable, but the server will always respond in project number.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The timestamp when this project is created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The timestamp when this project is successfully provisioned.
// Empty value means this project is still provisioning and is not ready for
// use.
ProvisionCompletionTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=provision_completion_time,json=provisionCompletionTime,proto3" json:"provision_completion_time,omitempty"`
// Output only. A map of terms of services. The key is the `id` of
// [ServiceTerms][google.cloud.discoveryengine.v1alpha.Project.ServiceTerms].
ServiceTermsMap map[string]*Project_ServiceTerms `protobuf:"bytes,4,rep,name=service_terms_map,json=serviceTermsMap,proto3" json:"service_terms_map,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Metadata and configurations for a Google Cloud project in the service.
func (*Project) Descriptor
Deprecated: Use Project.ProtoReflect.Descriptor instead.
func (*Project) GetCreateTime
func (x *Project) GetCreateTime() *timestamppb.Timestampfunc (*Project) GetName
func (*Project) GetProvisionCompletionTime
func (x *Project) GetProvisionCompletionTime() *timestamppb.Timestampfunc (*Project) GetServiceTermsMap
func (x *Project) GetServiceTermsMap() map[string]*Project_ServiceTermsfunc (*Project) ProtoMessage
func (*Project) ProtoMessage()func (*Project) ProtoReflect
func (x *Project) ProtoReflect() protoreflect.Messagefunc (*Project) Reset
func (x *Project) Reset()func (*Project) String
ProjectServiceClient
type ProjectServiceClient interface {
// Gets a [Project][google.cloud.discoveryengine.v1alpha.Project].
// Returns NOT_FOUND when the project is not yet created.
GetProject(ctx context.Context, in *GetProjectRequest, opts ...grpc.CallOption) (*Project, error)
// Provisions the project resource. During the
// process, related systems will get prepared and initialized.
//
// Caller must read the [Terms for data
// use](https://cloud.google.com/retail/data-use-terms), and optionally
// specify in request to provide consent to that service terms.
ProvisionProject(ctx context.Context, in *ProvisionProjectRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates service terms for this project.
//
// This method can be used to retroactively accept the latest terms.
//
// Terms available for update:
//
// * [Terms for data use](https://cloud.google.com/retail/data-use-terms)
ReportConsentChange(ctx context.Context, in *ReportConsentChangeRequest, opts ...grpc.CallOption) (*Project, error)
}ProjectServiceClient is the client API for ProjectService 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 NewProjectServiceClient
func NewProjectServiceClient(cc grpc.ClientConnInterface) ProjectServiceClientProjectServiceServer
type ProjectServiceServer interface {
// Gets a [Project][google.cloud.discoveryengine.v1alpha.Project].
// Returns NOT_FOUND when the project is not yet created.
GetProject(context.Context, *GetProjectRequest) (*Project, error)
// Provisions the project resource. During the
// process, related systems will get prepared and initialized.
//
// Caller must read the [Terms for data
// use](https://cloud.google.com/retail/data-use-terms), and optionally
// specify in request to provide consent to that service terms.
ProvisionProject(context.Context, *ProvisionProjectRequest) (*longrunningpb.Operation, error)
// Updates service terms for this project.
//
// This method can be used to retroactively accept the latest terms.
//
// Terms available for update:
//
// * [Terms for data use](https://cloud.google.com/retail/data-use-terms)
ReportConsentChange(context.Context, *ReportConsentChangeRequest) (*Project, error)
}ProjectServiceServer is the server API for ProjectService service. All implementations should embed UnimplementedProjectServiceServer for forward compatibility
Project_ServiceTerms
type Project_ServiceTerms struct {
// The unique identifier of this terms of service.
// Available terms:
//
// * `GA_DATA_USE_TERMS`: [Terms for data
// use](https://cloud.google.com/retail/data-use-terms). When using this as
// `id`, the acceptable
// [version][google.cloud.discoveryengine.v1alpha.Project.ServiceTerms.version]
// to provide is `2022-11-23`.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// The version string of the terms of service.
// For acceptable values, see the comments for
// [id][google.cloud.discoveryengine.v1alpha.Project.ServiceTerms.id] above.
Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
// Whether the project has accepted/rejected the service terms or it is
// still pending.
State Project_ServiceTerms_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1alpha.Project_ServiceTerms_State" json:"state,omitempty"`
// The last time when the project agreed to the terms of service.
AcceptTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=accept_time,json=acceptTime,proto3" json:"accept_time,omitempty"`
// The last time when the project declined or revoked the agreement to terms
// of service.
DeclineTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=decline_time,json=declineTime,proto3" json:"decline_time,omitempty"`
// contains filtered or unexported fields
}Metadata about the terms of service.
func (*Project_ServiceTerms) Descriptor
func (*Project_ServiceTerms) Descriptor() ([]byte, []int)Deprecated: Use Project_ServiceTerms.ProtoReflect.Descriptor instead.
func (*Project_ServiceTerms) GetAcceptTime
func (x *Project_ServiceTerms) GetAcceptTime() *timestamppb.Timestampfunc (*Project_ServiceTerms) GetDeclineTime
func (x *Project_ServiceTerms) GetDeclineTime() *timestamppb.Timestampfunc (*Project_ServiceTerms) GetId
func (x *Project_ServiceTerms) GetId() stringfunc (*Project_ServiceTerms) GetState
func (x *Project_ServiceTerms) GetState() Project_ServiceTerms_Statefunc (*Project_ServiceTerms) GetVersion
func (x *Project_ServiceTerms) GetVersion() stringfunc (*Project_ServiceTerms) ProtoMessage
func (*Project_ServiceTerms) ProtoMessage()func (*Project_ServiceTerms) ProtoReflect
func (x *Project_ServiceTerms) ProtoReflect() protoreflect.Messagefunc (*Project_ServiceTerms) Reset
func (x *Project_ServiceTerms) Reset()func (*Project_ServiceTerms) String
func (x *Project_ServiceTerms) String() stringProject_ServiceTerms_State
type Project_ServiceTerms_State int32The agreement states this terms of service.
Project_ServiceTerms_STATE_UNSPECIFIED, Project_ServiceTerms_TERMS_ACCEPTED, Project_ServiceTerms_TERMS_PENDING, Project_ServiceTerms_TERMS_DECLINED
const (
// The default value of the enum. This value is not actually used.
Project_ServiceTerms_STATE_UNSPECIFIED Project_ServiceTerms_State = 0
// The project has given consent to the terms of service.
Project_ServiceTerms_TERMS_ACCEPTED Project_ServiceTerms_State = 1
// The project is pending to review and accept the terms of service.
Project_ServiceTerms_TERMS_PENDING Project_ServiceTerms_State = 2
// The project has declined or revoked the agreement to terms of service.
Project_ServiceTerms_TERMS_DECLINED Project_ServiceTerms_State = 3
)func (Project_ServiceTerms_State) Descriptor
func (Project_ServiceTerms_State) Descriptor() protoreflect.EnumDescriptorfunc (Project_ServiceTerms_State) Enum
func (x Project_ServiceTerms_State) Enum() *Project_ServiceTerms_Statefunc (Project_ServiceTerms_State) EnumDescriptor
func (Project_ServiceTerms_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Project_ServiceTerms_State.Descriptor instead.
func (Project_ServiceTerms_State) Number
func (x Project_ServiceTerms_State) Number() protoreflect.EnumNumberfunc (Project_ServiceTerms_State) String
func (x Project_ServiceTerms_State) String() stringfunc (Project_ServiceTerms_State) Type
func (Project_ServiceTerms_State) Type() protoreflect.EnumTypeProvisionProjectMetadata
type ProvisionProjectMetadata struct {
// contains filtered or unexported fields
}Metadata associated with a project provision operation.
func (*ProvisionProjectMetadata) Descriptor
func (*ProvisionProjectMetadata) Descriptor() ([]byte, []int)Deprecated: Use ProvisionProjectMetadata.ProtoReflect.Descriptor instead.
func (*ProvisionProjectMetadata) ProtoMessage
func (*ProvisionProjectMetadata) ProtoMessage()func (*ProvisionProjectMetadata) ProtoReflect
func (x *ProvisionProjectMetadata) ProtoReflect() protoreflect.Messagefunc (*ProvisionProjectMetadata) Reset
func (x *ProvisionProjectMetadata) Reset()func (*ProvisionProjectMetadata) String
func (x *ProvisionProjectMetadata) String() stringProvisionProjectRequest
type ProvisionProjectRequest struct {
// Required. Full resource name of a
// [Project][google.cloud.discoveryengine.v1alpha.Project], such as
// `projects/{project_id_or_number}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Set to `true` to specify that caller has read and would like to
// give consent to the [Terms for data
// use](https://cloud.google.com/retail/data-use-terms).
AcceptDataUseTerms bool `protobuf:"varint,2,opt,name=accept_data_use_terms,json=acceptDataUseTerms,proto3" json:"accept_data_use_terms,omitempty"`
// Required. The version of the [Terms for data
// use](https://cloud.google.com/retail/data-use-terms) that caller has read
// and would like to give consent to.
//
// Acceptable version is `2022-11-23`, and this may change over time.
DataUseTermsVersion string `protobuf:"bytes,3,opt,name=data_use_terms_version,json=dataUseTermsVersion,proto3" json:"data_use_terms_version,omitempty"`
// contains filtered or unexported fields
}Request for [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1alpha.ProjectService.ProvisionProject] method.
func (*ProvisionProjectRequest) Descriptor
func (*ProvisionProjectRequest) Descriptor() ([]byte, []int)Deprecated: Use ProvisionProjectRequest.ProtoReflect.Descriptor instead.
func (*ProvisionProjectRequest) GetAcceptDataUseTerms
func (x *ProvisionProjectRequest) GetAcceptDataUseTerms() boolfunc (*ProvisionProjectRequest) GetDataUseTermsVersion
func (x *ProvisionProjectRequest) GetDataUseTermsVersion() stringfunc (*ProvisionProjectRequest) GetName
func (x *ProvisionProjectRequest) GetName() stringfunc (*ProvisionProjectRequest) ProtoMessage
func (*ProvisionProjectRequest) ProtoMessage()func (*ProvisionProjectRequest) ProtoReflect
func (x *ProvisionProjectRequest) ProtoReflect() protoreflect.Messagefunc (*ProvisionProjectRequest) Reset
func (x *ProvisionProjectRequest) Reset()func (*ProvisionProjectRequest) String
func (x *ProvisionProjectRequest) String() stringPurgeCompletionSuggestionsMetadata
type PurgeCompletionSuggestionsMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.
func (*PurgeCompletionSuggestionsMetadata) Descriptor
func (*PurgeCompletionSuggestionsMetadata) Descriptor() ([]byte, []int)Deprecated: Use PurgeCompletionSuggestionsMetadata.ProtoReflect.Descriptor instead.
func (*PurgeCompletionSuggestionsMetadata) GetCreateTime
func (x *PurgeCompletionSuggestionsMetadata) GetCreateTime() *timestamppb.Timestampfunc (*PurgeCompletionSuggestionsMetadata) GetUpdateTime
func (x *PurgeCompletionSuggestionsMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*PurgeCompletionSuggestionsMetadata) ProtoMessage
func (*PurgeCompletionSuggestionsMetadata) ProtoMessage()func (*PurgeCompletionSuggestionsMetadata) ProtoReflect
func (x *PurgeCompletionSuggestionsMetadata) ProtoReflect() protoreflect.Messagefunc (*PurgeCompletionSuggestionsMetadata) Reset
func (x *PurgeCompletionSuggestionsMetadata) Reset()func (*PurgeCompletionSuggestionsMetadata) String
func (x *PurgeCompletionSuggestionsMetadata) String() stringPurgeCompletionSuggestionsRequest
type PurgeCompletionSuggestionsRequest struct {
// Required. The parent data store resource name for which to purge completion
// suggestions. Follows pattern
// projects/*/locations/*/collections/*/dataStores/*.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// contains filtered or unexported fields
}Request message for [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions] method.
func (*PurgeCompletionSuggestionsRequest) Descriptor
func (*PurgeCompletionSuggestionsRequest) Descriptor() ([]byte, []int)Deprecated: Use PurgeCompletionSuggestionsRequest.ProtoReflect.Descriptor instead.
func (*PurgeCompletionSuggestionsRequest) GetParent
func (x *PurgeCompletionSuggestionsRequest) GetParent() stringfunc (*PurgeCompletionSuggestionsRequest) ProtoMessage
func (*PurgeCompletionSuggestionsRequest) ProtoMessage()func (*PurgeCompletionSuggestionsRequest) ProtoReflect
func (x *PurgeCompletionSuggestionsRequest) ProtoReflect() protoreflect.Messagefunc (*PurgeCompletionSuggestionsRequest) Reset
func (x *PurgeCompletionSuggestionsRequest) Reset()func (*PurgeCompletionSuggestionsRequest) String
func (x *PurgeCompletionSuggestionsRequest) String() stringPurgeCompletionSuggestionsResponse
type PurgeCompletionSuggestionsResponse struct {
// Whether the completion suggestions were successfully purged.
PurgeSucceeded bool `protobuf:"varint,1,opt,name=purge_succeeded,json=purgeSucceeded,proto3" json:"purge_succeeded,omitempty"`
// A sample of errors encountered while processing the request.
ErrorSamples []*status.Status `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// contains filtered or unexported fields
}Response message for [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions] method.
func (*PurgeCompletionSuggestionsResponse) Descriptor
func (*PurgeCompletionSuggestionsResponse) Descriptor() ([]byte, []int)Deprecated: Use PurgeCompletionSuggestionsResponse.ProtoReflect.Descriptor instead.
func (*PurgeCompletionSuggestionsResponse) GetErrorSamples
func (x *PurgeCompletionSuggestionsResponse) GetErrorSamples() []*status.Statusfunc (*PurgeCompletionSuggestionsResponse) GetPurgeSucceeded
func (x *PurgeCompletionSuggestionsResponse) GetPurgeSucceeded() boolfunc (*PurgeCompletionSuggestionsResponse) ProtoMessage
func (*PurgeCompletionSuggestionsResponse) ProtoMessage()func (*PurgeCompletionSuggestionsResponse) ProtoReflect
func (x *PurgeCompletionSuggestionsResponse) ProtoReflect() protoreflect.Messagefunc (*PurgeCompletionSuggestionsResponse) Reset
func (x *PurgeCompletionSuggestionsResponse) Reset()func (*PurgeCompletionSuggestionsResponse) String
func (x *PurgeCompletionSuggestionsResponse) String() stringPurgeDocumentsMetadata
type PurgeDocumentsMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Count of entries that were deleted successfully.
SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
// Count of entries that encountered errors while processing.
FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
// Count of entries that were ignored as entries were not found.
IgnoredCount int64 `protobuf:"varint,5,opt,name=ignored_count,json=ignoredCount,proto3" json:"ignored_count,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*PurgeDocumentsMetadata) Descriptor
func (*PurgeDocumentsMetadata) Descriptor() ([]byte, []int)Deprecated: Use PurgeDocumentsMetadata.ProtoReflect.Descriptor instead.
func (*PurgeDocumentsMetadata) GetCreateTime
func (x *PurgeDocumentsMetadata) GetCreateTime() *timestamppb.Timestampfunc (*PurgeDocumentsMetadata) GetFailureCount
func (x *PurgeDocumentsMetadata) GetFailureCount() int64func (*PurgeDocumentsMetadata) GetIgnoredCount
func (x *PurgeDocumentsMetadata) GetIgnoredCount() int64func (*PurgeDocumentsMetadata) GetSuccessCount
func (x *PurgeDocumentsMetadata) GetSuccessCount() int64func (*PurgeDocumentsMetadata) GetUpdateTime
func (x *PurgeDocumentsMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*PurgeDocumentsMetadata) ProtoMessage
func (*PurgeDocumentsMetadata) ProtoMessage()func (*PurgeDocumentsMetadata) ProtoReflect
func (x *PurgeDocumentsMetadata) ProtoReflect() protoreflect.Messagefunc (*PurgeDocumentsMetadata) Reset
func (x *PurgeDocumentsMetadata) Reset()func (*PurgeDocumentsMetadata) String
func (x *PurgeDocumentsMetadata) String() stringPurgeDocumentsRequest
type PurgeDocumentsRequest struct {
// The desired input source for the purging documents based on document IDs.
//
// Types that are valid to be assigned to Source:
//
// *PurgeDocumentsRequest_GcsSource
// *PurgeDocumentsRequest_InlineSource_
Source isPurgeDocumentsRequest_Source `protobuf_oneof:"source"`
// Required. The parent resource name, such as
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Filter matching documents to purge. Only currently supported
// value is
// `*` (all items).
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// The desired location of errors incurred during the purge.
ErrorConfig *PurgeErrorConfig `protobuf:"bytes,7,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// Actually performs the purge. If `force` is set to false, return the
// expected purge count without deleting any documents.
Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] method.
func (*PurgeDocumentsRequest) Descriptor
func (*PurgeDocumentsRequest) Descriptor() ([]byte, []int)Deprecated: Use PurgeDocumentsRequest.ProtoReflect.Descriptor instead.
func (*PurgeDocumentsRequest) GetErrorConfig
func (x *PurgeDocumentsRequest) GetErrorConfig() *PurgeErrorConfigfunc (*PurgeDocumentsRequest) GetFilter
func (x *PurgeDocumentsRequest) GetFilter() stringfunc (*PurgeDocumentsRequest) GetForce
func (x *PurgeDocumentsRequest) GetForce() boolfunc (*PurgeDocumentsRequest) GetGcsSource
func (x *PurgeDocumentsRequest) GetGcsSource() *GcsSourcefunc (*PurgeDocumentsRequest) GetInlineSource
func (x *PurgeDocumentsRequest) GetInlineSource() *PurgeDocumentsRequest_InlineSourcefunc (*PurgeDocumentsRequest) GetParent
func (x *PurgeDocumentsRequest) GetParent() stringfunc (*PurgeDocumentsRequest) GetSource
func (x *PurgeDocumentsRequest) GetSource() isPurgeDocumentsRequest_Sourcefunc (*PurgeDocumentsRequest) ProtoMessage
func (*PurgeDocumentsRequest) ProtoMessage()func (*PurgeDocumentsRequest) ProtoReflect
func (x *PurgeDocumentsRequest) ProtoReflect() protoreflect.Messagefunc (*PurgeDocumentsRequest) Reset
func (x *PurgeDocumentsRequest) Reset()func (*PurgeDocumentsRequest) String
func (x *PurgeDocumentsRequest) String() stringPurgeDocumentsRequest_GcsSource
type PurgeDocumentsRequest_GcsSource struct {
// Cloud Storage location for the input content.
// Supported `data_schema`:
// * `document_id`: One valid
// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
GcsSource *GcsSource `protobuf:"bytes,5,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}PurgeDocumentsRequest_InlineSource
type PurgeDocumentsRequest_InlineSource struct {
// Required. A list of full resource name of documents to purge. In the
// format
// `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
// Recommended max of 100 items.
Documents []string `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
// contains filtered or unexported fields
}The inline source for the input config for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] method.
func (*PurgeDocumentsRequest_InlineSource) Descriptor
func (*PurgeDocumentsRequest_InlineSource) Descriptor() ([]byte, []int)Deprecated: Use PurgeDocumentsRequest_InlineSource.ProtoReflect.Descriptor instead.
func (*PurgeDocumentsRequest_InlineSource) GetDocuments
func (x *PurgeDocumentsRequest_InlineSource) GetDocuments() []stringfunc (*PurgeDocumentsRequest_InlineSource) ProtoMessage
func (*PurgeDocumentsRequest_InlineSource) ProtoMessage()func (*PurgeDocumentsRequest_InlineSource) ProtoReflect
func (x *PurgeDocumentsRequest_InlineSource) ProtoReflect() protoreflect.Messagefunc (*PurgeDocumentsRequest_InlineSource) Reset
func (x *PurgeDocumentsRequest_InlineSource) Reset()func (*PurgeDocumentsRequest_InlineSource) String
func (x *PurgeDocumentsRequest_InlineSource) String() stringPurgeDocumentsRequest_InlineSource_
type PurgeDocumentsRequest_InlineSource_ struct {
// Inline source for the input content for purge.
InlineSource *PurgeDocumentsRequest_InlineSource `protobuf:"bytes,6,opt,name=inline_source,json=inlineSource,proto3,oneof"`
}PurgeDocumentsResponse
type PurgeDocumentsResponse struct {
// The total count of documents purged as a result of the operation.
PurgeCount int64 `protobuf:"varint,1,opt,name=purge_count,json=purgeCount,proto3" json:"purge_count,omitempty"`
// A sample of document names that will be deleted. Only populated if `force`
// is set to false. A max of 100 names will be returned and the names are
// chosen at random.
PurgeSample []string `protobuf:"bytes,2,rep,name=purge_sample,json=purgeSample,proto3" json:"purge_sample,omitempty"`
// contains filtered or unexported fields
}Response message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
func (*PurgeDocumentsResponse) Descriptor
func (*PurgeDocumentsResponse) Descriptor() ([]byte, []int)Deprecated: Use PurgeDocumentsResponse.ProtoReflect.Descriptor instead.
func (*PurgeDocumentsResponse) GetPurgeCount
func (x *PurgeDocumentsResponse) GetPurgeCount() int64func (*PurgeDocumentsResponse) GetPurgeSample
func (x *PurgeDocumentsResponse) GetPurgeSample() []stringfunc (*PurgeDocumentsResponse) ProtoMessage
func (*PurgeDocumentsResponse) ProtoMessage()func (*PurgeDocumentsResponse) ProtoReflect
func (x *PurgeDocumentsResponse) ProtoReflect() protoreflect.Messagefunc (*PurgeDocumentsResponse) Reset
func (x *PurgeDocumentsResponse) Reset()func (*PurgeDocumentsResponse) String
func (x *PurgeDocumentsResponse) String() stringPurgeErrorConfig
type PurgeErrorConfig struct {
// Required. Errors destination.
//
// Types that are valid to be assigned to Destination:
//
// *PurgeErrorConfig_GcsPrefix
Destination isPurgeErrorConfig_Destination `protobuf_oneof:"destination"`
// contains filtered or unexported fields
}Configuration of destination for Purge related errors.
func (*PurgeErrorConfig) Descriptor
func (*PurgeErrorConfig) Descriptor() ([]byte, []int)Deprecated: Use PurgeErrorConfig.ProtoReflect.Descriptor instead.
func (*PurgeErrorConfig) GetDestination
func (x *PurgeErrorConfig) GetDestination() isPurgeErrorConfig_Destinationfunc (*PurgeErrorConfig) GetGcsPrefix
func (x *PurgeErrorConfig) GetGcsPrefix() stringfunc (*PurgeErrorConfig) ProtoMessage
func (*PurgeErrorConfig) ProtoMessage()func (*PurgeErrorConfig) ProtoReflect
func (x *PurgeErrorConfig) ProtoReflect() protoreflect.Messagefunc (*PurgeErrorConfig) Reset
func (x *PurgeErrorConfig) Reset()func (*PurgeErrorConfig) String
func (x *PurgeErrorConfig) String() stringPurgeErrorConfig_GcsPrefix
type PurgeErrorConfig_GcsPrefix struct {
// Cloud Storage prefix for purge errors. This must be an empty,
// existing Cloud Storage directory. Purge errors are written to
// sharded files in this directory, one per line, as a JSON-encoded
// `google.rpc.Status` message.
GcsPrefix string `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}PurgeSuggestionDenyListEntriesMetadata
type PurgeSuggestionDenyListEntriesMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
func (*PurgeSuggestionDenyListEntriesMetadata) Descriptor
func (*PurgeSuggestionDenyListEntriesMetadata) Descriptor() ([]byte, []int)Deprecated: Use PurgeSuggestionDenyListEntriesMetadata.ProtoReflect.Descriptor instead.
func (*PurgeSuggestionDenyListEntriesMetadata) GetCreateTime
func (x *PurgeSuggestionDenyListEntriesMetadata) GetCreateTime() *timestamppb.Timestampfunc (*PurgeSuggestionDenyListEntriesMetadata) GetUpdateTime
func (x *PurgeSuggestionDenyListEntriesMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*PurgeSuggestionDenyListEntriesMetadata) ProtoMessage
func (*PurgeSuggestionDenyListEntriesMetadata) ProtoMessage()func (*PurgeSuggestionDenyListEntriesMetadata) ProtoReflect
func (x *PurgeSuggestionDenyListEntriesMetadata) ProtoReflect() protoreflect.Messagefunc (*PurgeSuggestionDenyListEntriesMetadata) Reset
func (x *PurgeSuggestionDenyListEntriesMetadata) Reset()func (*PurgeSuggestionDenyListEntriesMetadata) String
func (x *PurgeSuggestionDenyListEntriesMetadata) String() stringPurgeSuggestionDenyListEntriesRequest
type PurgeSuggestionDenyListEntriesRequest struct {
// Required. The parent data store resource name for which to import denylist
// entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// contains filtered or unexported fields
}Request message for [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] method.
func (*PurgeSuggestionDenyListEntriesRequest) Descriptor
func (*PurgeSuggestionDenyListEntriesRequest) Descriptor() ([]byte, []int)Deprecated: Use PurgeSuggestionDenyListEntriesRequest.ProtoReflect.Descriptor instead.
func (*PurgeSuggestionDenyListEntriesRequest) GetParent
func (x *PurgeSuggestionDenyListEntriesRequest) GetParent() stringfunc (*PurgeSuggestionDenyListEntriesRequest) ProtoMessage
func (*PurgeSuggestionDenyListEntriesRequest) ProtoMessage()func (*PurgeSuggestionDenyListEntriesRequest) ProtoReflect
func (x *PurgeSuggestionDenyListEntriesRequest) ProtoReflect() protoreflect.Messagefunc (*PurgeSuggestionDenyListEntriesRequest) Reset
func (x *PurgeSuggestionDenyListEntriesRequest) Reset()func (*PurgeSuggestionDenyListEntriesRequest) String
func (x *PurgeSuggestionDenyListEntriesRequest) String() stringPurgeSuggestionDenyListEntriesResponse
type PurgeSuggestionDenyListEntriesResponse struct {
// Number of suggestion deny list entries purged.
PurgeCount int64 `protobuf:"varint,1,opt,name=purge_count,json=purgeCount,proto3" json:"purge_count,omitempty"`
// A sample of errors encountered while processing the request.
ErrorSamples []*status.Status `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// contains filtered or unexported fields
}Response message for [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] method.
func (*PurgeSuggestionDenyListEntriesResponse) Descriptor
func (*PurgeSuggestionDenyListEntriesResponse) Descriptor() ([]byte, []int)Deprecated: Use PurgeSuggestionDenyListEntriesResponse.ProtoReflect.Descriptor instead.
func (*PurgeSuggestionDenyListEntriesResponse) GetErrorSamples
func (x *PurgeSuggestionDenyListEntriesResponse) GetErrorSamples() []*status.Statusfunc (*PurgeSuggestionDenyListEntriesResponse) GetPurgeCount
func (x *PurgeSuggestionDenyListEntriesResponse) GetPurgeCount() int64func (*PurgeSuggestionDenyListEntriesResponse) ProtoMessage
func (*PurgeSuggestionDenyListEntriesResponse) ProtoMessage()func (*PurgeSuggestionDenyListEntriesResponse) ProtoReflect
func (x *PurgeSuggestionDenyListEntriesResponse) ProtoReflect() protoreflect.Messagefunc (*PurgeSuggestionDenyListEntriesResponse) Reset
func (x *PurgeSuggestionDenyListEntriesResponse) Reset()func (*PurgeSuggestionDenyListEntriesResponse) String
func (x *PurgeSuggestionDenyListEntriesResponse) String() stringPurgeUserEventsMetadata
type PurgeUserEventsMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Count of entries that were deleted successfully.
SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
// Count of entries that encountered errors while processing.
FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*PurgeUserEventsMetadata) Descriptor
func (*PurgeUserEventsMetadata) Descriptor() ([]byte, []int)Deprecated: Use PurgeUserEventsMetadata.ProtoReflect.Descriptor instead.
func (*PurgeUserEventsMetadata) GetCreateTime
func (x *PurgeUserEventsMetadata) GetCreateTime() *timestamppb.Timestampfunc (*PurgeUserEventsMetadata) GetFailureCount
func (x *PurgeUserEventsMetadata) GetFailureCount() int64func (*PurgeUserEventsMetadata) GetSuccessCount
func (x *PurgeUserEventsMetadata) GetSuccessCount() int64func (*PurgeUserEventsMetadata) GetUpdateTime
func (x *PurgeUserEventsMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*PurgeUserEventsMetadata) ProtoMessage
func (*PurgeUserEventsMetadata) ProtoMessage()func (*PurgeUserEventsMetadata) ProtoReflect
func (x *PurgeUserEventsMetadata) ProtoReflect() protoreflect.Messagefunc (*PurgeUserEventsMetadata) Reset
func (x *PurgeUserEventsMetadata) Reset()func (*PurgeUserEventsMetadata) String
func (x *PurgeUserEventsMetadata) String() stringPurgeUserEventsRequest
type PurgeUserEventsRequest struct {
// Required. The resource name of the catalog under which the events are
// created. The format is
// `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The filter string to specify the events to be deleted with a
// length limit of 5,000 characters. The eligible fields for filtering are:
//
// * `eventType`: Double quoted
// [UserEvent.event_type][google.cloud.discoveryengine.v1alpha.UserEvent.event_type]
// string.
// - `eventTime`: in ISO 8601 "zulu" format.
// - `userPseudoId`: Double quoted string. Specifying this will delete all
// events associated with a visitor.
// - `userId`: Double quoted string. Specifying this will delete all events
// associated with a user.
//
// Examples:
//
// - Deleting all events in a time range:
// `eventTime > "2012-04-23T18:25:43.511Z"
// eventTime < "2012-04-23t18:30:43.511z"`="" -="" deleting="" specific="" eventtype:="" `eventtype="search" `="" -="" deleting="" all="" events="" for="" a="" specific="" visitor:="" `userpseudoid="visitor1024" `="" -="" deleting="" all="" events="" inside="" a="" datastore:="" `*`="" the="" filtering="" fields="" are="" assumed="" to="" have="" an="" implicit="" and.="" filter="">string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// The `force` field is currently not supported. Purge user event requests
// will permanently delete all purgeable events. Once the development is
// complete:
// If `force` is set to false, the method will return the expected
// purge count without deleting any user events. This field will default to
// false if not included in the request.
Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}Request message for PurgeUserEvents method.
func (*PurgeUserEventsRequest) Descriptor
func (*PurgeUserEventsRequest) Descriptor() ([]byte, []int)Deprecated: Use PurgeUserEventsRequest.ProtoReflect.Descriptor instead.
func (*PurgeUserEventsRequest) GetFilter
func (x *PurgeUserEventsRequest) GetFilter() stringfunc (*PurgeUserEventsRequest) GetForce
func (x *PurgeUserEventsRequest) GetForce() boolfunc (*PurgeUserEventsRequest) GetParent
func (x *PurgeUserEventsRequest) GetParent() stringfunc (*PurgeUserEventsRequest) ProtoMessage
func (*PurgeUserEventsRequest) ProtoMessage()func (*PurgeUserEventsRequest) ProtoReflect
func (x *PurgeUserEventsRequest) ProtoReflect() protoreflect.Messagefunc (*PurgeUserEventsRequest) Reset
func (x *PurgeUserEventsRequest) Reset()func (*PurgeUserEventsRequest) String
func (x *PurgeUserEventsRequest) String() stringPurgeUserEventsResponse
type PurgeUserEventsResponse struct {
// The total count of events purged as a result of the operation.
PurgeCount int64 `protobuf:"varint,1,opt,name=purge_count,json=purgeCount,proto3" json:"purge_count,omitempty"`
// contains filtered or unexported fields
}Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
func (*PurgeUserEventsResponse) Descriptor
func (*PurgeUserEventsResponse) Descriptor() ([]byte, []int)Deprecated: Use PurgeUserEventsResponse.ProtoReflect.Descriptor instead.
func (*PurgeUserEventsResponse) GetPurgeCount
func (x *PurgeUserEventsResponse) GetPurgeCount() int64func (*PurgeUserEventsResponse) ProtoMessage
func (*PurgeUserEventsResponse) ProtoMessage()func (*PurgeUserEventsResponse) ProtoReflect
func (x *PurgeUserEventsResponse) ProtoReflect() protoreflect.Messagefunc (*PurgeUserEventsResponse) Reset
func (x *PurgeUserEventsResponse) Reset()func (*PurgeUserEventsResponse) String
func (x *PurgeUserEventsResponse) String() stringQualityMetrics
type QualityMetrics struct {
// Recall per document, at various top-k cutoff levels.
//
// Recall is the fraction of relevant documents retrieved out of all
// relevant documents.
//
// Example (top-5):
// - For a single
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], If 3 out
// of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
DocRecall *QualityMetrics_TopkMetrics `protobuf:"bytes,1,opt,name=doc_recall,json=docRecall,proto3" json:"doc_recall,omitempty"`
// Precision per document, at various top-k cutoff levels.
//
// Precision is the fraction of retrieved documents that are relevant.
//
// Example (top-5):
// - For a single
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], If 4 out
// of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 =
// 0.8
DocPrecision *QualityMetrics_TopkMetrics `protobuf:"bytes,2,opt,name=doc_precision,json=docPrecision,proto3" json:"doc_precision,omitempty"`
// Normalized discounted cumulative gain (NDCG) per document, at various top-k
// cutoff levels.
//
// NDCG measures the ranking quality, giving higher relevance to top
// results.
//
// Example (top-3):
//
// Suppose [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]
// with three retrieved documents (D1, D2, D3) and binary relevance
// judgements (1 for relevant, 0 for not relevant):
//
// Retrieved: [D3 (0), D1 (1), D2 (1)]
// Ideal: [D1 (1), D2 (1), D3 (0)]
//
// Calculate NDCG@3 for each
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]:
// * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
// * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
// * NDCG@3: 1.13/1.63 = 0.693
DocNdcg *QualityMetrics_TopkMetrics `protobuf:"bytes,3,opt,name=doc_ndcg,json=docNdcg,proto3" json:"doc_ndcg,omitempty"`
// Recall per page, at various top-k cutoff levels.
//
// Recall is the fraction of relevant pages retrieved out of all relevant
// pages.
//
// Example (top-5):
// - For a single
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], if 3 out
// of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
PageRecall *QualityMetrics_TopkMetrics `protobuf:"bytes,4,opt,name=page_recall,json=pageRecall,proto3" json:"page_recall,omitempty"`
// Normalized discounted cumulative gain (NDCG) per page, at various top-k
// cutoff levels.
//
// NDCG measures the ranking quality, giving higher relevance to top
// results.
//
// Example (top-3):
//
// Suppose [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]
// with three retrieved pages (P1, P2, P3) and binary relevance judgements (1
// for relevant, 0 for not relevant):
//
// Retrieved: [P3 (0), P1 (1), P2 (1)]
// Ideal: [P1 (1), P2 (1), P3 (0)]
//
// Calculate NDCG@3 for
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]:
// * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
// * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
// * NDCG@3: 1.13/1.63 = 0.693
PageNdcg *QualityMetrics_TopkMetrics `protobuf:"bytes,5,opt,name=page_ndcg,json=pageNdcg,proto3" json:"page_ndcg,omitempty"`
// contains filtered or unexported fields
}Describes the metrics produced by the evaluation.
func (*QualityMetrics) Descriptor
func (*QualityMetrics) Descriptor() ([]byte, []int)Deprecated: Use QualityMetrics.ProtoReflect.Descriptor instead.
func (*QualityMetrics) GetDocNdcg
func (x *QualityMetrics) GetDocNdcg() *QualityMetrics_TopkMetricsfunc (*QualityMetrics) GetDocPrecision
func (x *QualityMetrics) GetDocPrecision() *QualityMetrics_TopkMetricsfunc (*QualityMetrics) GetDocRecall
func (x *QualityMetrics) GetDocRecall() *QualityMetrics_TopkMetricsfunc (*QualityMetrics) GetPageNdcg
func (x *QualityMetrics) GetPageNdcg() *QualityMetrics_TopkMetricsfunc (*QualityMetrics) GetPageRecall
func (x *QualityMetrics) GetPageRecall() *QualityMetrics_TopkMetricsfunc (*QualityMetrics) ProtoMessage
func (*QualityMetrics) ProtoMessage()func (*QualityMetrics) ProtoReflect
func (x *QualityMetrics) ProtoReflect() protoreflect.Messagefunc (*QualityMetrics) Reset
func (x *QualityMetrics) Reset()func (*QualityMetrics) String
func (x *QualityMetrics) String() stringQualityMetrics_TopkMetrics
type QualityMetrics_TopkMetrics struct {
// The top-1 value.
Top_1 float64 `protobuf:"fixed64,1,opt,name=top_1,json=top1,proto3" json:"top_1,omitempty"`
// The top-3 value.
Top_3 float64 `protobuf:"fixed64,2,opt,name=top_3,json=top3,proto3" json:"top_3,omitempty"`
// The top-5 value.
Top_5 float64 `protobuf:"fixed64,3,opt,name=top_5,json=top5,proto3" json:"top_5,omitempty"`
// The top-10 value.
Top_10 float64 `protobuf:"fixed64,4,opt,name=top_10,json=top10,proto3" json:"top_10,omitempty"`
// contains filtered or unexported fields
}Stores the metric values at specific top-k levels.
func (*QualityMetrics_TopkMetrics) Descriptor
func (*QualityMetrics_TopkMetrics) Descriptor() ([]byte, []int)Deprecated: Use QualityMetrics_TopkMetrics.ProtoReflect.Descriptor instead.
func (*QualityMetrics_TopkMetrics) GetTop_1
func (x *QualityMetrics_TopkMetrics) GetTop_1() float64func (*QualityMetrics_TopkMetrics) GetTop_10
func (x *QualityMetrics_TopkMetrics) GetTop_10() float64func (*QualityMetrics_TopkMetrics) GetTop_3
func (x *QualityMetrics_TopkMetrics) GetTop_3() float64func (*QualityMetrics_TopkMetrics) GetTop_5
func (x *QualityMetrics_TopkMetrics) GetTop_5() float64func (*QualityMetrics_TopkMetrics) ProtoMessage
func (*QualityMetrics_TopkMetrics) ProtoMessage()func (*QualityMetrics_TopkMetrics) ProtoReflect
func (x *QualityMetrics_TopkMetrics) ProtoReflect() protoreflect.Messagefunc (*QualityMetrics_TopkMetrics) Reset
func (x *QualityMetrics_TopkMetrics) Reset()func (*QualityMetrics_TopkMetrics) String
func (x *QualityMetrics_TopkMetrics) String() stringQuery
type Query struct {
// Query content.
//
// Types that are valid to be assigned to Content:
//
// *Query_Text
Content isQuery_Content `protobuf_oneof:"content"`
// Output only. Unique Id for the query.
QueryId string `protobuf:"bytes,1,opt,name=query_id,json=queryId,proto3" json:"query_id,omitempty"`
// contains filtered or unexported fields
}Defines a user inputed query.
func (*Query) Descriptor
Deprecated: Use Query.ProtoReflect.Descriptor instead.
func (*Query) GetContent
func (x *Query) GetContent() isQuery_Contentfunc (*Query) GetQueryId
func (*Query) GetText
func (*Query) ProtoMessage
func (*Query) ProtoMessage()func (*Query) ProtoReflect
func (x *Query) ProtoReflect() protoreflect.Messagefunc (*Query) Reset
func (x *Query) Reset()func (*Query) String
Query_Text
type Query_Text struct {
// Plain text.
Text string `protobuf:"bytes,2,opt,name=text,proto3,oneof"`
}RankRequest
type RankRequest struct {
// Required. The resource name of the rank service config, such as
// `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
RankingConfig string `protobuf:"bytes,1,opt,name=ranking_config,json=rankingConfig,proto3" json:"ranking_config,omitempty"`
// The identifier of the model to use. It is one of:
//
// * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
// token size 512.
//
// It is set to `semantic-ranker-512@latest` by default if unspecified.
Model string `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
// The number of results to return. If this is unset or no bigger than zero,
// returns all results.
TopN int32 `protobuf:"varint,3,opt,name=top_n,json=topN,proto3" json:"top_n,omitempty"`
// The query to use.
Query string `protobuf:"bytes,4,opt,name=query,proto3" json:"query,omitempty"`
// Required. A list of records to rank. At most 200 records to rank.
Records []*RankingRecord `protobuf:"bytes,5,rep,name=records,proto3" json:"records,omitempty"`
// If true, the response will contain only record ID and score. By default, it
// is false, the response will contain record details.
IgnoreRecordDetailsInResponse bool `protobuf:"varint,6,opt,name=ignore_record_details_in_response,json=ignoreRecordDetailsInResponse,proto3" json:"ignore_record_details_in_response,omitempty"`
// The user labels applied to a resource must meet the following requirements:
//
// - Each resource can have multiple labels, up to a maximum of 64.
// - Each label must be a key-value pair.
// - Keys have a minimum length of 1 character and a maximum length of 63
// characters and cannot be empty. Values can be empty and have a maximum
// length of 63 characters.
// - Keys and values can contain only lowercase letters, numeric characters,
// underscores, and dashes. All characters must use UTF-8 encoding, and
// international characters are allowed.
// - The key portion of a label must be unique. However, you can use the same
// key with multiple resources.
// - Keys must start with a lowercase letter or international character.
//
// See [Google Cloud
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
// for more details.
UserLabels map[string]string `protobuf:"bytes,7,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Request message for [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] method.
func (*RankRequest) Descriptor
func (*RankRequest) Descriptor() ([]byte, []int)Deprecated: Use RankRequest.ProtoReflect.Descriptor instead.
func (*RankRequest) GetIgnoreRecordDetailsInResponse
func (x *RankRequest) GetIgnoreRecordDetailsInResponse() boolfunc (*RankRequest) GetModel
func (x *RankRequest) GetModel() stringfunc (*RankRequest) GetQuery
func (x *RankRequest) GetQuery() stringfunc (*RankRequest) GetRankingConfig
func (x *RankRequest) GetRankingConfig() stringfunc (*RankRequest) GetRecords
func (x *RankRequest) GetRecords() []*RankingRecordfunc (*RankRequest) GetTopN
func (x *RankRequest) GetTopN() int32func (*RankRequest) GetUserLabels
func (x *RankRequest) GetUserLabels() map[string]stringfunc (*RankRequest) ProtoMessage
func (*RankRequest) ProtoMessage()func (*RankRequest) ProtoReflect
func (x *RankRequest) ProtoReflect() protoreflect.Messagefunc (*RankRequest) Reset
func (x *RankRequest) Reset()func (*RankRequest) String
func (x *RankRequest) String() stringRankResponse
type RankResponse struct {
// A list of records sorted by descending score.
Records []*RankingRecord `protobuf:"bytes,5,rep,name=records,proto3" json:"records,omitempty"`
// contains filtered or unexported fields
}Response message for [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] method.
func (*RankResponse) Descriptor
func (*RankResponse) Descriptor() ([]byte, []int)Deprecated: Use RankResponse.ProtoReflect.Descriptor instead.
func (*RankResponse) GetRecords
func (x *RankResponse) GetRecords() []*RankingRecordfunc (*RankResponse) ProtoMessage
func (*RankResponse) ProtoMessage()func (*RankResponse) ProtoReflect
func (x *RankResponse) ProtoReflect() protoreflect.Messagefunc (*RankResponse) Reset
func (x *RankResponse) Reset()func (*RankResponse) String
func (x *RankResponse) String() stringRankServiceClient
type RankServiceClient interface {
// Ranks a list of text records based on the given input query.
Rank(ctx context.Context, in *RankRequest, opts ...grpc.CallOption) (*RankResponse, error)
}RankServiceClient is the client API for RankService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewRankServiceClient
func NewRankServiceClient(cc grpc.ClientConnInterface) RankServiceClientRankServiceServer
type RankServiceServer interface {
// Ranks a list of text records based on the given input query.
Rank(context.Context, *RankRequest) (*RankResponse, error)
}RankServiceServer is the server API for RankService service. All implementations should embed UnimplementedRankServiceServer for forward compatibility
RankingRecord
type RankingRecord struct {
// The unique ID to represent the record.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// The title of the record. Empty by default.
// At least one of
// [title][google.cloud.discoveryengine.v1alpha.RankingRecord.title] or
// [content][google.cloud.discoveryengine.v1alpha.RankingRecord.content]
// should be set otherwise an INVALID_ARGUMENT error is thrown.
Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
// The content of the record. Empty by default.
// At least one of
// [title][google.cloud.discoveryengine.v1alpha.RankingRecord.title] or
// [content][google.cloud.discoveryengine.v1alpha.RankingRecord.content]
// should be set otherwise an INVALID_ARGUMENT error is thrown.
Content string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
// The score of this record based on the given query and selected model.
Score float32 `protobuf:"fixed32,4,opt,name=score,proto3" json:"score,omitempty"`
// contains filtered or unexported fields
}Record message for [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] method.
func (*RankingRecord) Descriptor
func (*RankingRecord) Descriptor() ([]byte, []int)Deprecated: Use RankingRecord.ProtoReflect.Descriptor instead.
func (*RankingRecord) GetContent
func (x *RankingRecord) GetContent() stringfunc (*RankingRecord) GetId
func (x *RankingRecord) GetId() stringfunc (*RankingRecord) GetScore
func (x *RankingRecord) GetScore() float32func (*RankingRecord) GetTitle
func (x *RankingRecord) GetTitle() stringfunc (*RankingRecord) ProtoMessage
func (*RankingRecord) ProtoMessage()func (*RankingRecord) ProtoReflect
func (x *RankingRecord) ProtoReflect() protoreflect.Messagefunc (*RankingRecord) Reset
func (x *RankingRecord) Reset()func (*RankingRecord) String
func (x *RankingRecord) String() stringRecommendRequest
type RecommendRequest struct {
// Required. Full resource name of a
// [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig]:
// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
//
// One default serving config is created along with your recommendation engine
// creation. The engine ID is used as the ID of the default serving
// config. For example, for Engine
// `projects/*/locations/global/collections/*/engines/my-engine`, you can use
// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
// for your
// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend]
// requests.
ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
// Required. Context about the user, what they are looking at and what action
// they took to trigger the Recommend request. Note that this user event
// detail won't be ingested to userEvent logs. Thus, a separate userEvent
// write request is required for event logging.
//
// Don't set
// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id]
// or
// [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1alpha.UserInfo.user_id]
// to the same fixed ID for different users. If you are trying to receive
// non-personalized recommendations (not recommended; this can negatively
// impact model performance), instead set
// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id]
// to a random unique ID and leave
// [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1alpha.UserInfo.user_id]
// unset.
UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
// Maximum number of results to return. Set this property
// to the number of recommendation results needed. If zero, the service
// chooses a reasonable default. The maximum allowed value is 100. Values
// above 100 are set to 100.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Filter for restricting recommendation results with a length limit of 5,000
// characters. Currently, only filter expressions on the `filter_tags`
// attribute is supported.
//
// Examples:
//
// - `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
// - `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
//
// If `attributeFilteringSyntax` is set to true under the `params` field, then
// attribute-based expressions are expected instead of the above described
// tag-based syntax. Examples:
//
// - (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
// - (available: true) AND
// (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
//
// If your filter blocks all results, the API returns generic
// (unfiltered) popular Documents. If you only want results strictly matching
// the filters, set `strictFiltering` to `true` in
// [RecommendRequest.params][google.cloud.discoveryengine.v1alpha.RecommendRequest.params]
// to receive empty results instead.
//
// Note that the API never returns
// [Document][google.cloud.discoveryengine.v1alpha.Document]s with
// `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Use validate only mode for this recommendation query. If set to `true`, a
// fake model is used that returns arbitrary Document IDs.
// Note that the validate only mode should only be used for testing the API,
// or if the model is not ready.
ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// Additional domain specific parameters for the recommendations.
//
// Allowed values:
//
// - `returnDocument`: Boolean. If set to `true`, the associated Document
// object is returned in
// [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.document].
// - `returnScore`: Boolean. If set to true, the recommendation score
// corresponding to each returned Document is set in
// [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.metadata].
// The given score indicates the probability of a Document conversion given
// the user's context and history.
// - `strictFiltering`: Boolean. True by default. If set to `false`, the
//
// service
//
// returns generic (unfiltered) popular Documents instead of empty if
// your filter blocks all recommendation results.
// - `diversityLevel`: String. Default empty. If set to be non-empty, then
// it needs to be one of:
// - `no-diversity`
// - `low-diversity`
// - `medium-diversity`
// - `high-diversity`
// - `auto-diversity`
// This gives request-level control and adjusts recommendation results
// based on Document category.
// - `attributeFilteringSyntax`: Boolean. False by default. If set to true,
// the `filter` field is interpreted according to the new,
// attribute-based syntax.
Params map[string]*structpb.Value `protobuf:"bytes,6,rep,name=params,proto3" json:"params,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// The user labels applied to a resource must meet the following requirements:
//
// - Each resource can have multiple labels, up to a maximum of 64.
// - Each label must be a key-value pair.
// - Keys have a minimum length of 1 character and a maximum length of 63
// characters and cannot be empty. Values can be empty and have a maximum
// length of 63 characters.
// - Keys and values can contain only lowercase letters, numeric characters,
// underscores, and dashes. All characters must use UTF-8 encoding, and
// international characters are allowed.
// - The key portion of a label must be unique. However, you can use the same
// key with multiple resources.
// - Keys must start with a lowercase letter or international character.
//
// See [Requirements for
// labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
// for more details.
UserLabels map[string]string `protobuf:"bytes,8,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Request message for Recommend method.
func (*RecommendRequest) Descriptor
func (*RecommendRequest) Descriptor() ([]byte, []int)Deprecated: Use RecommendRequest.ProtoReflect.Descriptor instead.
func (*RecommendRequest) GetFilter
func (x *RecommendRequest) GetFilter() stringfunc (*RecommendRequest) GetPageSize
func (x *RecommendRequest) GetPageSize() int32func (*RecommendRequest) GetParams
func (x *RecommendRequest) GetParams() map[string]*structpb.Valuefunc (*RecommendRequest) GetServingConfig
func (x *RecommendRequest) GetServingConfig() stringfunc (*RecommendRequest) GetUserEvent
func (x *RecommendRequest) GetUserEvent() *UserEventfunc (*RecommendRequest) GetUserLabels
func (x *RecommendRequest) GetUserLabels() map[string]stringfunc (*RecommendRequest) GetValidateOnly
func (x *RecommendRequest) GetValidateOnly() boolfunc (*RecommendRequest) ProtoMessage
func (*RecommendRequest) ProtoMessage()func (*RecommendRequest) ProtoReflect
func (x *RecommendRequest) ProtoReflect() protoreflect.Messagefunc (*RecommendRequest) Reset
func (x *RecommendRequest) Reset()func (*RecommendRequest) String
func (x *RecommendRequest) String() stringRecommendResponse
type RecommendResponse struct {
// A list of recommended Documents. The order represents the ranking (from the
// most relevant Document to the least).
Results []*RecommendResponse_RecommendationResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
// A unique attribution token. This should be included in the
// [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] logs resulting
// from this recommendation, which enables accurate attribution of
// recommendation model performance.
AttributionToken string `protobuf:"bytes,2,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
// IDs of documents in the request that were missing from the default Branch
// associated with the requested ServingConfig.
MissingIds []string `protobuf:"bytes,3,rep,name=missing_ids,json=missingIds,proto3" json:"missing_ids,omitempty"`
// True if
// [RecommendRequest.validate_only][google.cloud.discoveryengine.v1alpha.RecommendRequest.validate_only]
// was set.
ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}Response message for Recommend method.
func (*RecommendResponse) Descriptor
func (*RecommendResponse) Descriptor() ([]byte, []int)Deprecated: Use RecommendResponse.ProtoReflect.Descriptor instead.
func (*RecommendResponse) GetAttributionToken
func (x *RecommendResponse) GetAttributionToken() stringfunc (*RecommendResponse) GetMissingIds
func (x *RecommendResponse) GetMissingIds() []stringfunc (*RecommendResponse) GetResults
func (x *RecommendResponse) GetResults() []*RecommendResponse_RecommendationResultfunc (*RecommendResponse) GetValidateOnly
func (x *RecommendResponse) GetValidateOnly() boolfunc (*RecommendResponse) ProtoMessage
func (*RecommendResponse) ProtoMessage()func (*RecommendResponse) ProtoReflect
func (x *RecommendResponse) ProtoReflect() protoreflect.Messagefunc (*RecommendResponse) Reset
func (x *RecommendResponse) Reset()func (*RecommendResponse) String
func (x *RecommendResponse) String() stringRecommendResponse_RecommendationResult
type RecommendResponse_RecommendationResult struct {
// Resource ID of the recommended Document.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Set if `returnDocument` is set to true in
// [RecommendRequest.params][google.cloud.discoveryengine.v1alpha.RecommendRequest.params].
Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
// Additional Document metadata or annotations.
//
// Possible values:
//
// - `score`: Recommendation score in double value. Is set if
// `returnScore` is set to true in
// [RecommendRequest.params][google.cloud.discoveryengine.v1alpha.RecommendRequest.params].
Metadata map[string]*structpb.Value `protobuf:"bytes,3,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}RecommendationResult represents a generic recommendation result with associated metadata.
func (*RecommendResponse_RecommendationResult) Descriptor
func (*RecommendResponse_RecommendationResult) Descriptor() ([]byte, []int)Deprecated: Use RecommendResponse_RecommendationResult.ProtoReflect.Descriptor instead.
func (*RecommendResponse_RecommendationResult) GetDocument
func (x *RecommendResponse_RecommendationResult) GetDocument() *Documentfunc (*RecommendResponse_RecommendationResult) GetId
func (x *RecommendResponse_RecommendationResult) GetId() stringfunc (*RecommendResponse_RecommendationResult) GetMetadata
func (x *RecommendResponse_RecommendationResult) GetMetadata() map[string]*structpb.Valuefunc (*RecommendResponse_RecommendationResult) ProtoMessage
func (*RecommendResponse_RecommendationResult) ProtoMessage()func (*RecommendResponse_RecommendationResult) ProtoReflect
func (x *RecommendResponse_RecommendationResult) ProtoReflect() protoreflect.Messagefunc (*RecommendResponse_RecommendationResult) Reset
func (x *RecommendResponse_RecommendationResult) Reset()func (*RecommendResponse_RecommendationResult) String
func (x *RecommendResponse_RecommendationResult) String() stringRecommendationServiceClient
type RecommendationServiceClient interface {
// Makes a recommendation, which requires a contextual user event.
Recommend(ctx context.Context, in *RecommendRequest, opts ...grpc.CallOption) (*RecommendResponse, error)
}RecommendationServiceClient is the client API for RecommendationService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewRecommendationServiceClient
func NewRecommendationServiceClient(cc grpc.ClientConnInterface) RecommendationServiceClientRecommendationServiceServer
type RecommendationServiceServer interface {
// Makes a recommendation, which requires a contextual user event.
Recommend(context.Context, *RecommendRequest) (*RecommendResponse, error)
}RecommendationServiceServer is the server API for RecommendationService service. All implementations should embed UnimplementedRecommendationServiceServer for forward compatibility
RecrawlUrisMetadata
type RecrawlUrisMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Unique URIs in the request that don't match any TargetSite in the
// DataStore, only match TargetSites that haven't been fully indexed, or match
// a TargetSite with type EXCLUDE.
InvalidUris []string `protobuf:"bytes,3,rep,name=invalid_uris,json=invalidUris,proto3" json:"invalid_uris,omitempty"`
// Total number of unique URIs in the request that are not in invalid_uris.
ValidUrisCount int32 `protobuf:"varint,4,opt,name=valid_uris_count,json=validUrisCount,proto3" json:"valid_uris_count,omitempty"`
// Total number of URIs that have been crawled so far.
SuccessCount int32 `protobuf:"varint,5,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
// Total number of URIs that have yet to be crawled.
PendingCount int32 `protobuf:"varint,6,opt,name=pending_count,json=pendingCount,proto3" json:"pending_count,omitempty"`
// Total number of URIs that were rejected due to insufficient indexing
// resources.
QuotaExceededCount int32 `protobuf:"varint,7,opt,name=quota_exceeded_count,json=quotaExceededCount,proto3" json:"quota_exceeded_count,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*RecrawlUrisMetadata) Descriptor
func (*RecrawlUrisMetadata) Descriptor() ([]byte, []int)Deprecated: Use RecrawlUrisMetadata.ProtoReflect.Descriptor instead.
func (*RecrawlUrisMetadata) GetCreateTime
func (x *RecrawlUrisMetadata) GetCreateTime() *timestamppb.Timestampfunc (*RecrawlUrisMetadata) GetInvalidUris
func (x *RecrawlUrisMetadata) GetInvalidUris() []stringfunc (*RecrawlUrisMetadata) GetPendingCount
func (x *RecrawlUrisMetadata) GetPendingCount() int32func (*RecrawlUrisMetadata) GetQuotaExceededCount
func (x *RecrawlUrisMetadata) GetQuotaExceededCount() int32func (*RecrawlUrisMetadata) GetSuccessCount
func (x *RecrawlUrisMetadata) GetSuccessCount() int32func (*RecrawlUrisMetadata) GetUpdateTime
func (x *RecrawlUrisMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*RecrawlUrisMetadata) GetValidUrisCount
func (x *RecrawlUrisMetadata) GetValidUrisCount() int32func (*RecrawlUrisMetadata) ProtoMessage
func (*RecrawlUrisMetadata) ProtoMessage()func (*RecrawlUrisMetadata) ProtoReflect
func (x *RecrawlUrisMetadata) ProtoReflect() protoreflect.Messagefunc (*RecrawlUrisMetadata) Reset
func (x *RecrawlUrisMetadata) Reset()func (*RecrawlUrisMetadata) String
func (x *RecrawlUrisMetadata) String() stringRecrawlUrisRequest
type RecrawlUrisRequest struct {
// Required. Full resource name of the
// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
// such as
// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
// Required. List of URIs to crawl. At most 10K URIs are supported, otherwise
// an INVALID_ARGUMENT error is thrown. Each URI should match at least one
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in
// `site_search_engine`.
Uris []string `protobuf:"bytes,2,rep,name=uris,proto3" json:"uris,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] method.
func (*RecrawlUrisRequest) Descriptor
func (*RecrawlUrisRequest) Descriptor() ([]byte, []int)Deprecated: Use RecrawlUrisRequest.ProtoReflect.Descriptor instead.
func (*RecrawlUrisRequest) GetSiteSearchEngine
func (x *RecrawlUrisRequest) GetSiteSearchEngine() stringfunc (*RecrawlUrisRequest) GetUris
func (x *RecrawlUrisRequest) GetUris() []stringfunc (*RecrawlUrisRequest) ProtoMessage
func (*RecrawlUrisRequest) ProtoMessage()func (*RecrawlUrisRequest) ProtoReflect
func (x *RecrawlUrisRequest) ProtoReflect() protoreflect.Messagefunc (*RecrawlUrisRequest) Reset
func (x *RecrawlUrisRequest) Reset()func (*RecrawlUrisRequest) String
func (x *RecrawlUrisRequest) String() stringRecrawlUrisResponse
type RecrawlUrisResponse struct {
// Details for a sample of up to 10 `failed_uris`.
FailureSamples []*RecrawlUrisResponse_FailureInfo `protobuf:"bytes,1,rep,name=failure_samples,json=failureSamples,proto3" json:"failure_samples,omitempty"`
// URIs that were not crawled before the LRO terminated.
FailedUris []string `protobuf:"bytes,2,rep,name=failed_uris,json=failedUris,proto3" json:"failed_uris,omitempty"`
// contains filtered or unexported fields
}Response message for [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] method.
func (*RecrawlUrisResponse) Descriptor
func (*RecrawlUrisResponse) Descriptor() ([]byte, []int)Deprecated: Use RecrawlUrisResponse.ProtoReflect.Descriptor instead.
func (*RecrawlUrisResponse) GetFailedUris
func (x *RecrawlUrisResponse) GetFailedUris() []stringfunc (*RecrawlUrisResponse) GetFailureSamples
func (x *RecrawlUrisResponse) GetFailureSamples() []*RecrawlUrisResponse_FailureInfofunc (*RecrawlUrisResponse) ProtoMessage
func (*RecrawlUrisResponse) ProtoMessage()func (*RecrawlUrisResponse) ProtoReflect
func (x *RecrawlUrisResponse) ProtoReflect() protoreflect.Messagefunc (*RecrawlUrisResponse) Reset
func (x *RecrawlUrisResponse) Reset()func (*RecrawlUrisResponse) String
func (x *RecrawlUrisResponse) String() stringRecrawlUrisResponse_FailureInfo
type RecrawlUrisResponse_FailureInfo struct {
// URI that failed to be crawled.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// List of failure reasons by corpus type (e.g. desktop, mobile).
FailureReasons []*RecrawlUrisResponse_FailureInfo_FailureReason `protobuf:"bytes,2,rep,name=failure_reasons,json=failureReasons,proto3" json:"failure_reasons,omitempty"`
// contains filtered or unexported fields
}Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.
func (*RecrawlUrisResponse_FailureInfo) Descriptor
func (*RecrawlUrisResponse_FailureInfo) Descriptor() ([]byte, []int)Deprecated: Use RecrawlUrisResponse_FailureInfo.ProtoReflect.Descriptor instead.
func (*RecrawlUrisResponse_FailureInfo) GetFailureReasons
func (x *RecrawlUrisResponse_FailureInfo) GetFailureReasons() []*RecrawlUrisResponse_FailureInfo_FailureReasonfunc (*RecrawlUrisResponse_FailureInfo) GetUri
func (x *RecrawlUrisResponse_FailureInfo) GetUri() stringfunc (*RecrawlUrisResponse_FailureInfo) ProtoMessage
func (*RecrawlUrisResponse_FailureInfo) ProtoMessage()func (*RecrawlUrisResponse_FailureInfo) ProtoReflect
func (x *RecrawlUrisResponse_FailureInfo) ProtoReflect() protoreflect.Messagefunc (*RecrawlUrisResponse_FailureInfo) Reset
func (x *RecrawlUrisResponse_FailureInfo) Reset()func (*RecrawlUrisResponse_FailureInfo) String
func (x *RecrawlUrisResponse_FailureInfo) String() stringRecrawlUrisResponse_FailureInfo_FailureReason
type RecrawlUrisResponse_FailureInfo_FailureReason struct {
// DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
CorpusType RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType `protobuf:"varint,1,opt,name=corpus_type,json=corpusType,proto3,enum=google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType" json:"corpus_type,omitempty"`
// Reason why the URI was not crawled.
ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// contains filtered or unexported fields
}Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.
func (*RecrawlUrisResponse_FailureInfo_FailureReason) Descriptor
func (*RecrawlUrisResponse_FailureInfo_FailureReason) Descriptor() ([]byte, []int)Deprecated: Use RecrawlUrisResponse_FailureInfo_FailureReason.ProtoReflect.Descriptor instead.
func (*RecrawlUrisResponse_FailureInfo_FailureReason) GetCorpusType
func (x *RecrawlUrisResponse_FailureInfo_FailureReason) GetCorpusType() RecrawlUrisResponse_FailureInfo_FailureReason_CorpusTypefunc (*RecrawlUrisResponse_FailureInfo_FailureReason) GetErrorMessage
func (x *RecrawlUrisResponse_FailureInfo_FailureReason) GetErrorMessage() stringfunc (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoMessage
func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoMessage()func (*RecrawlUrisResponse_FailureInfo_FailureReason) ProtoReflect
func (x *RecrawlUrisResponse_FailureInfo_FailureReason) ProtoReflect() protoreflect.Messagefunc (*RecrawlUrisResponse_FailureInfo_FailureReason) Reset
func (x *RecrawlUrisResponse_FailureInfo_FailureReason) Reset()func (*RecrawlUrisResponse_FailureInfo_FailureReason) String
func (x *RecrawlUrisResponse_FailureInfo_FailureReason) String() stringRecrawlUrisResponse_FailureInfo_FailureReason_CorpusType
type RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType int32CorpusType for the failed crawling operation.
RecrawlUrisResponse_FailureInfo_FailureReason_CORPUS_TYPE_UNSPECIFIED, RecrawlUrisResponse_FailureInfo_FailureReason_DESKTOP, RecrawlUrisResponse_FailureInfo_FailureReason_MOBILE
const (
// Default value.
RecrawlUrisResponse_FailureInfo_FailureReason_CORPUS_TYPE_UNSPECIFIED RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType = 0
// Denotes a crawling attempt for the desktop version of a page.
RecrawlUrisResponse_FailureInfo_FailureReason_DESKTOP RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType = 1
// Denotes a crawling attempt for the mobile version of a page.
RecrawlUrisResponse_FailureInfo_FailureReason_MOBILE RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType = 2
)func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Descriptor
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Descriptor() protoreflect.EnumDescriptorfunc (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Enum
func (x RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Enum() *RecrawlUrisResponse_FailureInfo_FailureReason_CorpusTypefunc (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) EnumDescriptor
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) EnumDescriptor() ([]byte, []int)Deprecated: Use RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType.Descriptor instead.
func (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Number
func (x RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Number() protoreflect.EnumNumberfunc (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) String
func (x RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) String() stringfunc (RecrawlUrisResponse_FailureInfo_FailureReason_CorpusType) Type
Reply
type Reply struct {
// DEPRECATED: use `summary` instead.
// Text reply.
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/conversation.proto.
Reply string `protobuf:"bytes,1,opt,name=reply,proto3" json:"reply,omitempty"`
// References in the reply.
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/conversation.proto.
References []*Reply_Reference `protobuf:"bytes,2,rep,name=references,proto3" json:"references,omitempty"`
// Summary based on search results.
Summary *SearchResponse_Summary `protobuf:"bytes,3,opt,name=summary,proto3" json:"summary,omitempty"`
// contains filtered or unexported fields
}Defines a reply message to user.
func (*Reply) Descriptor
Deprecated: Use Reply.ProtoReflect.Descriptor instead.
func (*Reply) GetReferences
func (x *Reply) GetReferences() []*Reply_ReferenceDeprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/conversation.proto.
func (*Reply) GetReply
Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/conversation.proto.
func (*Reply) GetSummary
func (x *Reply) GetSummary() *SearchResponse_Summaryfunc (*Reply) ProtoMessage
func (*Reply) ProtoMessage()func (*Reply) ProtoReflect
func (x *Reply) ProtoReflect() protoreflect.Messagefunc (*Reply) Reset
func (x *Reply) Reset()func (*Reply) String
Reply_Reference (deprecated)
type Reply_Reference struct {
// URI link reference.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// Anchor text.
AnchorText string `protobuf:"bytes,2,opt,name=anchor_text,json=anchorText,proto3" json:"anchor_text,omitempty"`
// Anchor text start index.
Start int32 `protobuf:"varint,3,opt,name=start,proto3" json:"start,omitempty"`
// Anchor text end index.
End int32 `protobuf:"varint,4,opt,name=end,proto3" json:"end,omitempty"`
// contains filtered or unexported fields
}Defines reference in reply.
Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/conversation.proto.
func (*Reply_Reference) Descriptor (deprecated)
func (*Reply_Reference) Descriptor() ([]byte, []int)Deprecated: Use Reply_Reference.ProtoReflect.Descriptor instead.
func (*Reply_Reference) GetAnchorText (deprecated)
func (x *Reply_Reference) GetAnchorText() stringfunc (*Reply_Reference) GetEnd (deprecated)
func (x *Reply_Reference) GetEnd() int32func (*Reply_Reference) GetStart (deprecated)
func (x *Reply_Reference) GetStart() int32func (*Reply_Reference) GetUri (deprecated)
func (x *Reply_Reference) GetUri() stringfunc (*Reply_Reference) ProtoMessage (deprecated)
func (*Reply_Reference) ProtoMessage()func (*Reply_Reference) ProtoReflect (deprecated)
func (x *Reply_Reference) ProtoReflect() protoreflect.Messagefunc (*Reply_Reference) Reset (deprecated)
func (x *Reply_Reference) Reset()func (*Reply_Reference) String (deprecated)
func (x *Reply_Reference) String() stringReportConsentChangeRequest
type ReportConsentChangeRequest struct {
// Required. Whether customer decides to accept or decline service term.
//
// At this moment, only accept action is supported.
ConsentChangeAction ReportConsentChangeRequest_ConsentChangeAction `protobuf:"varint,1,opt,name=consent_change_action,json=consentChangeAction,proto3,enum=google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest_ConsentChangeAction" json:"consent_change_action,omitempty"`
// Required. Full resource name of a
// [Project][google.cloud.discoveryengine.v1alpha.Project], such as
// `projects/{project_id_or_number}`.
Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
// Required. The unique identifier of the terms of service to update.
// Available term ids:
//
// * `GA_DATA_USE_TERMS`: [Terms for data
// use](https://cloud.google.com/retail/data-use-terms). When using this
// service term id, the acceptable
// [service_term_version][google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest.service_term_version]
// to provide is `2022-11-23`.
ServiceTermId string `protobuf:"bytes,3,opt,name=service_term_id,json=serviceTermId,proto3" json:"service_term_id,omitempty"`
// Required. The version string of the terms of service to update.
ServiceTermVersion string `protobuf:"bytes,4,opt,name=service_term_version,json=serviceTermVersion,proto3" json:"service_term_version,omitempty"`
// contains filtered or unexported fields
}Request for ReportConsentChange method.
func (*ReportConsentChangeRequest) Descriptor
func (*ReportConsentChangeRequest) Descriptor() ([]byte, []int)Deprecated: Use ReportConsentChangeRequest.ProtoReflect.Descriptor instead.
func (*ReportConsentChangeRequest) GetConsentChangeAction
func (x *ReportConsentChangeRequest) GetConsentChangeAction() ReportConsentChangeRequest_ConsentChangeActionfunc (*ReportConsentChangeRequest) GetProject
func (x *ReportConsentChangeRequest) GetProject() stringfunc (*ReportConsentChangeRequest) GetServiceTermId
func (x *ReportConsentChangeRequest) GetServiceTermId() stringfunc (*ReportConsentChangeRequest) GetServiceTermVersion
func (x *ReportConsentChangeRequest) GetServiceTermVersion() stringfunc (*ReportConsentChangeRequest) ProtoMessage
func (*ReportConsentChangeRequest) ProtoMessage()func (*ReportConsentChangeRequest) ProtoReflect
func (x *ReportConsentChangeRequest) ProtoReflect() protoreflect.Messagefunc (*ReportConsentChangeRequest) Reset
func (x *ReportConsentChangeRequest) Reset()func (*ReportConsentChangeRequest) String
func (x *ReportConsentChangeRequest) String() stringReportConsentChangeRequest_ConsentChangeAction
type ReportConsentChangeRequest_ConsentChangeAction int32Type of consent acknowledgement (accept / reject).
At this moment, only ACCEPT action is supported.
ReportConsentChangeRequest_CONSENT_CHANGE_ACTION_UNSPECIFIED, ReportConsentChangeRequest_ACCEPT
const (
// Invalid action, user must specify accept/decline
ReportConsentChangeRequest_CONSENT_CHANGE_ACTION_UNSPECIFIED ReportConsentChangeRequest_ConsentChangeAction = 0
// User accepts service terms.
ReportConsentChangeRequest_ACCEPT ReportConsentChangeRequest_ConsentChangeAction = 1
)func (ReportConsentChangeRequest_ConsentChangeAction) Descriptor
func (ReportConsentChangeRequest_ConsentChangeAction) Descriptor() protoreflect.EnumDescriptorfunc (ReportConsentChangeRequest_ConsentChangeAction) Enum
func (x ReportConsentChangeRequest_ConsentChangeAction) Enum() *ReportConsentChangeRequest_ConsentChangeActionfunc (ReportConsentChangeRequest_ConsentChangeAction) EnumDescriptor
func (ReportConsentChangeRequest_ConsentChangeAction) EnumDescriptor() ([]byte, []int)Deprecated: Use ReportConsentChangeRequest_ConsentChangeAction.Descriptor instead.
func (ReportConsentChangeRequest_ConsentChangeAction) Number
func (x ReportConsentChangeRequest_ConsentChangeAction) Number() protoreflect.EnumNumberfunc (ReportConsentChangeRequest_ConsentChangeAction) String
func (x ReportConsentChangeRequest_ConsentChangeAction) String() stringfunc (ReportConsentChangeRequest_ConsentChangeAction) Type
ResumeEngineRequest
type ResumeEngineRequest struct {
// Required. The name of the engine to resume.
// Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for resuming training of an engine.
func (*ResumeEngineRequest) Descriptor
func (*ResumeEngineRequest) Descriptor() ([]byte, []int)Deprecated: Use ResumeEngineRequest.ProtoReflect.Descriptor instead.
func (*ResumeEngineRequest) GetName
func (x *ResumeEngineRequest) GetName() stringfunc (*ResumeEngineRequest) ProtoMessage
func (*ResumeEngineRequest) ProtoMessage()func (*ResumeEngineRequest) ProtoReflect
func (x *ResumeEngineRequest) ProtoReflect() protoreflect.Messagefunc (*ResumeEngineRequest) Reset
func (x *ResumeEngineRequest) Reset()func (*ResumeEngineRequest) String
func (x *ResumeEngineRequest) String() stringSampleQuery
type SampleQuery struct {
// The content of the sample query.
//
// Types that are valid to be assigned to Content:
//
// *SampleQuery_QueryEntry_
Content isSampleQuery_Content `protobuf_oneof:"content"`
// Identifier. The full resource name of the sample query, in the format of
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
//
// 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"`
// Output only. Timestamp the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] was created
// at.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}Sample Query captures metadata to be used for evaluation.
func (*SampleQuery) Descriptor
func (*SampleQuery) Descriptor() ([]byte, []int)Deprecated: Use SampleQuery.ProtoReflect.Descriptor instead.
func (*SampleQuery) GetContent
func (x *SampleQuery) GetContent() isSampleQuery_Contentfunc (*SampleQuery) GetCreateTime
func (x *SampleQuery) GetCreateTime() *timestamppb.Timestampfunc (*SampleQuery) GetName
func (x *SampleQuery) GetName() stringfunc (*SampleQuery) GetQueryEntry
func (x *SampleQuery) GetQueryEntry() *SampleQuery_QueryEntryfunc (*SampleQuery) ProtoMessage
func (*SampleQuery) ProtoMessage()func (*SampleQuery) ProtoReflect
func (x *SampleQuery) ProtoReflect() protoreflect.Messagefunc (*SampleQuery) Reset
func (x *SampleQuery) Reset()func (*SampleQuery) String
func (x *SampleQuery) String() stringSampleQueryServiceClient
type SampleQueryServiceClient interface {
// Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
GetSampleQuery(ctx context.Context, in *GetSampleQueryRequest, opts ...grpc.CallOption) (*SampleQuery, error)
// Gets a list of
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
ListSampleQueries(ctx context.Context, in *ListSampleQueriesRequest, opts ...grpc.CallOption) (*ListSampleQueriesResponse, error)
// Creates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]
CreateSampleQuery(ctx context.Context, in *CreateSampleQueryRequest, opts ...grpc.CallOption) (*SampleQuery, error)
// Updates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
UpdateSampleQuery(ctx context.Context, in *UpdateSampleQueryRequest, opts ...grpc.CallOption) (*SampleQuery, error)
// Deletes a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
DeleteSampleQuery(ctx context.Context, in *DeleteSampleQueryRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Bulk import of multiple
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. Sample
// queries that already exist may be deleted.
//
// Note: It is possible for a subset of the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s to be
// successfully imported.
ImportSampleQueries(ctx context.Context, in *ImportSampleQueriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}SampleQueryServiceClient is the client API for SampleQueryService 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 NewSampleQueryServiceClient
func NewSampleQueryServiceClient(cc grpc.ClientConnInterface) SampleQueryServiceClientSampleQueryServiceServer
type SampleQueryServiceServer interface {
// Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
GetSampleQuery(context.Context, *GetSampleQueryRequest) (*SampleQuery, error)
// Gets a list of
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
ListSampleQueries(context.Context, *ListSampleQueriesRequest) (*ListSampleQueriesResponse, error)
// Creates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]
CreateSampleQuery(context.Context, *CreateSampleQueryRequest) (*SampleQuery, error)
// Updates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
UpdateSampleQuery(context.Context, *UpdateSampleQueryRequest) (*SampleQuery, error)
// Deletes a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
DeleteSampleQuery(context.Context, *DeleteSampleQueryRequest) (*emptypb.Empty, error)
// Bulk import of multiple
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. Sample
// queries that already exist may be deleted.
//
// Note: It is possible for a subset of the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s to be
// successfully imported.
ImportSampleQueries(context.Context, *ImportSampleQueriesRequest) (*longrunningpb.Operation, error)
}SampleQueryServiceServer is the server API for SampleQueryService service. All implementations should embed UnimplementedSampleQueryServiceServer for forward compatibility
SampleQuerySet
type SampleQuerySet struct {
// Identifier. The full resource name of the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], in
// the format of
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
//
// 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 sample query set display name.
//
// This field 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"`
// Output only. Timestamp the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] was
// created at.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The description of the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
func (*SampleQuerySet) Descriptor
func (*SampleQuerySet) Descriptor() ([]byte, []int)Deprecated: Use SampleQuerySet.ProtoReflect.Descriptor instead.
func (*SampleQuerySet) GetCreateTime
func (x *SampleQuerySet) GetCreateTime() *timestamppb.Timestampfunc (*SampleQuerySet) GetDescription
func (x *SampleQuerySet) GetDescription() stringfunc (*SampleQuerySet) GetDisplayName
func (x *SampleQuerySet) GetDisplayName() stringfunc (*SampleQuerySet) GetName
func (x *SampleQuerySet) GetName() stringfunc (*SampleQuerySet) ProtoMessage
func (*SampleQuerySet) ProtoMessage()func (*SampleQuerySet) ProtoReflect
func (x *SampleQuerySet) ProtoReflect() protoreflect.Messagefunc (*SampleQuerySet) Reset
func (x *SampleQuerySet) Reset()func (*SampleQuerySet) String
func (x *SampleQuerySet) String() stringSampleQuerySetServiceClient
type SampleQuerySetServiceClient interface {
// Gets a
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
GetSampleQuerySet(ctx context.Context, in *GetSampleQuerySetRequest, opts ...grpc.CallOption) (*SampleQuerySet, error)
// Gets a list of
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s.
ListSampleQuerySets(ctx context.Context, in *ListSampleQuerySetsRequest, opts ...grpc.CallOption) (*ListSampleQuerySetsResponse, error)
// Creates a
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]
CreateSampleQuerySet(ctx context.Context, in *CreateSampleQuerySetRequest, opts ...grpc.CallOption) (*SampleQuerySet, error)
// Updates a
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
UpdateSampleQuerySet(ctx context.Context, in *UpdateSampleQuerySetRequest, opts ...grpc.CallOption) (*SampleQuerySet, error)
// Deletes a
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
DeleteSampleQuerySet(ctx context.Context, in *DeleteSampleQuerySetRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}SampleQuerySetServiceClient is the client API for SampleQuerySetService 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 NewSampleQuerySetServiceClient
func NewSampleQuerySetServiceClient(cc grpc.ClientConnInterface) SampleQuerySetServiceClientSampleQuerySetServiceServer
type SampleQuerySetServiceServer interface {
// Gets a
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
GetSampleQuerySet(context.Context, *GetSampleQuerySetRequest) (*SampleQuerySet, error)
// Gets a list of
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s.
ListSampleQuerySets(context.Context, *ListSampleQuerySetsRequest) (*ListSampleQuerySetsResponse, error)
// Creates a
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]
CreateSampleQuerySet(context.Context, *CreateSampleQuerySetRequest) (*SampleQuerySet, error)
// Updates a
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
UpdateSampleQuerySet(context.Context, *UpdateSampleQuerySetRequest) (*SampleQuerySet, error)
// Deletes a
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
DeleteSampleQuerySet(context.Context, *DeleteSampleQuerySetRequest) (*emptypb.Empty, error)
}SampleQuerySetServiceServer is the server API for SampleQuerySetService service. All implementations should embed UnimplementedSampleQuerySetServiceServer for forward compatibility
SampleQuery_QueryEntry
type SampleQuery_QueryEntry struct {
// Required. The query.
Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
// List of targets for the query.
Targets []*SampleQuery_QueryEntry_Target `protobuf:"bytes,3,rep,name=targets,proto3" json:"targets,omitempty"`
// contains filtered or unexported fields
}Query Entry captures metadata to be used for search evaluation.
func (*SampleQuery_QueryEntry) Descriptor
func (*SampleQuery_QueryEntry) Descriptor() ([]byte, []int)Deprecated: Use SampleQuery_QueryEntry.ProtoReflect.Descriptor instead.
func (*SampleQuery_QueryEntry) GetQuery
func (x *SampleQuery_QueryEntry) GetQuery() stringfunc (*SampleQuery_QueryEntry) GetTargets
func (x *SampleQuery_QueryEntry) GetTargets() []*SampleQuery_QueryEntry_Targetfunc (*SampleQuery_QueryEntry) ProtoMessage
func (*SampleQuery_QueryEntry) ProtoMessage()func (*SampleQuery_QueryEntry) ProtoReflect
func (x *SampleQuery_QueryEntry) ProtoReflect() protoreflect.Messagefunc (*SampleQuery_QueryEntry) Reset
func (x *SampleQuery_QueryEntry) Reset()func (*SampleQuery_QueryEntry) String
func (x *SampleQuery_QueryEntry) String() stringSampleQuery_QueryEntry_
type SampleQuery_QueryEntry_ struct {
// The query entry.
QueryEntry *SampleQuery_QueryEntry `protobuf:"bytes,2,opt,name=query_entry,json=queryEntry,proto3,oneof"`
}SampleQuery_QueryEntry_Target
type SampleQuery_QueryEntry_Target struct {
// Expected uri of the target.
//
// This field must be a UTF-8 encoded string with a length limit of 2048
// characters.
//
// Example of valid uris: `https://example.com/abc`,
// `gcs://example/example.pdf`.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// Expected page numbers of the target.
//
// Each page number must be non negative.
PageNumbers []int32 `protobuf:"varint,2,rep,packed,name=page_numbers,json=pageNumbers,proto3" json:"page_numbers,omitempty"`
// Relevance score of the target.
Score *float64 `protobuf:"fixed64,3,opt,name=score,proto3,oneof" json:"score,omitempty"`
// contains filtered or unexported fields
}Defines the parameters of the query's expected outcome.
func (*SampleQuery_QueryEntry_Target) Descriptor
func (*SampleQuery_QueryEntry_Target) Descriptor() ([]byte, []int)Deprecated: Use SampleQuery_QueryEntry_Target.ProtoReflect.Descriptor instead.
func (*SampleQuery_QueryEntry_Target) GetPageNumbers
func (x *SampleQuery_QueryEntry_Target) GetPageNumbers() []int32func (*SampleQuery_QueryEntry_Target) GetScore
func (x *SampleQuery_QueryEntry_Target) GetScore() float64func (*SampleQuery_QueryEntry_Target) GetUri
func (x *SampleQuery_QueryEntry_Target) GetUri() stringfunc (*SampleQuery_QueryEntry_Target) ProtoMessage
func (*SampleQuery_QueryEntry_Target) ProtoMessage()func (*SampleQuery_QueryEntry_Target) ProtoReflect
func (x *SampleQuery_QueryEntry_Target) ProtoReflect() protoreflect.Messagefunc (*SampleQuery_QueryEntry_Target) Reset
func (x *SampleQuery_QueryEntry_Target) Reset()func (*SampleQuery_QueryEntry_Target) String
func (x *SampleQuery_QueryEntry_Target) String() stringSchema
type Schema struct {
// Schema representation. One of
// [struct_schema][google.cloud.discoveryengine.v1alpha.Schema.struct_schema]
// or [json_schema][google.cloud.discoveryengine.v1alpha.Schema.json_schema]
// should be provided otherwise an `INVALID_ARGUMENT` error is thrown.
//
// Types that are valid to be assigned to Schema:
//
// *Schema_StructSchema
// *Schema_JsonSchema
Schema isSchema_Schema `protobuf_oneof:"schema"`
// Immutable. The full resource name of the schema, in the format of
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. Configurations for fields of the schema.
FieldConfigs []*FieldConfig `protobuf:"bytes,4,rep,name=field_configs,json=fieldConfigs,proto3" json:"field_configs,omitempty"`
// contains filtered or unexported fields
}Defines the structure and layout of a type of document data.
func (*Schema) Descriptor
Deprecated: Use Schema.ProtoReflect.Descriptor instead.
func (*Schema) GetFieldConfigs
func (x *Schema) GetFieldConfigs() []*FieldConfigfunc (*Schema) GetJsonSchema
func (*Schema) GetName
func (*Schema) GetSchema
func (x *Schema) GetSchema() isSchema_Schemafunc (*Schema) GetStructSchema
func (*Schema) ProtoMessage
func (*Schema) ProtoMessage()func (*Schema) ProtoReflect
func (x *Schema) ProtoReflect() protoreflect.Messagefunc (*Schema) Reset
func (x *Schema) Reset()func (*Schema) String
SchemaServiceClient
type SchemaServiceClient interface {
// Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
GetSchema(ctx context.Context, in *GetSchemaRequest, opts ...grpc.CallOption) (*Schema, error)
// Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.
ListSchemas(ctx context.Context, in *ListSchemasRequest, opts ...grpc.CallOption) (*ListSchemasResponse, error)
// Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
CreateSchema(ctx context.Context, in *CreateSchemaRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
UpdateSchema(ctx context.Context, in *UpdateSchemaRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
DeleteSchema(ctx context.Context, in *DeleteSchemaRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}SchemaServiceClient is the client API for SchemaService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewSchemaServiceClient
func NewSchemaServiceClient(cc grpc.ClientConnInterface) SchemaServiceClientSchemaServiceServer
type SchemaServiceServer interface {
// Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
GetSchema(context.Context, *GetSchemaRequest) (*Schema, error)
// Gets a list of [Schema][google.cloud.discoveryengine.v1alpha.Schema]s.
ListSchemas(context.Context, *ListSchemasRequest) (*ListSchemasResponse, error)
// Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
CreateSchema(context.Context, *CreateSchemaRequest) (*longrunningpb.Operation, error)
// Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
UpdateSchema(context.Context, *UpdateSchemaRequest) (*longrunningpb.Operation, error)
// Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema].
DeleteSchema(context.Context, *DeleteSchemaRequest) (*longrunningpb.Operation, error)
}SchemaServiceServer is the server API for SchemaService service. All implementations should embed UnimplementedSchemaServiceServer for forward compatibility
Schema_JsonSchema
type Schema_JsonSchema struct {
// The JSON representation of the schema.
JsonSchema string `protobuf:"bytes,3,opt,name=json_schema,json=jsonSchema,proto3,oneof"`
}Schema_StructSchema
type Schema_StructSchema struct {
// The structured representation of the schema.
StructSchema *structpb.Struct `protobuf:"bytes,2,opt,name=struct_schema,json=structSchema,proto3,oneof"`
}SearchAddOn
type SearchAddOn int32Add-on that provides additional functionality for search.
SearchAddOn_SEARCH_ADD_ON_UNSPECIFIED, SearchAddOn_SEARCH_ADD_ON_LLM
const (
// Default value when the enum is unspecified. This is invalid to use.
SearchAddOn_SEARCH_ADD_ON_UNSPECIFIED SearchAddOn = 0
// Large language model add-on.
SearchAddOn_SEARCH_ADD_ON_LLM SearchAddOn = 1
)func (SearchAddOn) Descriptor
func (SearchAddOn) Descriptor() protoreflect.EnumDescriptorfunc (SearchAddOn) Enum
func (x SearchAddOn) Enum() *SearchAddOnfunc (SearchAddOn) EnumDescriptor
func (SearchAddOn) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchAddOn.Descriptor instead.
func (SearchAddOn) Number
func (x SearchAddOn) Number() protoreflect.EnumNumberfunc (SearchAddOn) String
func (x SearchAddOn) String() stringfunc (SearchAddOn) Type
func (SearchAddOn) Type() protoreflect.EnumTypeSearchInfo
type SearchInfo struct {
// The user's search query.
//
// See
// [SearchRequest.query][google.cloud.discoveryengine.v1alpha.SearchRequest.query]
// for definition.
//
// The value must be a UTF-8 encoded string with a length limit of 5,000
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
//
// At least one of
// [search_query][google.cloud.discoveryengine.v1alpha.SearchInfo.search_query]
// or
// [PageInfo.page_category][google.cloud.discoveryengine.v1alpha.PageInfo.page_category]
// is required for `search` events. Other event types should not set this
// field. Otherwise, an `INVALID_ARGUMENT` error is returned.
SearchQuery string `protobuf:"bytes,1,opt,name=search_query,json=searchQuery,proto3" json:"search_query,omitempty"`
// The order in which products are returned, if applicable.
//
// See
// [SearchRequest.order_by][google.cloud.discoveryengine.v1alpha.SearchRequest.order_by]
// for definition and syntax.
//
// The value must be a UTF-8 encoded string with a length limit of 1,000
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
//
// This can only be set for `search` events. Other event types should not set
// this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
OrderBy string `protobuf:"bytes,2,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// An integer that specifies the current offset for pagination (the 0-indexed
// starting location, amongst the products deemed by the API as relevant).
//
// See
// [SearchRequest.offset][google.cloud.discoveryengine.v1alpha.SearchRequest.offset]
// for definition.
//
// If this field is negative, an `INVALID_ARGUMENT` is returned.
//
// This can only be set for `search` events. Other event types should not set
// this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
Offset *int32 `protobuf:"varint,3,opt,name=offset,proto3,oneof" json:"offset,omitempty"`
// contains filtered or unexported fields
}Detailed search information.
func (*SearchInfo) Descriptor
func (*SearchInfo) Descriptor() ([]byte, []int)Deprecated: Use SearchInfo.ProtoReflect.Descriptor instead.
func (*SearchInfo) GetOffset
func (x *SearchInfo) GetOffset() int32func (*SearchInfo) GetOrderBy
func (x *SearchInfo) GetOrderBy() stringfunc (*SearchInfo) GetSearchQuery
func (x *SearchInfo) GetSearchQuery() stringfunc (*SearchInfo) ProtoMessage
func (*SearchInfo) ProtoMessage()func (*SearchInfo) ProtoReflect
func (x *SearchInfo) ProtoReflect() protoreflect.Messagefunc (*SearchInfo) Reset
func (x *SearchInfo) Reset()func (*SearchInfo) String
func (x *SearchInfo) String() stringSearchRequest
type SearchRequest struct {
// Required. The resource name of the Search serving config, such as
// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
// or
// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
// This field is used to identify the serving configuration name, set
// of models used to make the search.
ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
// The branch resource name, such as
// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
//
// Use `default_branch` as the branch ID or leave this field empty, to search
// documents under the default branch.
Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`
// Raw search query.
Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
// Raw image query.
ImageQuery *SearchRequest_ImageQuery `protobuf:"bytes,19,opt,name=image_query,json=imageQuery,proto3" json:"image_query,omitempty"`
// Maximum number of
// [Document][google.cloud.discoveryengine.v1alpha.Document]s to return. The
// maximum allowed value depends on the data type. Values above the maximum
// value are coerced to the maximum value.
//
// * Websites with basic indexing: Default `10`, Maximum `25`.
// * Websites with advanced indexing: Default `25`, Maximum `50`.
// * Other: Default `50`, Maximum `100`.
//
// If this field is negative, an `INVALID_ARGUMENT` is returned.
PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token received from a previous
// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
// must match the call that provided the page token. Otherwise, an
//
// `INVALID_ARGUMENT` error is returned.
PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// A 0-indexed integer that specifies the current offset (that is, starting
// result location, amongst the
// [Document][google.cloud.discoveryengine.v1alpha.Document]s deemed by the
// API as relevant) in search results. This field is only considered if
// [page_token][google.cloud.discoveryengine.v1alpha.SearchRequest.page_token]
// is unset.
//
// If this field is negative, an `INVALID_ARGUMENT` is returned.
Offset int32 `protobuf:"varint,6,opt,name=offset,proto3" json:"offset,omitempty"`
// 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,32,rep,name=data_store_specs,json=dataStoreSpecs,proto3" json:"data_store_specs,omitempty"`
// The filter syntax consists of an expression language for constructing a
// predicate from one or more fields of the documents being filtered. Filter
// expression is case-sensitive.
//
// If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
//
// Filtering in Vertex AI Search is done by mapping the LHS filter key to a
// key property defined in the Vertex AI Search backend -- this mapping is
// defined by the customer in their schema. For example a media customer might
// have a field 'name' in their schema. In this case the filter would look
// like this: filter --> name:'ANY("king kong")'
//
// For more information about filtering including syntax and filter
// operators, see
// [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
Filter string `protobuf:"bytes,7,opt,name=filter,proto3" json:"filter,omitempty"`
// The default filter that is applied when a user performs a search without
// checking any filters on the search page.
//
// The filter applied to every search request when quality improvement such as
// query expansion is needed. In the case a query does not have a sufficient
// amount of results this filter will be used to determine whether or not to
// enable the query expansion flow. The original filter will still be used for
// the query expanded search.
// This field is strongly recommended to achieve high search quality.
//
// For more information about filter syntax, see
// [SearchRequest.filter][google.cloud.discoveryengine.v1alpha.SearchRequest.filter].
CanonicalFilter string `protobuf:"bytes,29,opt,name=canonical_filter,json=canonicalFilter,proto3" json:"canonical_filter,omitempty"`
// The order in which documents are returned. Documents can be ordered by
// a field in an [Document][google.cloud.discoveryengine.v1alpha.Document]
// object. Leave it unset if ordered by relevance. `order_by` expression is
// case-sensitive.
//
// For more information on ordering the website search results, see
// [Order web search
// results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
// For more information on ordering the healthcare search results, see
// [Order healthcare search
// results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
// If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
OrderBy string `protobuf:"bytes,8,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// Information about the end user.
// Highly recommended for analytics.
// [UserInfo.user_agent][google.cloud.discoveryengine.v1alpha.UserInfo.user_agent]
// is used to deduce `device_type` for analytics.
UserInfo *UserInfo `protobuf:"bytes,21,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
// The BCP-47 language code, such as "en-US" or "sr-Latn". For more
// information, see [Standard
// fields](https://cloud.google.com/apis/design/standard_fields). This field
// helps to better interpret the query. If a value isn't specified, the query
// language code is automatically detected, which may not be accurate.
LanguageCode string `protobuf:"bytes,35,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// The Unicode country/region code (CLDR) of a location, such as "US" and
// "419". For more information, see [Standard
// fields](https://cloud.google.com/apis/design/standard_fields). If set,
// then results will be boosted based on the region_code provided.
RegionCode string `protobuf:"bytes,36,opt,name=region_code,json=regionCode,proto3" json:"region_code,omitempty"`
// Facet specifications for faceted search. If empty, no facets are returned.
//
// A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
// error is returned.
FacetSpecs []*SearchRequest_FacetSpec `protobuf:"bytes,9,rep,name=facet_specs,json=facetSpecs,proto3" json:"facet_specs,omitempty"`
// Boost specification to boost certain documents.
// For more information on boosting, see
// [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,10,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`
// Additional search parameters.
//
// For public website search only, supported values are:
//
// - `user_country_code`: string. Default empty. If set to non-empty, results
// are restricted or boosted based on the location provided.
// For example, `user_country_code: "au"`
//
// For available codes see [Country
// Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
//
// - `search_type`: double. Default empty. Enables non-webpage searching
// depending on the value. The only valid non-default value is 1,
// which enables image searching.
// For example, `search_type: 1`
Params map[string]*structpb.Value `protobuf:"bytes,11,rep,name=params,proto3" json:"params,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// The query expansion specification that specifies the conditions under which
// query expansion occurs.
QueryExpansionSpec *SearchRequest_QueryExpansionSpec `protobuf:"bytes,13,opt,name=query_expansion_spec,json=queryExpansionSpec,proto3" json:"query_expansion_spec,omitempty"`
// The spell correction specification that specifies the mode under
// which spell correction takes effect.
SpellCorrectionSpec *SearchRequest_SpellCorrectionSpec `protobuf:"bytes,14,opt,name=spell_correction_spec,json=spellCorrectionSpec,proto3" json:"spell_correction_spec,omitempty"`
// A unique identifier for tracking visitors. For example, this could be
// implemented with an HTTP cookie, which should be able to uniquely identify
// a visitor on a single device. This unique identifier should not change if
// the visitor logs in or out of the website.
//
// This field should NOT have a fixed value such as `unknown_visitor`.
//
// This should be the same identifier as
// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id]
// and
// [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.CompleteQueryRequest.user_pseudo_id]
//
// The field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
UserPseudoId string `protobuf:"bytes,15,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
// A specification for configuring the behavior of content search.
ContentSearchSpec *SearchRequest_ContentSearchSpec `protobuf:"bytes,24,opt,name=content_search_spec,json=contentSearchSpec,proto3" json:"content_search_spec,omitempty"`
// Uses the provided embedding to do additional semantic document retrieval.
// The retrieval is based on the dot product of
// [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
// and the document embedding that is provided in
// [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].
//
// If
// [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
// is not provided, it will use
// [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config].
EmbeddingSpec *SearchRequest_EmbeddingSpec `protobuf:"bytes,23,opt,name=embedding_spec,json=embeddingSpec,proto3" json:"embedding_spec,omitempty"`
// The ranking expression controls the customized ranking on retrieval
// documents. This overrides
// [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression].
// The syntax and supported features depend on the
// `ranking_expression_backend` value. If `ranking_expression_backend` is not
// provided, it defaults to `RANK_BY_EMBEDDING`.
//
// If
// [ranking_expression_backend][google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend]
// is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
// function or multiple functions that are joined by "+".
//
// - ranking_expression = function, { " + ", function };
//
// Supported functions:
//
// - double * relevance_score
// - double * dotProduct(embedding_field_path)
//
// Function variables:
//
// - `relevance_score`: pre-defined keywords, used for measure relevance
// between query and document.
//
// - `embedding_field_path`: the document embedding field
// used with query embedding vector.
//
// - `dotProduct`: embedding function between `embedding_field_path` and
// query embedding vector.
//
// Example ranking expression:
//
// If document has an embedding field doc_embedding, the ranking expression
// could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
//
// If
// [ranking_expression_backend][google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend]
// is set to `RANK_BY_FORMULA`, the following expression types (and
// combinations of those chained using + or
// * operators) are supported:
//
// - `double`
//
// - `signal`
//
// - `log(signal)`
//
// - `exp(signal)`
//
// - `rr(signal, double > 0)` -- reciprocal rank transformation with second
// argument being a denominator constant.
//
// - `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
//
// - `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
// signal2 | double, else returns signal1.
//
// Here are a few examples of ranking formulas that use the supported
// ranking expression types:
//
// - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
// -- mostly rank by the logarithm of `keyword_similarity_score` with slight
// `semantic_smilarity_score` adjustment.
//
// - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
// is_nan(keyword_similarity_score)` -- rank by the exponent of
// `semantic_similarity_score` filling the value with 0 if it's NaN, also
// add constant 0.3 adjustment to the final score if
// `semantic_similarity_score` is NaN.
//
// - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
// rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
// of `keyword_similarity_score` with slight adjustment of reciprocal rank
// of `semantic_smilarity_score`.
//
// The following signals are supported:
//
// - `semantic_similarity_score`: semantic similarity adjustment that is
// calculated using the embeddings generated by a proprietary Google model.
// This score determines how semantically similar a search query is to a
// document.
// - `keyword_similarity_score`: keyword match adjustment uses the Best
// Match 25 (BM25) ranking function. This score is calculated using a
// probabilistic model to estimate the probability that a document is
// relevant to a given query.
// - `relevance_score`: semantic relevance adjustment that uses a
// proprietary Google model to determine the meaning and intent behind a
// user's query in context with the content in the documents.
// - `pctr_rank`: predicted conversion rate adjustment as a rank use
// predicted Click-through rate (pCTR) to gauge the relevance and
// attractiveness of a search result from a user's perspective. A higher
// pCTR suggests that the result is more likely to satisfy the user's query
// and intent, making it a valuable signal for ranking.
// - `freshness_rank`: freshness adjustment as a rank
// - `document_age`: The time in hours elapsed since the document was last
// updated, a floating-point number (e.g., 0.25 means 15 minutes).
// - `topicality_rank`: topicality adjustment as a rank. Uses proprietary
// Google model to determine the keyword-based overlap between the query and
// the document.
// - `base_rank`: the default rank of the result
RankingExpression string `protobuf:"bytes,26,opt,name=ranking_expression,json=rankingExpression,proto3" json:"ranking_expression,omitempty"`
// The backend to use for the ranking expression evaluation.
RankingExpressionBackend SearchRequest_RankingExpressionBackend `protobuf:"varint,53,opt,name=ranking_expression_backend,json=rankingExpressionBackend,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchRequest_RankingExpressionBackend" json:"ranking_expression_backend,omitempty"`
// Whether to turn on safe search. This is only supported for
// website search.
SafeSearch bool `protobuf:"varint,20,opt,name=safe_search,json=safeSearch,proto3" json:"safe_search,omitempty"`
// The user labels applied to a resource must meet the following requirements:
//
// - Each resource can have multiple labels, up to a maximum of 64.
// - Each label must be a key-value pair.
// - Keys have a minimum length of 1 character and a maximum length of 63
// characters and cannot be empty. Values can be empty and have a maximum
// length of 63 characters.
// - Keys and values can contain only lowercase letters, numeric characters,
// underscores, and dashes. All characters must use UTF-8 encoding, and
// international characters are allowed.
// - The key portion of a label must be unique. However, you can use the same
// key with multiple resources.
// - Keys must start with a lowercase letter or international character.
//
// See [Google Cloud
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
// for more details.
UserLabels map[string]string `protobuf:"bytes,22,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
// natural language query understanding will be done.
NaturalLanguageQueryUnderstandingSpec *SearchRequest_NaturalLanguageQueryUnderstandingSpec `protobuf:"bytes,28,opt,name=natural_language_query_understanding_spec,json=naturalLanguageQueryUnderstandingSpec,proto3" json:"natural_language_query_understanding_spec,omitempty"`
// Search as you type configuration. Only supported for the
// [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA]
// vertical.
SearchAsYouTypeSpec *SearchRequest_SearchAsYouTypeSpec `protobuf:"bytes,31,opt,name=search_as_you_type_spec,json=searchAsYouTypeSpec,proto3" json:"search_as_you_type_spec,omitempty"`
// Custom fine tuning configs.
// If set, it has higher priority than the configs set in
// [ServingConfig.custom_fine_tuning_spec][google.cloud.discoveryengine.v1alpha.ServingConfig.custom_fine_tuning_spec].
CustomFineTuningSpec *CustomFineTuningSpec `protobuf:"bytes,34,opt,name=custom_fine_tuning_spec,json=customFineTuningSpec,proto3" json:"custom_fine_tuning_spec,omitempty"`
// The session resource name. Optional.
//
// Session allows users to do multi-turn /search API calls or coordination
// between /search API calls and /answer API calls.
//
// Example #1 (multi-turn /search API calls):
//
// Call /search API with the session ID generated in the first call.
// Here, the previous search query gets considered in query
// standing. I.e., if the first query is "How did Alphabet do in 2022?"
// and the current query is "How about 2023?", the current query will
// be interpreted as "How did Alphabet do in 2023?".
//
// Example #2 (coordination between /search API calls and /answer API calls):
//
// Call /answer API with the session ID generated in the first call.
// Here, the answer generation happens in the context of the search
// results from the first search call.
//
// Multi-turn Search feature is currently at private GA stage. Please use
// v1alpha or v1beta version instead before we launch this feature to public
// GA. Or ask for allowlisting through Google Support team.
Session string `protobuf:"bytes,41,opt,name=session,proto3" json:"session,omitempty"`
// Session specification.
//
// Can be used only when `session` is set.
SessionSpec *SearchRequest_SessionSpec `protobuf:"bytes,42,opt,name=session_spec,json=sessionSpec,proto3" json:"session_spec,omitempty"`
// The relevance threshold of the search results.
//
// Default to Google defined threshold, leveraging a balance of
// precision and recall to deliver both highly accurate results and
// comprehensive coverage of relevant information.
RelevanceThreshold SearchRequest_RelevanceThreshold `protobuf:"varint,44,opt,name=relevance_threshold,json=relevanceThreshold,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchRequest_RelevanceThreshold" json:"relevance_threshold,omitempty"`
// contains filtered or unexported fields
}Request message for [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] method.
func (*SearchRequest) Descriptor
func (*SearchRequest) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.
func (*SearchRequest) GetBoostSpec
func (x *SearchRequest) GetBoostSpec() *SearchRequest_BoostSpecfunc (*SearchRequest) GetBranch
func (x *SearchRequest) GetBranch() stringfunc (*SearchRequest) GetCanonicalFilter
func (x *SearchRequest) GetCanonicalFilter() stringfunc (*SearchRequest) GetContentSearchSpec
func (x *SearchRequest) GetContentSearchSpec() *SearchRequest_ContentSearchSpecfunc (*SearchRequest) GetCustomFineTuningSpec
func (x *SearchRequest) GetCustomFineTuningSpec() *CustomFineTuningSpecfunc (*SearchRequest) GetDataStoreSpecs
func (x *SearchRequest) GetDataStoreSpecs() []*SearchRequest_DataStoreSpecfunc (*SearchRequest) GetEmbeddingSpec
func (x *SearchRequest) GetEmbeddingSpec() *SearchRequest_EmbeddingSpecfunc (*SearchRequest) GetFacetSpecs
func (x *SearchRequest) GetFacetSpecs() []*SearchRequest_FacetSpecfunc (*SearchRequest) GetFilter
func (x *SearchRequest) GetFilter() stringfunc (*SearchRequest) GetImageQuery
func (x *SearchRequest) GetImageQuery() *SearchRequest_ImageQueryfunc (*SearchRequest) GetLanguageCode
func (x *SearchRequest) GetLanguageCode() stringfunc (*SearchRequest) GetNaturalLanguageQueryUnderstandingSpec
func (x *SearchRequest) GetNaturalLanguageQueryUnderstandingSpec() *SearchRequest_NaturalLanguageQueryUnderstandingSpecfunc (*SearchRequest) GetOffset
func (x *SearchRequest) GetOffset() int32func (*SearchRequest) GetOrderBy
func (x *SearchRequest) GetOrderBy() stringfunc (*SearchRequest) GetPageSize
func (x *SearchRequest) GetPageSize() int32func (*SearchRequest) GetPageToken
func (x *SearchRequest) GetPageToken() stringfunc (*SearchRequest) GetParams
func (x *SearchRequest) GetParams() map[string]*structpb.Valuefunc (*SearchRequest) GetQuery
func (x *SearchRequest) GetQuery() stringfunc (*SearchRequest) GetQueryExpansionSpec
func (x *SearchRequest) GetQueryExpansionSpec() *SearchRequest_QueryExpansionSpecfunc (*SearchRequest) GetRankingExpression
func (x *SearchRequest) GetRankingExpression() stringfunc (*SearchRequest) GetRankingExpressionBackend
func (x *SearchRequest) GetRankingExpressionBackend() SearchRequest_RankingExpressionBackendfunc (*SearchRequest) GetRegionCode
func (x *SearchRequest) GetRegionCode() stringfunc (*SearchRequest) GetRelevanceThreshold
func (x *SearchRequest) GetRelevanceThreshold() SearchRequest_RelevanceThresholdfunc (*SearchRequest) GetSafeSearch
func (x *SearchRequest) GetSafeSearch() boolfunc (*SearchRequest) GetSearchAsYouTypeSpec
func (x *SearchRequest) GetSearchAsYouTypeSpec() *SearchRequest_SearchAsYouTypeSpecfunc (*SearchRequest) GetServingConfig
func (x *SearchRequest) GetServingConfig() stringfunc (*SearchRequest) GetSession
func (x *SearchRequest) GetSession() stringfunc (*SearchRequest) GetSessionSpec
func (x *SearchRequest) GetSessionSpec() *SearchRequest_SessionSpecfunc (*SearchRequest) GetSpellCorrectionSpec
func (x *SearchRequest) GetSpellCorrectionSpec() *SearchRequest_SpellCorrectionSpecfunc (*SearchRequest) GetUserInfo
func (x *SearchRequest) GetUserInfo() *UserInfofunc (*SearchRequest) GetUserLabels
func (x *SearchRequest) GetUserLabels() map[string]stringfunc (*SearchRequest) GetUserPseudoId
func (x *SearchRequest) GetUserPseudoId() stringfunc (*SearchRequest) ProtoMessage
func (*SearchRequest) ProtoMessage()func (*SearchRequest) ProtoReflect
func (x *SearchRequest) ProtoReflect() protoreflect.Messagefunc (*SearchRequest) Reset
func (x *SearchRequest) Reset()func (*SearchRequest) String
func (x *SearchRequest) String() stringSearchRequest_BoostSpec
type SearchRequest_BoostSpec struct {
// Condition boost specifications. If a document matches multiple conditions
// in the specifictions, boost scores from these specifications are all
// applied and combined in a non-linear way. Maximum number of
// specifications is 20.
ConditionBoostSpecs []*SearchRequest_BoostSpec_ConditionBoostSpec `protobuf:"bytes,1,rep,name=condition_boost_specs,json=conditionBoostSpecs,proto3" json:"condition_boost_specs,omitempty"`
// contains filtered or unexported fields
}Boost specification to boost certain documents.
func (*SearchRequest_BoostSpec) Descriptor
func (*SearchRequest_BoostSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_BoostSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_BoostSpec) GetConditionBoostSpecs
func (x *SearchRequest_BoostSpec) GetConditionBoostSpecs() []*SearchRequest_BoostSpec_ConditionBoostSpecfunc (*SearchRequest_BoostSpec) ProtoMessage
func (*SearchRequest_BoostSpec) ProtoMessage()func (*SearchRequest_BoostSpec) ProtoReflect
func (x *SearchRequest_BoostSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_BoostSpec) Reset
func (x *SearchRequest_BoostSpec) Reset()func (*SearchRequest_BoostSpec) String
func (x *SearchRequest_BoostSpec) String() stringSearchRequest_BoostSpec_ConditionBoostSpec
type SearchRequest_BoostSpec_ConditionBoostSpec struct {
// An expression which specifies a boost condition. The syntax and
// supported fields are the same as a filter expression. See
// [SearchRequest.filter][google.cloud.discoveryengine.v1alpha.SearchRequest.filter]
// for detail syntax and limitations.
//
// Examples:
//
// * To boost documents with document ID "doc_1" or "doc_2", and
// color "Red" or "Blue":
// `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
Condition string `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"`
// Strength of the condition boost, which should be in [-1, 1]. Negative
// boost means demotion. Default is 0.0.
//
// Setting to 1.0 gives the document a big promotion. However, it does
// not necessarily mean that the boosted document will be the top result
// at all times, nor that other documents will be excluded. Results
// could still be shown even when none of them matches the condition.
// And results that are significantly more relevant to the search query
// can still trump your heavily favored but irrelevant documents.
//
// Setting to -1.0 gives the document a big demotion. However, results
// that are deeply relevant might still be shown. The document will have
// an upstream battle to get a fairly high ranking, but it is not
// blocked out completely.
//
// Setting to 0.0 means no boost applied. The boosting condition is
// ignored. Only one of the (condition, boost) combination or the
// boost_control_spec below are set. If both are set then the global boost
// is ignored and the more fine-grained boost_control_spec is applied.
Boost float32 `protobuf:"fixed32,2,opt,name=boost,proto3" json:"boost,omitempty"`
// Complex specification for custom ranking based on customer defined
// attribute value.
BoostControlSpec *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec `protobuf:"bytes,3,opt,name=boost_control_spec,json=boostControlSpec,proto3" json:"boost_control_spec,omitempty"`
// contains filtered or unexported fields
}Boost applies to documents which match a condition.
func (*SearchRequest_BoostSpec_ConditionBoostSpec) Descriptor
func (*SearchRequest_BoostSpec_ConditionBoostSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost() float32func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoostControlSpec
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetBoostControlSpec() *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpecfunc (*SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition() stringfunc (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage
func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage()func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_BoostSpec_ConditionBoostSpec) Reset
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) Reset()func (*SearchRequest_BoostSpec_ConditionBoostSpec) String
func (x *SearchRequest_BoostSpec_ConditionBoostSpec) String() stringSearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec
type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec struct {
// The name of the field whose value will be used to determine the
// boost amount.
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// The attribute type to be used to determine the boost amount. The
// attribute value can be derived from the field value of the specified
// field_name. In the case of numerical it is straightforward i.e.
// attribute_value = numerical_field_value. In the case of freshness
// however, attribute_value = (time.now() - datetime_field_value).
AttributeType SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType `protobuf:"varint,2,opt,name=attribute_type,json=attributeType,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType" json:"attribute_type,omitempty"`
// The interpolation type to be applied to connect the control points
// listed below.
InterpolationType SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType `protobuf:"varint,3,opt,name=interpolation_type,json=interpolationType,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType" json:"interpolation_type,omitempty"`
// The control points used to define the curve. The monotonic function
// (defined through the interpolation_type above) passes through the
// control points listed here.
ControlPoints []*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint `protobuf:"bytes,4,rep,name=control_points,json=controlPoints,proto3" json:"control_points,omitempty"`
// contains filtered or unexported fields
}Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Descriptor
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetAttributeType
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetAttributeType() SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeTypefunc (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetControlPoints
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetControlPoints() []*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPointfunc (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetFieldName
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetFieldName() stringfunc (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetInterpolationType
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetInterpolationType() SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationTypefunc (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoMessage
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoMessage()func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoReflect
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Reset
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) Reset()func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) String
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec) String() stringSearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType
type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType int32The attribute(or function) for which the custom ranking is to be applied.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ATTRIBUTE_TYPE_UNSPECIFIED, SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_NUMERICAL, SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_FRESHNESS
const (
// Unspecified AttributeType.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ATTRIBUTE_TYPE_UNSPECIFIED SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType = 0
// The value of the numerical field will be used to dynamically update
// the boost amount. In this case, the attribute_value (the x value)
// of the control point will be the actual value of the numerical
// field for which the boost_amount is specified.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_NUMERICAL SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType = 1
// For the freshness use case the attribute value will be the duration
// between the current time and the date in the datetime field
// specified. The value must be formatted as an XSD `dayTimeDuration`
// value (a restricted subset of an ISO 8601 duration value). The
// pattern for this is: `[nD][T[nH][nM][nS]]`.
// For example, `5D`, `3DT12H30M`, `T24H`.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_FRESHNESS SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType = 2
)func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Descriptor
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Descriptor() protoreflect.EnumDescriptorfunc (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Enum
func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Enum() *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeTypefunc (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) EnumDescriptor
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType.Descriptor instead.
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Number
func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Number() protoreflect.EnumNumberfunc (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) String
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Type
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Type() protoreflect.EnumTypeSearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint
type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint struct {
// Can be one of:
// 1. The numerical field value.
// 2. The duration spec for freshness:
// The value must be formatted as an XSD `dayTimeDuration` value (a
// restricted subset of an ISO 8601 duration value). The pattern for
// this is: `[nD][T[nH][nM][nS]]`.
AttributeValue string `protobuf:"bytes,1,opt,name=attribute_value,json=attributeValue,proto3" json:"attribute_value,omitempty"`
// The value between -1 to 1 by which to boost the score if the
// attribute_value evaluates to the value specified above.
BoostAmount float32 `protobuf:"fixed32,2,opt,name=boost_amount,json=boostAmount,proto3" json:"boost_amount,omitempty"`
// contains filtered or unexported fields
}The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Descriptor
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint.ProtoReflect.Descriptor instead.
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetAttributeValue
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetAttributeValue() stringfunc (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetBoostAmount
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetBoostAmount() float32func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoMessage
func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoMessage()func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoReflect
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Reset
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Reset()func (*SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) String
func (x *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) String() stringSearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType
type SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType int32The interpolation type to be applied. Default will be linear (Piecewise Linear).
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_INTERPOLATION_TYPE_UNSPECIFIED, SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_LINEAR
const (
// Interpolation type is unspecified. In this case, it defaults to
// Linear.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_INTERPOLATION_TYPE_UNSPECIFIED SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType = 0
// Piecewise linear interpolation will be applied.
SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_LINEAR SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType = 1
)func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Descriptor
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Descriptor() protoreflect.EnumDescriptorfunc (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Enum
func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Enum() *SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationTypefunc (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) EnumDescriptor
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType.Descriptor instead.
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Number
func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Number() protoreflect.EnumNumberfunc (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) String
func (x SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) String() stringfunc (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Type
func (SearchRequest_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Type() protoreflect.EnumTypeSearchRequest_ContentSearchSpec
type SearchRequest_ContentSearchSpec struct {
// If `snippetSpec` is not specified, snippets are not included in the
// search response.
SnippetSpec *SearchRequest_ContentSearchSpec_SnippetSpec `protobuf:"bytes,1,opt,name=snippet_spec,json=snippetSpec,proto3" json:"snippet_spec,omitempty"`
// If `summarySpec` is not specified, summaries are not included in the
// search response.
SummarySpec *SearchRequest_ContentSearchSpec_SummarySpec `protobuf:"bytes,2,opt,name=summary_spec,json=summarySpec,proto3" json:"summary_spec,omitempty"`
// If there is no extractive_content_spec provided, there will be no
// extractive answer in the search response.
ExtractiveContentSpec *SearchRequest_ContentSearchSpec_ExtractiveContentSpec `protobuf:"bytes,3,opt,name=extractive_content_spec,json=extractiveContentSpec,proto3" json:"extractive_content_spec,omitempty"`
// Specifies the search result mode. If unspecified, the
// search result mode defaults to `DOCUMENTS`.
SearchResultMode SearchRequest_ContentSearchSpec_SearchResultMode `protobuf:"varint,4,opt,name=search_result_mode,json=searchResultMode,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchRequest_ContentSearchSpec_SearchResultMode" json:"search_result_mode,omitempty"`
// Specifies the chunk spec to be returned from the search response.
// Only available if the
// [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode]
// is set to
// [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
ChunkSpec *SearchRequest_ContentSearchSpec_ChunkSpec `protobuf:"bytes,5,opt,name=chunk_spec,json=chunkSpec,proto3" json:"chunk_spec,omitempty"`
// contains filtered or unexported fields
}A specification for configuring the behavior of content search.
func (*SearchRequest_ContentSearchSpec) Descriptor
func (*SearchRequest_ContentSearchSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_ContentSearchSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec) GetChunkSpec
func (x *SearchRequest_ContentSearchSpec) GetChunkSpec() *SearchRequest_ContentSearchSpec_ChunkSpecfunc (*SearchRequest_ContentSearchSpec) GetExtractiveContentSpec
func (x *SearchRequest_ContentSearchSpec) GetExtractiveContentSpec() *SearchRequest_ContentSearchSpec_ExtractiveContentSpecfunc (*SearchRequest_ContentSearchSpec) GetSearchResultMode
func (x *SearchRequest_ContentSearchSpec) GetSearchResultMode() SearchRequest_ContentSearchSpec_SearchResultModefunc (*SearchRequest_ContentSearchSpec) GetSnippetSpec
func (x *SearchRequest_ContentSearchSpec) GetSnippetSpec() *SearchRequest_ContentSearchSpec_SnippetSpecfunc (*SearchRequest_ContentSearchSpec) GetSummarySpec
func (x *SearchRequest_ContentSearchSpec) GetSummarySpec() *SearchRequest_ContentSearchSpec_SummarySpecfunc (*SearchRequest_ContentSearchSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec) ProtoMessage()func (*SearchRequest_ContentSearchSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_ContentSearchSpec) Reset
func (x *SearchRequest_ContentSearchSpec) Reset()func (*SearchRequest_ContentSearchSpec) String
func (x *SearchRequest_ContentSearchSpec) String() stringSearchRequest_ContentSearchSpec_ChunkSpec
type SearchRequest_ContentSearchSpec_ChunkSpec struct {
// The number of previous chunks to be returned of the current chunk. The
// maximum allowed value is 3.
// If not specified, no previous chunks will be returned.
NumPreviousChunks int32 `protobuf:"varint,1,opt,name=num_previous_chunks,json=numPreviousChunks,proto3" json:"num_previous_chunks,omitempty"`
// The number of next chunks to be returned of the current chunk. The
// maximum allowed value is 3.
// If not specified, no next chunks will be returned.
NumNextChunks int32 `protobuf:"varint,2,opt,name=num_next_chunks,json=numNextChunks,proto3" json:"num_next_chunks,omitempty"`
// contains filtered or unexported fields
}Specifies the chunk spec to be returned from the search response. Only available if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
func (*SearchRequest_ContentSearchSpec_ChunkSpec) Descriptor
func (*SearchRequest_ContentSearchSpec_ChunkSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_ContentSearchSpec_ChunkSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_ChunkSpec) GetNumNextChunks
func (x *SearchRequest_ContentSearchSpec_ChunkSpec) GetNumNextChunks() int32func (*SearchRequest_ContentSearchSpec_ChunkSpec) GetNumPreviousChunks
func (x *SearchRequest_ContentSearchSpec_ChunkSpec) GetNumPreviousChunks() int32func (*SearchRequest_ContentSearchSpec_ChunkSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_ChunkSpec) ProtoMessage()func (*SearchRequest_ContentSearchSpec_ChunkSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_ChunkSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_ContentSearchSpec_ChunkSpec) Reset
func (x *SearchRequest_ContentSearchSpec_ChunkSpec) Reset()func (*SearchRequest_ContentSearchSpec_ChunkSpec) String
func (x *SearchRequest_ContentSearchSpec_ChunkSpec) String() stringSearchRequest_ContentSearchSpec_ExtractiveContentSpec
type SearchRequest_ContentSearchSpec_ExtractiveContentSpec struct {
// The maximum number of extractive answers returned in each search
// result.
//
// An extractive answer is a verbatim answer extracted from the original
// document, which provides a precise and contextually relevant answer to
// the search query.
//
// If the number of matching answers is less than the
// `max_extractive_answer_count`, return all of the answers. Otherwise,
// return the `max_extractive_answer_count`.
//
// At most five answers are returned for each
// [SearchResult][google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult].
MaxExtractiveAnswerCount int32 `protobuf:"varint,1,opt,name=max_extractive_answer_count,json=maxExtractiveAnswerCount,proto3" json:"max_extractive_answer_count,omitempty"`
// The max number of extractive segments returned in each search result.
// Only applied if the
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is set to
// [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.CONTENT_REQUIRED]
// or
// [DataStore.solution_types][google.cloud.discoveryengine.v1alpha.DataStore.solution_types]
// is
// [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
//
// An extractive segment is a text segment extracted from the original
// document that is relevant to the search query, and, in general, more
// verbose than an extractive answer. The segment could then be used as
// input for LLMs to generate summaries and answers.
//
// If the number of matching segments is less than
// `max_extractive_segment_count`, return all of the segments. Otherwise,
// return the `max_extractive_segment_count`.
MaxExtractiveSegmentCount int32 `protobuf:"varint,2,opt,name=max_extractive_segment_count,json=maxExtractiveSegmentCount,proto3" json:"max_extractive_segment_count,omitempty"`
// Specifies whether to return the confidence score from the extractive
// segments in each search result. This feature is available only for new
// or allowlisted data stores. To allowlist your data store,
// contact your Customer Engineer. The default value is `false`.
ReturnExtractiveSegmentScore bool `protobuf:"varint,3,opt,name=return_extractive_segment_score,json=returnExtractiveSegmentScore,proto3" json:"return_extractive_segment_score,omitempty"`
// Specifies whether to also include the adjacent from each selected
// segments.
// Return at most `num_previous_segments` segments before each selected
// segments.
NumPreviousSegments int32 `protobuf:"varint,4,opt,name=num_previous_segments,json=numPreviousSegments,proto3" json:"num_previous_segments,omitempty"`
// Return at most `num_next_segments` segments after each selected
// segments.
NumNextSegments int32 `protobuf:"varint,5,opt,name=num_next_segments,json=numNextSegments,proto3" json:"num_next_segments,omitempty"`
// contains filtered or unexported fields
}A specification for configuring the extractive content in a search response.
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Descriptor
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_ContentSearchSpec_ExtractiveContentSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveAnswerCount
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveAnswerCount() int32func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveSegmentCount
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetMaxExtractiveSegmentCount() int32func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumNextSegments
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumNextSegments() int32func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumPreviousSegments
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetNumPreviousSegments() int32func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetReturnExtractiveSegmentScore
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) GetReturnExtractiveSegmentScore() boolfunc (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoMessage()func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Reset
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) Reset()func (*SearchRequest_ContentSearchSpec_ExtractiveContentSpec) String
func (x *SearchRequest_ContentSearchSpec_ExtractiveContentSpec) String() stringSearchRequest_ContentSearchSpec_SearchResultMode
type SearchRequest_ContentSearchSpec_SearchResultMode int32Specifies the search result mode. If unspecified, the
search result mode defaults to DOCUMENTS.
SearchRequest_ContentSearchSpec_SEARCH_RESULT_MODE_UNSPECIFIED, SearchRequest_ContentSearchSpec_DOCUMENTS, SearchRequest_ContentSearchSpec_CHUNKS
const (
// Default value.
SearchRequest_ContentSearchSpec_SEARCH_RESULT_MODE_UNSPECIFIED SearchRequest_ContentSearchSpec_SearchResultMode = 0
// Returns documents in the search result.
SearchRequest_ContentSearchSpec_DOCUMENTS SearchRequest_ContentSearchSpec_SearchResultMode = 1
// Returns chunks in the search result. Only available if the
// [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
SearchRequest_ContentSearchSpec_CHUNKS SearchRequest_ContentSearchSpec_SearchResultMode = 2
)func (SearchRequest_ContentSearchSpec_SearchResultMode) Descriptor
func (SearchRequest_ContentSearchSpec_SearchResultMode) Descriptor() protoreflect.EnumDescriptorfunc (SearchRequest_ContentSearchSpec_SearchResultMode) Enum
func (x SearchRequest_ContentSearchSpec_SearchResultMode) Enum() *SearchRequest_ContentSearchSpec_SearchResultModefunc (SearchRequest_ContentSearchSpec_SearchResultMode) EnumDescriptor
func (SearchRequest_ContentSearchSpec_SearchResultMode) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchRequest_ContentSearchSpec_SearchResultMode.Descriptor instead.
func (SearchRequest_ContentSearchSpec_SearchResultMode) Number
func (x SearchRequest_ContentSearchSpec_SearchResultMode) Number() protoreflect.EnumNumberfunc (SearchRequest_ContentSearchSpec_SearchResultMode) String
func (x SearchRequest_ContentSearchSpec_SearchResultMode) String() stringfunc (SearchRequest_ContentSearchSpec_SearchResultMode) Type
SearchRequest_ContentSearchSpec_SnippetSpec
type SearchRequest_ContentSearchSpec_SnippetSpec struct {
// [DEPRECATED] This field is deprecated. To control snippet return, use
// `return_snippet` field. For backwards compatibility, we will return
// snippet if max_snippet_count > 0.
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/search_service.proto.
MaxSnippetCount int32 `protobuf:"varint,1,opt,name=max_snippet_count,json=maxSnippetCount,proto3" json:"max_snippet_count,omitempty"`
// [DEPRECATED] This field is deprecated and will have no affect on the
// snippet.
//
// Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/search_service.proto.
ReferenceOnly bool `protobuf:"varint,2,opt,name=reference_only,json=referenceOnly,proto3" json:"reference_only,omitempty"`
// If `true`, then return snippet. If no snippet can be generated, we
// return "No snippet is available for this page." A `snippet_status` with
// `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
ReturnSnippet bool `protobuf:"varint,3,opt,name=return_snippet,json=returnSnippet,proto3" json:"return_snippet,omitempty"`
// contains filtered or unexported fields
}A specification for configuring snippets in a search response.
func (*SearchRequest_ContentSearchSpec_SnippetSpec) Descriptor
func (*SearchRequest_ContentSearchSpec_SnippetSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_ContentSearchSpec_SnippetSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetMaxSnippetCount
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetMaxSnippetCount() int32Deprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/search_service.proto.
func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReferenceOnly() boolDeprecated: Marked as deprecated in google/cloud/discoveryengine/v1alpha/search_service.proto.
func (*SearchRequest_ContentSearchSpec_SnippetSpec) GetReturnSnippet
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) GetReturnSnippet() boolfunc (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoMessage()func (*SearchRequest_ContentSearchSpec_SnippetSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_ContentSearchSpec_SnippetSpec) Reset
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) Reset()func (*SearchRequest_ContentSearchSpec_SnippetSpec) String
func (x *SearchRequest_ContentSearchSpec_SnippetSpec) String() stringSearchRequest_ContentSearchSpec_SummarySpec
type SearchRequest_ContentSearchSpec_SummarySpec struct {
// The number of top results to generate the summary from. If the number
// of results returned is less than `summaryResultCount`, the summary is
// generated from all of the results.
//
// At most 10 results for documents mode, or 50 for chunks mode, can be
// used to generate a summary. The chunks mode is used when
// [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode]
// is set to
// [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
SummaryResultCount int32 `protobuf:"varint,1,opt,name=summary_result_count,json=summaryResultCount,proto3" json:"summary_result_count,omitempty"`
// Specifies whether to include citations in the summary. The default
// value is `false`.
//
// When this field is set to `true`, summaries include in-line citation
// numbers.
//
// Example summary including citations:
//
// BigQuery is Google Cloud's fully managed and completely serverless
// enterprise data warehouse [1]. BigQuery supports all data types, works
// across clouds, and has built-in machine learning and business
// intelligence, all within a unified platform [2, 3].
//
// The citation numbers refer to the returned search results and are
// 1-indexed. For example, [1] means that the sentence is attributed to
// the first search result. [2, 3] means that the sentence is attributed
// to both the second and third search results.
IncludeCitations bool `protobuf:"varint,2,opt,name=include_citations,json=includeCitations,proto3" json:"include_citations,omitempty"`
// Specifies whether to filter out adversarial queries. The default value
// is `false`.
//
// Google employs search-query classification to detect adversarial
// queries. No summary is returned if the search query is classified as an
// adversarial query. For example, a user might ask a question regarding
// negative comments about the company or submit a query designed to
// generate unsafe, policy-violating output. If this field is set to
// `true`, we skip generating summaries for adversarial queries and return
// fallback messages instead.
IgnoreAdversarialQuery bool `protobuf:"varint,3,opt,name=ignore_adversarial_query,json=ignoreAdversarialQuery,proto3" json:"ignore_adversarial_query,omitempty"`
// Specifies whether to filter out queries that are not summary-seeking.
// The default value is `false`.
//
// Google employs search-query classification to detect summary-seeking
// queries. No summary is returned if the search query is classified as a
// non-summary seeking query. For example, `why is the sky blue` and `Who
// is the best soccer player in the world?` are summary-seeking queries,
// but `SFO airport` and `world cup 2026` are not. They are most likely
// navigational queries. If this field is set to `true`, we skip
// generating summaries for non-summary seeking queries and return
// fallback messages instead.
IgnoreNonSummarySeekingQuery bool `protobuf:"varint,4,opt,name=ignore_non_summary_seeking_query,json=ignoreNonSummarySeekingQuery,proto3" json:"ignore_non_summary_seeking_query,omitempty"`
// Specifies whether to filter out queries that have low relevance. The
// default value is `false`.
//
// If this field is set to `false`, all search results are used regardless
// of relevance to generate answers. If set to `true`, only queries with
// high relevance search results will generate answers.
IgnoreLowRelevantContent bool `protobuf:"varint,9,opt,name=ignore_low_relevant_content,json=ignoreLowRelevantContent,proto3" json:"ignore_low_relevant_content,omitempty"`
// If specified, the spec will be used to modify the prompt provided to
// the LLM.
ModelPromptSpec *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec `protobuf:"bytes,5,opt,name=model_prompt_spec,json=modelPromptSpec,proto3" json:"model_prompt_spec,omitempty"`
// Language code for Summary. Use language tags defined by
// [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
// Note: This is an experimental feature.
LanguageCode string `protobuf:"bytes,6,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// If specified, the spec will be used to modify the model specification
// provided to the LLM.
ModelSpec *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec `protobuf:"bytes,7,opt,name=model_spec,json=modelSpec,proto3" json:"model_spec,omitempty"`
// If true, answer will be generated from most relevant chunks from top
// search results. This feature will improve summary quality.
// Note that with this feature enabled, not all top search results
// will be referenced and included in the reference list, so the citation
// source index only points to the search results listed in the reference
// list.
UseSemanticChunks bool `protobuf:"varint,8,opt,name=use_semantic_chunks,json=useSemanticChunks,proto3" json:"use_semantic_chunks,omitempty"`
// contains filtered or unexported fields
}A specification for configuring a summary returned in a search response.
func (*SearchRequest_ContentSearchSpec_SummarySpec) Descriptor
func (*SearchRequest_ContentSearchSpec_SummarySpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreAdversarialQuery
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreAdversarialQuery() boolfunc (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreLowRelevantContent
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreLowRelevantContent() boolfunc (*SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreNonSummarySeekingQuery
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIgnoreNonSummarySeekingQuery() boolfunc (*SearchRequest_ContentSearchSpec_SummarySpec) GetIncludeCitations
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetIncludeCitations() boolfunc (*SearchRequest_ContentSearchSpec_SummarySpec) GetLanguageCode
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetLanguageCode() stringfunc (*SearchRequest_ContentSearchSpec_SummarySpec) GetModelPromptSpec
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetModelPromptSpec() *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpecfunc (*SearchRequest_ContentSearchSpec_SummarySpec) GetModelSpec
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetModelSpec() *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpecfunc (*SearchRequest_ContentSearchSpec_SummarySpec) GetSummaryResultCount
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetSummaryResultCount() int32func (*SearchRequest_ContentSearchSpec_SummarySpec) GetUseSemanticChunks
func (x *SearchRequest_ContentSearchSpec_SummarySpec) GetUseSemanticChunks() boolfunc (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoMessage()func (*SearchRequest_ContentSearchSpec_SummarySpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_SummarySpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_ContentSearchSpec_SummarySpec) Reset
func (x *SearchRequest_ContentSearchSpec_SummarySpec) Reset()func (*SearchRequest_ContentSearchSpec_SummarySpec) String
func (x *SearchRequest_ContentSearchSpec_SummarySpec) String() stringSearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec
type SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec struct {
// Text at the beginning of the prompt that instructs the assistant.
// Examples are available in the user guide.
Preamble string `protobuf:"bytes,1,opt,name=preamble,proto3" json:"preamble,omitempty"`
// contains filtered or unexported fields
}Specification of the prompt to use with the model.
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Descriptor
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) GetPreamble
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) GetPreamble() stringfunc (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoMessage()func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Reset
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) Reset()func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) String
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelPromptSpec) String() stringSearchRequest_ContentSearchSpec_SummarySpec_ModelSpec
type SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec struct {
// The model version used to generate the summary.
//
// Supported values are:
//
// - `stable`: string. Default value when no value is specified. Uses a
// generally available, fine-tuned model. For more information, see
// [Answer generation model versions and
// lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
// - `preview`: string. (Public preview) Uses a preview model. For more
// information, see
// [Answer generation model versions and
// lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
// contains filtered or unexported fields
}Specification of the model.
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Descriptor
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) GetVersion
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) GetVersion() stringfunc (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoMessage
func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoMessage()func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoReflect
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Reset
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) Reset()func (*SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) String
func (x *SearchRequest_ContentSearchSpec_SummarySpec_ModelSpec) String() stringSearchRequest_DataStoreSpec
type SearchRequest_DataStoreSpec struct {
// Required. Full resource name of
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], such as
// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// contains filtered or unexported fields
}A struct to define data stores to filter on in a search call and
configurations for those data stores. Otherwise, an INVALID_ARGUMENT
error is returned.
func (*SearchRequest_DataStoreSpec) Descriptor
func (*SearchRequest_DataStoreSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_DataStoreSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_DataStoreSpec) GetDataStore
func (x *SearchRequest_DataStoreSpec) GetDataStore() stringfunc (*SearchRequest_DataStoreSpec) ProtoMessage
func (*SearchRequest_DataStoreSpec) ProtoMessage()func (*SearchRequest_DataStoreSpec) ProtoReflect
func (x *SearchRequest_DataStoreSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_DataStoreSpec) Reset
func (x *SearchRequest_DataStoreSpec) Reset()func (*SearchRequest_DataStoreSpec) String
func (x *SearchRequest_DataStoreSpec) String() stringSearchRequest_EmbeddingSpec
type SearchRequest_EmbeddingSpec struct {
// The embedding vector used for retrieval. Limit to 1.
EmbeddingVectors []*SearchRequest_EmbeddingSpec_EmbeddingVector `protobuf:"bytes,1,rep,name=embedding_vectors,json=embeddingVectors,proto3" json:"embedding_vectors,omitempty"`
// contains filtered or unexported fields
}The specification that uses customized query embedding vector to do semantic document retrieval.
func (*SearchRequest_EmbeddingSpec) Descriptor
func (*SearchRequest_EmbeddingSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_EmbeddingSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_EmbeddingSpec) GetEmbeddingVectors
func (x *SearchRequest_EmbeddingSpec) GetEmbeddingVectors() []*SearchRequest_EmbeddingSpec_EmbeddingVectorfunc (*SearchRequest_EmbeddingSpec) ProtoMessage
func (*SearchRequest_EmbeddingSpec) ProtoMessage()func (*SearchRequest_EmbeddingSpec) ProtoReflect
func (x *SearchRequest_EmbeddingSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_EmbeddingSpec) Reset
func (x *SearchRequest_EmbeddingSpec) Reset()func (*SearchRequest_EmbeddingSpec) String
func (x *SearchRequest_EmbeddingSpec) String() stringSearchRequest_EmbeddingSpec_EmbeddingVector
type SearchRequest_EmbeddingSpec_EmbeddingVector struct {
// Embedding field path in schema.
FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
// Query embedding vector.
Vector []float32 `protobuf:"fixed32,2,rep,packed,name=vector,proto3" json:"vector,omitempty"`
// contains filtered or unexported fields
}Embedding vector.
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) Descriptor
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_EmbeddingSpec_EmbeddingVector.ProtoReflect.Descriptor instead.
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) GetFieldPath
func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) GetFieldPath() stringfunc (*SearchRequest_EmbeddingSpec_EmbeddingVector) GetVector
func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) GetVector() []float32func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoMessage
func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoMessage()func (*SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoReflect
func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_EmbeddingSpec_EmbeddingVector) Reset
func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) Reset()func (*SearchRequest_EmbeddingSpec_EmbeddingVector) String
func (x *SearchRequest_EmbeddingSpec_EmbeddingVector) String() stringSearchRequest_FacetSpec
type SearchRequest_FacetSpec struct {
// Required. The facet key specification.
FacetKey *SearchRequest_FacetSpec_FacetKey `protobuf:"bytes,1,opt,name=facet_key,json=facetKey,proto3" json:"facet_key,omitempty"`
// Maximum facet values that are returned for this facet. If
// unspecified, defaults to 20. The maximum allowed value is 300. Values
// above 300 are coerced to 300.
// For aggregation in healthcare search, when the [FacetKey.key] is
// "healthcare_aggregation_key", the limit will be overridden to
// 10,000 internally, regardless of the value set here.
//
// If this field is negative, an `INVALID_ARGUMENT` is returned.
Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
// List of keys to exclude when faceting.
//
// By default,
// [FacetKey.key][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.key]
// is not excluded from the filter unless it is listed in this field.
//
// Listing a facet key in this field allows its values to appear as facet
// results, even when they are filtered out of search results. Using this
// field does not affect what search results are returned.
//
// For example, suppose there are 100 documents with the color facet "Red"
// and 200 documents with the color facet "Blue". A query containing the
// filter "color:ANY("Red")" and having "color" as
// [FacetKey.key][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.key]
// would by default return only "Red" documents in the search results, and
// also return "Red" with count 100 as the only color facet. Although there
// are also blue documents available, "Blue" would not be shown as an
// available facet value.
//
// If "color" is listed in "excludedFilterKeys", then the query returns the
// facet values "Red" with count 100 and "Blue" with count 200, because the
// "color" key is now excluded from the filter. Because this field doesn't
// affect search results, the search results are still correctly filtered to
// return only "Red" documents.
//
// A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
// error is returned.
ExcludedFilterKeys []string `protobuf:"bytes,3,rep,name=excluded_filter_keys,json=excludedFilterKeys,proto3" json:"excluded_filter_keys,omitempty"`
// Enables dynamic position for this facet. If set to true, the position of
// this facet among all facets in the response is determined automatically.
// If dynamic facets are enabled, it is ordered together.
// If set to false, the position of this facet in the
// response is the same as in the request, and it is ranked before
// the facets with dynamic position enable and all dynamic facets.
//
// For example, you may always want to have rating facet returned in
// the response, but it's not necessarily to always display the rating facet
// at the top. In that case, you can set enable_dynamic_position to true so
// that the position of rating facet in response is determined
// automatically.
//
// Another example, assuming you have the following facets in the request:
//
// * "rating", enable_dynamic_position = true
//
// * "price", enable_dynamic_position = false
//
// * "brands", enable_dynamic_position = false
//
// And also you have a dynamic facets enabled, which generates a facet
// `gender`. Then the final order of the facets in the response can be
// ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
// "rating") depends on how API orders "gender" and "rating" facets.
// However, notice that "price" and "brands" are always
// ranked at first and second position because their enable_dynamic_position
// is false.
EnableDynamicPosition bool `protobuf:"varint,4,opt,name=enable_dynamic_position,json=enableDynamicPosition,proto3" json:"enable_dynamic_position,omitempty"`
// contains filtered or unexported fields
}A facet specification to perform faceted search.
func (*SearchRequest_FacetSpec) Descriptor
func (*SearchRequest_FacetSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_FacetSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_FacetSpec) GetEnableDynamicPosition
func (x *SearchRequest_FacetSpec) GetEnableDynamicPosition() boolfunc (*SearchRequest_FacetSpec) GetExcludedFilterKeys
func (x *SearchRequest_FacetSpec) GetExcludedFilterKeys() []stringfunc (*SearchRequest_FacetSpec) GetFacetKey
func (x *SearchRequest_FacetSpec) GetFacetKey() *SearchRequest_FacetSpec_FacetKeyfunc (*SearchRequest_FacetSpec) GetLimit
func (x *SearchRequest_FacetSpec) GetLimit() int32func (*SearchRequest_FacetSpec) ProtoMessage
func (*SearchRequest_FacetSpec) ProtoMessage()func (*SearchRequest_FacetSpec) ProtoReflect
func (x *SearchRequest_FacetSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_FacetSpec) Reset
func (x *SearchRequest_FacetSpec) Reset()func (*SearchRequest_FacetSpec) String
func (x *SearchRequest_FacetSpec) String() stringSearchRequest_FacetSpec_FacetKey
type SearchRequest_FacetSpec_FacetKey struct {
// Required. Supported textual and numerical facet keys in
// [Document][google.cloud.discoveryengine.v1alpha.Document] object, over
// which the facet values are computed. Facet key is case-sensitive.
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// Set only if values should be bucketed into intervals. Must be set
// for facets with numerical values. Must not be set for facet with text
// values. Maximum number of intervals is 30.
Intervals []*Interval `protobuf:"bytes,2,rep,name=intervals,proto3" json:"intervals,omitempty"`
// Only get facet for the given restricted values. Only supported on
// textual fields. For example, suppose "category" has three values
// "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
// "restricted_values" to "Action > 2022", the "category" facet only
// contains "Action > 2022". Only supported on textual fields. Maximum
// is 10.
RestrictedValues []string `protobuf:"bytes,3,rep,name=restricted_values,json=restrictedValues,proto3" json:"restricted_values,omitempty"`
// Only get facet values that start with the given string prefix. For
// example, suppose "category" has three values "Action > 2022",
// "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
// "category" facet only contains "Action > 2022" and "Action > 2021".
// Only supported on textual fields. Maximum is 10.
Prefixes []string `protobuf:"bytes,4,rep,name=prefixes,proto3" json:"prefixes,omitempty"`
// Only get facet values that contain the given strings. For example,
// suppose "category" has three values "Action > 2022",
// "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
// "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
// Only supported on textual fields. Maximum is 10.
Contains []string `protobuf:"bytes,5,rep,name=contains,proto3" json:"contains,omitempty"`
// True to make facet keys case insensitive when getting faceting
// values with prefixes or contains; false otherwise.
CaseInsensitive bool `protobuf:"varint,6,opt,name=case_insensitive,json=caseInsensitive,proto3" json:"case_insensitive,omitempty"`
// The order in which documents are returned.
//
// Allowed values are:
//
// * "count desc", which means order by
// [SearchResponse.Facet.values.count][google.cloud.discoveryengine.v1alpha.SearchResponse.Facet.FacetValue.count]
// descending.
//
// * "value desc", which means order by
// [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1alpha.SearchResponse.Facet.FacetValue.value]
// descending.
//
// Only applies to textual facets.
//
// If not set, textual values are sorted in [natural
// order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
// intervals are sorted in the order given by
// [FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.intervals].
OrderBy string `protobuf:"bytes,7,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Specifies how a facet is computed.
func (*SearchRequest_FacetSpec_FacetKey) Descriptor
func (*SearchRequest_FacetSpec_FacetKey) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_FacetSpec_FacetKey.ProtoReflect.Descriptor instead.
func (*SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive
func (x *SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive() boolfunc (*SearchRequest_FacetSpec_FacetKey) GetContains
func (x *SearchRequest_FacetSpec_FacetKey) GetContains() []stringfunc (*SearchRequest_FacetSpec_FacetKey) GetIntervals
func (x *SearchRequest_FacetSpec_FacetKey) GetIntervals() []*Intervalfunc (*SearchRequest_FacetSpec_FacetKey) GetKey
func (x *SearchRequest_FacetSpec_FacetKey) GetKey() stringfunc (*SearchRequest_FacetSpec_FacetKey) GetOrderBy
func (x *SearchRequest_FacetSpec_FacetKey) GetOrderBy() stringfunc (*SearchRequest_FacetSpec_FacetKey) GetPrefixes
func (x *SearchRequest_FacetSpec_FacetKey) GetPrefixes() []stringfunc (*SearchRequest_FacetSpec_FacetKey) GetRestrictedValues
func (x *SearchRequest_FacetSpec_FacetKey) GetRestrictedValues() []stringfunc (*SearchRequest_FacetSpec_FacetKey) ProtoMessage
func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage()func (*SearchRequest_FacetSpec_FacetKey) ProtoReflect
func (x *SearchRequest_FacetSpec_FacetKey) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_FacetSpec_FacetKey) Reset
func (x *SearchRequest_FacetSpec_FacetKey) Reset()func (*SearchRequest_FacetSpec_FacetKey) String
func (x *SearchRequest_FacetSpec_FacetKey) String() stringSearchRequest_ImageQuery
type SearchRequest_ImageQuery struct {
// Types that are valid to be assigned to Image:
//
// *SearchRequest_ImageQuery_ImageBytes
Image isSearchRequest_ImageQuery_Image `protobuf_oneof:"image"`
// contains filtered or unexported fields
}Specifies the image query input.
func (*SearchRequest_ImageQuery) Descriptor
func (*SearchRequest_ImageQuery) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_ImageQuery.ProtoReflect.Descriptor instead.
func (*SearchRequest_ImageQuery) GetImage
func (x *SearchRequest_ImageQuery) GetImage() isSearchRequest_ImageQuery_Imagefunc (*SearchRequest_ImageQuery) GetImageBytes
func (x *SearchRequest_ImageQuery) GetImageBytes() stringfunc (*SearchRequest_ImageQuery) ProtoMessage
func (*SearchRequest_ImageQuery) ProtoMessage()func (*SearchRequest_ImageQuery) ProtoReflect
func (x *SearchRequest_ImageQuery) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_ImageQuery) Reset
func (x *SearchRequest_ImageQuery) Reset()func (*SearchRequest_ImageQuery) String
func (x *SearchRequest_ImageQuery) String() stringSearchRequest_ImageQuery_ImageBytes
type SearchRequest_ImageQuery_ImageBytes struct {
// Base64 encoded image bytes. Supported image formats: JPEG, PNG, and
// BMP.
ImageBytes string `protobuf:"bytes,1,opt,name=image_bytes,json=imageBytes,proto3,oneof"`
}SearchRequest_NaturalLanguageQueryUnderstandingSpec
type SearchRequest_NaturalLanguageQueryUnderstandingSpec struct {
// The condition under which filter extraction should occur.
// Default to [Condition.DISABLED][].
FilterExtractionCondition SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition `protobuf:"varint,1,opt,name=filter_extraction_condition,json=filterExtractionCondition,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition" json:"filter_extraction_condition,omitempty"`
// Field names used for location-based filtering, where geolocation filters
// are detected in natural language search queries.
// Only valid when the FilterExtractionCondition is set to `ENABLED`.
//
// If this field is set, it overrides the field names set in
// [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1alpha.ServingConfig.geo_search_query_detection_field_names].
GeoSearchQueryDetectionFieldNames []string `protobuf:"bytes,2,rep,name=geo_search_query_detection_field_names,json=geoSearchQueryDetectionFieldNames,proto3" json:"geo_search_query_detection_field_names,omitempty"`
// contains filtered or unexported fields
}Specification to enable natural language understanding capabilities for search requests.
func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) Descriptor
func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_NaturalLanguageQueryUnderstandingSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) GetFilterExtractionCondition
func (x *SearchRequest_NaturalLanguageQueryUnderstandingSpec) GetFilterExtractionCondition() SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionConditionfunc (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) GetGeoSearchQueryDetectionFieldNames
func (x *SearchRequest_NaturalLanguageQueryUnderstandingSpec) GetGeoSearchQueryDetectionFieldNames() []stringfunc (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) ProtoMessage
func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) ProtoMessage()func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) ProtoReflect
func (x *SearchRequest_NaturalLanguageQueryUnderstandingSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) Reset
func (x *SearchRequest_NaturalLanguageQueryUnderstandingSpec) Reset()func (*SearchRequest_NaturalLanguageQueryUnderstandingSpec) String
func (x *SearchRequest_NaturalLanguageQueryUnderstandingSpec) String() stringSearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition
type SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition int32Enum describing under which condition filter extraction should occur.
SearchRequest_NaturalLanguageQueryUnderstandingSpec_CONDITION_UNSPECIFIED, SearchRequest_NaturalLanguageQueryUnderstandingSpec_DISABLED, SearchRequest_NaturalLanguageQueryUnderstandingSpec_ENABLED
const (
// Server behavior defaults to [Condition.DISABLED][].
SearchRequest_NaturalLanguageQueryUnderstandingSpec_CONDITION_UNSPECIFIED SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition = 0
// Disables NL filter extraction.
SearchRequest_NaturalLanguageQueryUnderstandingSpec_DISABLED SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition = 1
// Enables NL filter extraction.
SearchRequest_NaturalLanguageQueryUnderstandingSpec_ENABLED SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition = 2
)func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Descriptor
func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Descriptor() protoreflect.EnumDescriptorfunc (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Enum
func (x SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Enum() *SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionConditionfunc (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) EnumDescriptor
func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition.Descriptor instead.
func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Number
func (x SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Number() protoreflect.EnumNumberfunc (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) String
func (x SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) String() stringfunc (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Type
func (SearchRequest_NaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition) Type() protoreflect.EnumTypeSearchRequest_QueryExpansionSpec
type SearchRequest_QueryExpansionSpec struct {
// The condition under which query expansion should occur. Default to
// [Condition.DISABLED][google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
Condition SearchRequest_QueryExpansionSpec_Condition `protobuf:"varint,1,opt,name=condition,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchRequest_QueryExpansionSpec_Condition" json:"condition,omitempty"`
// Whether to pin unexpanded results. If this field is set to true,
// unexpanded products are always at the top of the search results, followed
// by the expanded results.
PinUnexpandedResults bool `protobuf:"varint,2,opt,name=pin_unexpanded_results,json=pinUnexpandedResults,proto3" json:"pin_unexpanded_results,omitempty"`
// contains filtered or unexported fields
}Specification to determine under which conditions query expansion should occur.
func (*SearchRequest_QueryExpansionSpec) Descriptor
func (*SearchRequest_QueryExpansionSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_QueryExpansionSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_QueryExpansionSpec) GetCondition
func (x *SearchRequest_QueryExpansionSpec) GetCondition() SearchRequest_QueryExpansionSpec_Conditionfunc (*SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults
func (x *SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults() boolfunc (*SearchRequest_QueryExpansionSpec) ProtoMessage
func (*SearchRequest_QueryExpansionSpec) ProtoMessage()func (*SearchRequest_QueryExpansionSpec) ProtoReflect
func (x *SearchRequest_QueryExpansionSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_QueryExpansionSpec) Reset
func (x *SearchRequest_QueryExpansionSpec) Reset()func (*SearchRequest_QueryExpansionSpec) String
func (x *SearchRequest_QueryExpansionSpec) String() stringSearchRequest_QueryExpansionSpec_Condition
type SearchRequest_QueryExpansionSpec_Condition int32Enum describing under which condition query expansion should occur.
SearchRequest_QueryExpansionSpec_CONDITION_UNSPECIFIED, SearchRequest_QueryExpansionSpec_DISABLED, SearchRequest_QueryExpansionSpec_AUTO
const (
// Unspecified query expansion condition. In this case, server behavior
// defaults to
// [Condition.DISABLED][google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
SearchRequest_QueryExpansionSpec_CONDITION_UNSPECIFIED SearchRequest_QueryExpansionSpec_Condition = 0
// Disabled query expansion. Only the exact search query is used, even if
// [SearchResponse.total_size][google.cloud.discoveryengine.v1alpha.SearchResponse.total_size]
// is zero.
SearchRequest_QueryExpansionSpec_DISABLED SearchRequest_QueryExpansionSpec_Condition = 1
// Automatic query expansion built by the Search API.
SearchRequest_QueryExpansionSpec_AUTO SearchRequest_QueryExpansionSpec_Condition = 2
)func (SearchRequest_QueryExpansionSpec_Condition) Descriptor
func (SearchRequest_QueryExpansionSpec_Condition) Descriptor() protoreflect.EnumDescriptorfunc (SearchRequest_QueryExpansionSpec_Condition) Enum
func (x SearchRequest_QueryExpansionSpec_Condition) Enum() *SearchRequest_QueryExpansionSpec_Conditionfunc (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor
func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchRequest_QueryExpansionSpec_Condition.Descriptor instead.
func (SearchRequest_QueryExpansionSpec_Condition) Number
func (x SearchRequest_QueryExpansionSpec_Condition) Number() protoreflect.EnumNumberfunc (SearchRequest_QueryExpansionSpec_Condition) String
func (x SearchRequest_QueryExpansionSpec_Condition) String() stringfunc (SearchRequest_QueryExpansionSpec_Condition) Type
func (SearchRequest_QueryExpansionSpec_Condition) Type() protoreflect.EnumTypeSearchRequest_RankingExpressionBackend
type SearchRequest_RankingExpressionBackend int32The backend to use for the ranking expression evaluation.
SearchRequest_RANKING_EXPRESSION_BACKEND_UNSPECIFIED, SearchRequest_RANK_BY_EMBEDDING, SearchRequest_RANK_BY_FORMULA
const (
// Default option for unspecified/unknown values.
SearchRequest_RANKING_EXPRESSION_BACKEND_UNSPECIFIED SearchRequest_RankingExpressionBackend = 0
// Ranking by custom embedding model, the default way to evaluate the
// ranking expression.
SearchRequest_RANK_BY_EMBEDDING SearchRequest_RankingExpressionBackend = 3
// Ranking by custom formula.
SearchRequest_RANK_BY_FORMULA SearchRequest_RankingExpressionBackend = 4
)func (SearchRequest_RankingExpressionBackend) Descriptor
func (SearchRequest_RankingExpressionBackend) Descriptor() protoreflect.EnumDescriptorfunc (SearchRequest_RankingExpressionBackend) Enum
func (SearchRequest_RankingExpressionBackend) EnumDescriptor
func (SearchRequest_RankingExpressionBackend) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchRequest_RankingExpressionBackend.Descriptor instead.
func (SearchRequest_RankingExpressionBackend) Number
func (x SearchRequest_RankingExpressionBackend) Number() protoreflect.EnumNumberfunc (SearchRequest_RankingExpressionBackend) String
func (x SearchRequest_RankingExpressionBackend) String() stringfunc (SearchRequest_RankingExpressionBackend) Type
func (SearchRequest_RankingExpressionBackend) Type() protoreflect.EnumTypeSearchRequest_RelevanceThreshold
type SearchRequest_RelevanceThreshold int32The relevance threshold of the search results. The higher relevance threshold is, the higher relevant results are shown and the less number of results are returned.
SearchRequest_RELEVANCE_THRESHOLD_UNSPECIFIED, SearchRequest_LOWEST, SearchRequest_LOW, SearchRequest_MEDIUM, SearchRequest_HIGH
const (
// Default value. In this case, server behavior defaults to Google defined
// threshold.
SearchRequest_RELEVANCE_THRESHOLD_UNSPECIFIED SearchRequest_RelevanceThreshold = 0
// Lowest relevance threshold.
SearchRequest_LOWEST SearchRequest_RelevanceThreshold = 1
// Low relevance threshold.
SearchRequest_LOW SearchRequest_RelevanceThreshold = 2
// Medium relevance threshold.
SearchRequest_MEDIUM SearchRequest_RelevanceThreshold = 3
// High relevance threshold.
SearchRequest_HIGH SearchRequest_RelevanceThreshold = 4
)func (SearchRequest_RelevanceThreshold) Descriptor
func (SearchRequest_RelevanceThreshold) Descriptor() protoreflect.EnumDescriptorfunc (SearchRequest_RelevanceThreshold) Enum
func (x SearchRequest_RelevanceThreshold) Enum() *SearchRequest_RelevanceThresholdfunc (SearchRequest_RelevanceThreshold) EnumDescriptor
func (SearchRequest_RelevanceThreshold) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchRequest_RelevanceThreshold.Descriptor instead.
func (SearchRequest_RelevanceThreshold) Number
func (x SearchRequest_RelevanceThreshold) Number() protoreflect.EnumNumberfunc (SearchRequest_RelevanceThreshold) String
func (x SearchRequest_RelevanceThreshold) String() stringfunc (SearchRequest_RelevanceThreshold) Type
func (SearchRequest_RelevanceThreshold) Type() protoreflect.EnumTypeSearchRequest_SearchAsYouTypeSpec
type SearchRequest_SearchAsYouTypeSpec struct {
// The condition under which search as you type should occur.
// Default to
// [Condition.DISABLED][google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED].
Condition SearchRequest_SearchAsYouTypeSpec_Condition `protobuf:"varint,1,opt,name=condition,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchRequest_SearchAsYouTypeSpec_Condition" json:"condition,omitempty"`
// contains filtered or unexported fields
}Specification for search as you type in search requests.
func (*SearchRequest_SearchAsYouTypeSpec) Descriptor
func (*SearchRequest_SearchAsYouTypeSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_SearchAsYouTypeSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_SearchAsYouTypeSpec) GetCondition
func (x *SearchRequest_SearchAsYouTypeSpec) GetCondition() SearchRequest_SearchAsYouTypeSpec_Conditionfunc (*SearchRequest_SearchAsYouTypeSpec) ProtoMessage
func (*SearchRequest_SearchAsYouTypeSpec) ProtoMessage()func (*SearchRequest_SearchAsYouTypeSpec) ProtoReflect
func (x *SearchRequest_SearchAsYouTypeSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_SearchAsYouTypeSpec) Reset
func (x *SearchRequest_SearchAsYouTypeSpec) Reset()func (*SearchRequest_SearchAsYouTypeSpec) String
func (x *SearchRequest_SearchAsYouTypeSpec) String() stringSearchRequest_SearchAsYouTypeSpec_Condition
type SearchRequest_SearchAsYouTypeSpec_Condition int32Enum describing under which condition search as you type should occur.
SearchRequest_SearchAsYouTypeSpec_CONDITION_UNSPECIFIED, SearchRequest_SearchAsYouTypeSpec_DISABLED, SearchRequest_SearchAsYouTypeSpec_ENABLED, SearchRequest_SearchAsYouTypeSpec_AUTO
const (
// Server behavior defaults to
// [Condition.DISABLED][google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED].
SearchRequest_SearchAsYouTypeSpec_CONDITION_UNSPECIFIED SearchRequest_SearchAsYouTypeSpec_Condition = 0
// Disables Search As You Type.
SearchRequest_SearchAsYouTypeSpec_DISABLED SearchRequest_SearchAsYouTypeSpec_Condition = 1
// Enables Search As You Type.
SearchRequest_SearchAsYouTypeSpec_ENABLED SearchRequest_SearchAsYouTypeSpec_Condition = 2
// Automatic switching between search-as-you-type and standard search
// modes, ideal for single-API implementations (e.g., debouncing).
SearchRequest_SearchAsYouTypeSpec_AUTO SearchRequest_SearchAsYouTypeSpec_Condition = 3
)func (SearchRequest_SearchAsYouTypeSpec_Condition) Descriptor
func (SearchRequest_SearchAsYouTypeSpec_Condition) Descriptor() protoreflect.EnumDescriptorfunc (SearchRequest_SearchAsYouTypeSpec_Condition) Enum
func (x SearchRequest_SearchAsYouTypeSpec_Condition) Enum() *SearchRequest_SearchAsYouTypeSpec_Conditionfunc (SearchRequest_SearchAsYouTypeSpec_Condition) EnumDescriptor
func (SearchRequest_SearchAsYouTypeSpec_Condition) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchRequest_SearchAsYouTypeSpec_Condition.Descriptor instead.
func (SearchRequest_SearchAsYouTypeSpec_Condition) Number
func (x SearchRequest_SearchAsYouTypeSpec_Condition) Number() protoreflect.EnumNumberfunc (SearchRequest_SearchAsYouTypeSpec_Condition) String
func (x SearchRequest_SearchAsYouTypeSpec_Condition) String() stringfunc (SearchRequest_SearchAsYouTypeSpec_Condition) Type
func (SearchRequest_SearchAsYouTypeSpec_Condition) Type() protoreflect.EnumTypeSearchRequest_SessionSpec
type SearchRequest_SessionSpec struct {
// If set, the search result gets stored to the "turn" specified by this
// query ID.
//
// Example: Let's say the session looks like this:
//
// session {
// name: ".../sessions/xxx"
// turns {
// query { text: "What is foo?" query_id: ".../questions/yyy" }
// answer: "Foo is ..."
// }
// turns {
// query { text: "How about bar then?" query_id: ".../questions/zzz" }
// }
// }
//
// The user can call /search API with a request like this:
//
// session: ".../sessions/xxx"
// session_spec { query_id: ".../questions/zzz" }
//
// Then, the API stores the search result, associated with the last turn.
// The stored search result can be used by a subsequent /answer API call
// (with the session ID and the query ID specified). Also, it is possible
// to call /search and /answer in parallel with the same session ID & query
// ID.
QueryId string `protobuf:"bytes,1,opt,name=query_id,json=queryId,proto3" json:"query_id,omitempty"`
// The number of top search results to persist. The persisted search results
// can be used for the subsequent /answer api call.
//
// This field is simliar to the `summary_result_count` field in
// [SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count].
//
// At most 10 results for documents mode, or 50 for chunks mode.
SearchResultPersistenceCount *int32 `protobuf:"varint,2,opt,name=search_result_persistence_count,json=searchResultPersistenceCount,proto3,oneof" json:"search_result_persistence_count,omitempty"`
// contains filtered or unexported fields
}Session specification.
Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
func (*SearchRequest_SessionSpec) Descriptor
func (*SearchRequest_SessionSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_SessionSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_SessionSpec) GetQueryId
func (x *SearchRequest_SessionSpec) GetQueryId() stringfunc (*SearchRequest_SessionSpec) GetSearchResultPersistenceCount
func (x *SearchRequest_SessionSpec) GetSearchResultPersistenceCount() int32func (*SearchRequest_SessionSpec) ProtoMessage
func (*SearchRequest_SessionSpec) ProtoMessage()func (*SearchRequest_SessionSpec) ProtoReflect
func (x *SearchRequest_SessionSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_SessionSpec) Reset
func (x *SearchRequest_SessionSpec) Reset()func (*SearchRequest_SessionSpec) String
func (x *SearchRequest_SessionSpec) String() stringSearchRequest_SpellCorrectionSpec
type SearchRequest_SpellCorrectionSpec struct {
// The mode under which spell correction
// replaces the original search query. Defaults to
// [Mode.AUTO][google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
Mode SearchRequest_SpellCorrectionSpec_Mode `protobuf:"varint,1,opt,name=mode,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchRequest_SpellCorrectionSpec_Mode" json:"mode,omitempty"`
// contains filtered or unexported fields
}The specification for query spell correction.
func (*SearchRequest_SpellCorrectionSpec) Descriptor
func (*SearchRequest_SpellCorrectionSpec) Descriptor() ([]byte, []int)Deprecated: Use SearchRequest_SpellCorrectionSpec.ProtoReflect.Descriptor instead.
func (*SearchRequest_SpellCorrectionSpec) GetMode
func (x *SearchRequest_SpellCorrectionSpec) GetMode() SearchRequest_SpellCorrectionSpec_Modefunc (*SearchRequest_SpellCorrectionSpec) ProtoMessage
func (*SearchRequest_SpellCorrectionSpec) ProtoMessage()func (*SearchRequest_SpellCorrectionSpec) ProtoReflect
func (x *SearchRequest_SpellCorrectionSpec) ProtoReflect() protoreflect.Messagefunc (*SearchRequest_SpellCorrectionSpec) Reset
func (x *SearchRequest_SpellCorrectionSpec) Reset()func (*SearchRequest_SpellCorrectionSpec) String
func (x *SearchRequest_SpellCorrectionSpec) String() stringSearchRequest_SpellCorrectionSpec_Mode
type SearchRequest_SpellCorrectionSpec_Mode int32Enum describing under which mode spell correction should occur.
SearchRequest_SpellCorrectionSpec_MODE_UNSPECIFIED, SearchRequest_SpellCorrectionSpec_SUGGESTION_ONLY, SearchRequest_SpellCorrectionSpec_AUTO
const (
// Unspecified spell correction mode. In this case, server behavior
// defaults to
// [Mode.AUTO][google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
SearchRequest_SpellCorrectionSpec_MODE_UNSPECIFIED SearchRequest_SpellCorrectionSpec_Mode = 0
// Search API tries to find a spelling suggestion. If a suggestion is
// found, it is put in the
// [SearchResponse.corrected_query][google.cloud.discoveryengine.v1alpha.SearchResponse.corrected_query].
// The spelling suggestion won't be used as the search query.
SearchRequest_SpellCorrectionSpec_SUGGESTION_ONLY SearchRequest_SpellCorrectionSpec_Mode = 1
// Automatic spell correction built by the Search API. Search will
// be based on the corrected query if found.
SearchRequest_SpellCorrectionSpec_AUTO SearchRequest_SpellCorrectionSpec_Mode = 2
)func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor
func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor() protoreflect.EnumDescriptorfunc (SearchRequest_SpellCorrectionSpec_Mode) Enum
func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor
func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchRequest_SpellCorrectionSpec_Mode.Descriptor instead.
func (SearchRequest_SpellCorrectionSpec_Mode) Number
func (x SearchRequest_SpellCorrectionSpec_Mode) Number() protoreflect.EnumNumberfunc (SearchRequest_SpellCorrectionSpec_Mode) String
func (x SearchRequest_SpellCorrectionSpec_Mode) String() stringfunc (SearchRequest_SpellCorrectionSpec_Mode) Type
func (SearchRequest_SpellCorrectionSpec_Mode) Type() protoreflect.EnumTypeSearchResponse
type SearchResponse struct {
// A list of matched documents. The order represents the ranking.
Results []*SearchResponse_SearchResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
// Results of facets requested by user.
Facets []*SearchResponse_Facet `protobuf:"bytes,2,rep,name=facets,proto3" json:"facets,omitempty"`
// Guided search result.
GuidedSearchResult *SearchResponse_GuidedSearchResult `protobuf:"bytes,8,opt,name=guided_search_result,json=guidedSearchResult,proto3" json:"guided_search_result,omitempty"`
// The estimated total count of matched items irrespective of pagination. The
// count of
// [results][google.cloud.discoveryengine.v1alpha.SearchResponse.results]
// returned by pagination may be less than the
// [total_size][google.cloud.discoveryengine.v1alpha.SearchResponse.total_size]
// that matches.
TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// A unique search token. This should be included in the
// [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] logs resulting
// from this search, which enables accurate attribution of search model
// performance. This also helps to identify a request during the customer
// support scenarios.
AttributionToken string `protobuf:"bytes,4,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
// The URI of a customer-defined redirect page. If redirect action is
// triggered, no search is performed, and only
// [redirect_uri][google.cloud.discoveryengine.v1alpha.SearchResponse.redirect_uri]
// and
// [attribution_token][google.cloud.discoveryengine.v1alpha.SearchResponse.attribution_token]
// are set in the response.
RedirectUri string `protobuf:"bytes,12,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`
// A token that can be sent as
// [SearchRequest.page_token][google.cloud.discoveryengine.v1alpha.SearchRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,5,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Contains the spell corrected query, if found. If the spell correction type
// is AUTOMATIC, then the search results are based on corrected_query.
// Otherwise the original query is used for search.
CorrectedQuery string `protobuf:"bytes,7,opt,name=corrected_query,json=correctedQuery,proto3" json:"corrected_query,omitempty"`
// A summary as part of the search results.
// This field is only returned if
// [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.summary_spec]
// is set.
Summary *SearchResponse_Summary `protobuf:"bytes,9,opt,name=summary,proto3" json:"summary,omitempty"`
// Controls applied as part of the Control service.
AppliedControls []string `protobuf:"bytes,10,rep,name=applied_controls,json=appliedControls,proto3" json:"applied_controls,omitempty"`
GeoSearchDebugInfo []*SearchResponse_GeoSearchDebugInfo `protobuf:"bytes,16,rep,name=geo_search_debug_info,json=geoSearchDebugInfo,proto3" json:"geo_search_debug_info,omitempty"`
// Query expansion information for the returned results.
QueryExpansionInfo *SearchResponse_QueryExpansionInfo `protobuf:"bytes,14,opt,name=query_expansion_info,json=queryExpansionInfo,proto3" json:"query_expansion_info,omitempty"`
// Natural language query understanding information for the returned results.
NaturalLanguageQueryUnderstandingInfo *SearchResponse_NaturalLanguageQueryUnderstandingInfo `protobuf:"bytes,15,opt,name=natural_language_query_understanding_info,json=naturalLanguageQueryUnderstandingInfo,proto3" json:"natural_language_query_understanding_info,omitempty"`
// Session information.
//
// Only set if
// [SearchRequest.session][google.cloud.discoveryengine.v1alpha.SearchRequest.session]
// is provided. See its description for more details.
SessionInfo *SearchResponse_SessionInfo `protobuf:"bytes,19,opt,name=session_info,json=sessionInfo,proto3" json:"session_info,omitempty"`
// A list of One Box results. There can be multiple One Box results of
// different types.
OneBoxResults []*SearchResponse_OneBoxResult `protobuf:"bytes,20,rep,name=one_box_results,json=oneBoxResults,proto3" json:"one_box_results,omitempty"`
// contains filtered or unexported fields
}Response message for [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] method.
func (*SearchResponse) Descriptor
func (*SearchResponse) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.
func (*SearchResponse) GetAppliedControls
func (x *SearchResponse) GetAppliedControls() []stringfunc (*SearchResponse) GetAttributionToken
func (x *SearchResponse) GetAttributionToken() stringfunc (*SearchResponse) GetCorrectedQuery
func (x *SearchResponse) GetCorrectedQuery() stringfunc (*SearchResponse) GetFacets
func (x *SearchResponse) GetFacets() []*SearchResponse_Facetfunc (*SearchResponse) GetGeoSearchDebugInfo
func (x *SearchResponse) GetGeoSearchDebugInfo() []*SearchResponse_GeoSearchDebugInfofunc (*SearchResponse) GetGuidedSearchResult
func (x *SearchResponse) GetGuidedSearchResult() *SearchResponse_GuidedSearchResultfunc (*SearchResponse) GetNaturalLanguageQueryUnderstandingInfo
func (x *SearchResponse) GetNaturalLanguageQueryUnderstandingInfo() *SearchResponse_NaturalLanguageQueryUnderstandingInfofunc (*SearchResponse) GetNextPageToken
func (x *SearchResponse) GetNextPageToken() stringfunc (*SearchResponse) GetOneBoxResults
func (x *SearchResponse) GetOneBoxResults() []*SearchResponse_OneBoxResultfunc (*SearchResponse) GetQueryExpansionInfo
func (x *SearchResponse) GetQueryExpansionInfo() *SearchResponse_QueryExpansionInfofunc (*SearchResponse) GetRedirectUri
func (x *SearchResponse) GetRedirectUri() stringfunc (*SearchResponse) GetResults
func (x *SearchResponse) GetResults() []*SearchResponse_SearchResultfunc (*SearchResponse) GetSessionInfo
func (x *SearchResponse) GetSessionInfo() *SearchResponse_SessionInfofunc (*SearchResponse) GetSummary
func (x *SearchResponse) GetSummary() *SearchResponse_Summaryfunc (*SearchResponse) GetTotalSize
func (x *SearchResponse) GetTotalSize() int32func (*SearchResponse) ProtoMessage
func (*SearchResponse) ProtoMessage()func (*SearchResponse) ProtoReflect
func (x *SearchResponse) ProtoReflect() protoreflect.Messagefunc (*SearchResponse) Reset
func (x *SearchResponse) Reset()func (*SearchResponse) String
func (x *SearchResponse) String() stringSearchResponse_Facet
type SearchResponse_Facet struct {
// The key for this facet. For example, `"colors"` or `"price"`. It matches
// [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.key].
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// The facet values for this field.
Values []*SearchResponse_Facet_FacetValue `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
// Whether the facet is dynamically generated.
DynamicFacet bool `protobuf:"varint,3,opt,name=dynamic_facet,json=dynamicFacet,proto3" json:"dynamic_facet,omitempty"`
// contains filtered or unexported fields
}A facet result.
func (*SearchResponse_Facet) Descriptor
func (*SearchResponse_Facet) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_Facet.ProtoReflect.Descriptor instead.
func (*SearchResponse_Facet) GetDynamicFacet
func (x *SearchResponse_Facet) GetDynamicFacet() boolfunc (*SearchResponse_Facet) GetKey
func (x *SearchResponse_Facet) GetKey() stringfunc (*SearchResponse_Facet) GetValues
func (x *SearchResponse_Facet) GetValues() []*SearchResponse_Facet_FacetValuefunc (*SearchResponse_Facet) ProtoMessage
func (*SearchResponse_Facet) ProtoMessage()func (*SearchResponse_Facet) ProtoReflect
func (x *SearchResponse_Facet) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_Facet) Reset
func (x *SearchResponse_Facet) Reset()func (*SearchResponse_Facet) String
func (x *SearchResponse_Facet) String() stringSearchResponse_Facet_FacetValue
type SearchResponse_Facet_FacetValue struct {
// A facet value which contains values.
//
// Types that are valid to be assigned to FacetValue:
//
// *SearchResponse_Facet_FacetValue_Value
// *SearchResponse_Facet_FacetValue_Interval
FacetValue isSearchResponse_Facet_FacetValue_FacetValue `protobuf_oneof:"facet_value"`
// Number of items that have this facet value.
Count int64 `protobuf:"varint,3,opt,name=count,proto3" json:"count,omitempty"`
// contains filtered or unexported fields
}A facet value which contains value names and their count.
func (*SearchResponse_Facet_FacetValue) Descriptor
func (*SearchResponse_Facet_FacetValue) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_Facet_FacetValue.ProtoReflect.Descriptor instead.
func (*SearchResponse_Facet_FacetValue) GetCount
func (x *SearchResponse_Facet_FacetValue) GetCount() int64func (*SearchResponse_Facet_FacetValue) GetFacetValue
func (x *SearchResponse_Facet_FacetValue) GetFacetValue() isSearchResponse_Facet_FacetValue_FacetValuefunc (*SearchResponse_Facet_FacetValue) GetInterval
func (x *SearchResponse_Facet_FacetValue) GetInterval() *Intervalfunc (*SearchResponse_Facet_FacetValue) GetValue
func (x *SearchResponse_Facet_FacetValue) GetValue() stringfunc (*SearchResponse_Facet_FacetValue) ProtoMessage
func (*SearchResponse_Facet_FacetValue) ProtoMessage()func (*SearchResponse_Facet_FacetValue) ProtoReflect
func (x *SearchResponse_Facet_FacetValue) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_Facet_FacetValue) Reset
func (x *SearchResponse_Facet_FacetValue) Reset()func (*SearchResponse_Facet_FacetValue) String
func (x *SearchResponse_Facet_FacetValue) String() stringSearchResponse_Facet_FacetValue_Interval
type SearchResponse_Facet_FacetValue_Interval struct {
// Interval value for a facet, such as [10, 20) for facet "price". It
// matches
// [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.intervals].
Interval *Interval `protobuf:"bytes,2,opt,name=interval,proto3,oneof"`
}SearchResponse_Facet_FacetValue_Value
type SearchResponse_Facet_FacetValue_Value struct {
// Text value of a facet, such as "Black" for facet "colors".
Value string `protobuf:"bytes,1,opt,name=value,proto3,oneof"`
}SearchResponse_GeoSearchDebugInfo
type SearchResponse_GeoSearchDebugInfo struct {
// The address from which forward geocoding ingestion produced issues.
OriginalAddressQuery string `protobuf:"bytes,1,opt,name=original_address_query,json=originalAddressQuery,proto3" json:"original_address_query,omitempty"`
// The error produced.
ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// contains filtered or unexported fields
}Debug information specifically related to forward geocoding issues arising from Geolocation Search.
func (*SearchResponse_GeoSearchDebugInfo) Descriptor
func (*SearchResponse_GeoSearchDebugInfo) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_GeoSearchDebugInfo.ProtoReflect.Descriptor instead.
func (*SearchResponse_GeoSearchDebugInfo) GetErrorMessage
func (x *SearchResponse_GeoSearchDebugInfo) GetErrorMessage() stringfunc (*SearchResponse_GeoSearchDebugInfo) GetOriginalAddressQuery
func (x *SearchResponse_GeoSearchDebugInfo) GetOriginalAddressQuery() stringfunc (*SearchResponse_GeoSearchDebugInfo) ProtoMessage
func (*SearchResponse_GeoSearchDebugInfo) ProtoMessage()func (*SearchResponse_GeoSearchDebugInfo) ProtoReflect
func (x *SearchResponse_GeoSearchDebugInfo) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_GeoSearchDebugInfo) Reset
func (x *SearchResponse_GeoSearchDebugInfo) Reset()func (*SearchResponse_GeoSearchDebugInfo) String
func (x *SearchResponse_GeoSearchDebugInfo) String() stringSearchResponse_GuidedSearchResult
type SearchResponse_GuidedSearchResult struct {
// A list of ranked refinement attributes.
RefinementAttributes []*SearchResponse_GuidedSearchResult_RefinementAttribute `protobuf:"bytes,1,rep,name=refinement_attributes,json=refinementAttributes,proto3" json:"refinement_attributes,omitempty"`
// Suggested follow-up questions.
FollowUpQuestions []string `protobuf:"bytes,2,rep,name=follow_up_questions,json=followUpQuestions,proto3" json:"follow_up_questions,omitempty"`
// contains filtered or unexported fields
}Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.
func (*SearchResponse_GuidedSearchResult) Descriptor
func (*SearchResponse_GuidedSearchResult) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_GuidedSearchResult.ProtoReflect.Descriptor instead.
func (*SearchResponse_GuidedSearchResult) GetFollowUpQuestions
func (x *SearchResponse_GuidedSearchResult) GetFollowUpQuestions() []stringfunc (*SearchResponse_GuidedSearchResult) GetRefinementAttributes
func (x *SearchResponse_GuidedSearchResult) GetRefinementAttributes() []*SearchResponse_GuidedSearchResult_RefinementAttributefunc (*SearchResponse_GuidedSearchResult) ProtoMessage
func (*SearchResponse_GuidedSearchResult) ProtoMessage()func (*SearchResponse_GuidedSearchResult) ProtoReflect
func (x *SearchResponse_GuidedSearchResult) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_GuidedSearchResult) Reset
func (x *SearchResponse_GuidedSearchResult) Reset()func (*SearchResponse_GuidedSearchResult) String
func (x *SearchResponse_GuidedSearchResult) String() stringSearchResponse_GuidedSearchResult_RefinementAttribute
type SearchResponse_GuidedSearchResult_RefinementAttribute struct {
// Attribute key used to refine the results. For example, `"movie_type"`.
AttributeKey string `protobuf:"bytes,1,opt,name=attribute_key,json=attributeKey,proto3" json:"attribute_key,omitempty"`
// Attribute value used to refine the results. For example, `"drama"`.
AttributeValue string `protobuf:"bytes,2,opt,name=attribute_value,json=attributeValue,proto3" json:"attribute_value,omitempty"`
// contains filtered or unexported fields
}Useful attribute for search result refinements.
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Descriptor
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_GuidedSearchResult_RefinementAttribute.ProtoReflect.Descriptor instead.
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeKey
func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeKey() stringfunc (*SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeValue
func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) GetAttributeValue() stringfunc (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoMessage
func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoMessage()func (*SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoReflect
func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_GuidedSearchResult_RefinementAttribute) Reset
func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) Reset()func (*SearchResponse_GuidedSearchResult_RefinementAttribute) String
func (x *SearchResponse_GuidedSearchResult_RefinementAttribute) String() stringSearchResponse_NaturalLanguageQueryUnderstandingInfo
type SearchResponse_NaturalLanguageQueryUnderstandingInfo struct {
// The filters that were extracted from the input query.
ExtractedFilters string `protobuf:"bytes,1,opt,name=extracted_filters,json=extractedFilters,proto3" json:"extracted_filters,omitempty"`
// Rewritten input query minus the extracted filters.
RewrittenQuery string `protobuf:"bytes,2,opt,name=rewritten_query,json=rewrittenQuery,proto3" json:"rewritten_query,omitempty"`
// The filters that were extracted from the input query represented in a
// structured form.
StructuredExtractedFilter *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter `protobuf:"bytes,3,opt,name=structured_extracted_filter,json=structuredExtractedFilter,proto3" json:"structured_extracted_filter,omitempty"`
// contains filtered or unexported fields
}Information describing what natural language understanding was done on the input query.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) Descriptor
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo.ProtoReflect.Descriptor instead.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetExtractedFilters
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetExtractedFilters() stringfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetRewrittenQuery
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetRewrittenQuery() stringfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetStructuredExtractedFilter
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) GetStructuredExtractedFilter() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilterfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) ProtoMessage
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) ProtoMessage()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) ProtoReflect
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) Reset
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) Reset()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo) String
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo) String() stringSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter struct {
// The expression denoting the filter that was extracted from the input
// query in a structured form. It can be a simple expression denoting a
// single string, numerical or geolocation constraint or a compound
// expression which is a combination of multiple expressions connected
// using logical (OR and AND) operators.
Expression *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression `protobuf:"bytes,1,opt,name=expression,proto3" json:"expression,omitempty"`
// contains filtered or unexported fields
}The filters that were extracted from the input query represented in a structured form.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) Descriptor
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter.ProtoReflect.Descriptor instead.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) GetExpression
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) GetExpression() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expressionfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) ProtoMessage
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) ProtoMessage()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) ProtoReflect
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) Reset
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) String
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter) String() stringSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression struct {
// The expressions that were ANDed together.
Expressions []*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`
// contains filtered or unexported fields
}Logical And operator.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) Descriptor
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression.ProtoReflect.Descriptor instead.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) GetExpressions
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) GetExpressions() []*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expressionfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) ProtoMessage
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) ProtoMessage()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) ProtoReflect
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) Reset
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) Reset()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) String
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression) String() stringSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression struct {
// The expression type.
//
// Types that are valid to be assigned to Expr:
//
// *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_StringConstraint
// *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_NumberConstraint
// *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_GeolocationConstraint
// *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_AndExpr
// *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_OrExpr
Expr isSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_Expr `protobuf_oneof:"expr"`
// contains filtered or unexported fields
}The expression denoting the filter that was extracted from the input query.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) Descriptor
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression.ProtoReflect.Descriptor instead.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetAndExpr
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetAndExpr() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpressionfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetExpr
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetExpr() isSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_Exprfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetGeolocationConstraint
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetGeolocationConstraint() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraintfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetNumberConstraint
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetNumberConstraint() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraintfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetOrExpr
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetOrExpr() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpressionfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetStringConstraint
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) GetStringConstraint() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraintfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) ProtoMessage
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) ProtoMessage()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) ProtoReflect
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) Reset
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) Reset()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) String
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression) String() stringSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_AndExpr
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_AndExpr struct {
// Logical "And" compound operator connecting multiple expressions.
AndExpr *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_AndExpression `protobuf:"bytes,4,opt,name=and_expr,json=andExpr,proto3,oneof"`
}SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_GeolocationConstraint
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_GeolocationConstraint struct {
// Geolocation constraint expression.
GeolocationConstraint *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint `protobuf:"bytes,3,opt,name=geolocation_constraint,json=geolocationConstraint,proto3,oneof"`
}SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_NumberConstraint
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_NumberConstraint struct {
// Numerical constraint expression.
NumberConstraint *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint `protobuf:"bytes,2,opt,name=number_constraint,json=numberConstraint,proto3,oneof"`
}SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_OrExpr
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_OrExpr struct {
// Logical "Or" compound operator connecting multiple expressions.
OrExpr *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression `protobuf:"bytes,5,opt,name=or_expr,json=orExpr,proto3,oneof"`
}SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_StringConstraint
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression_StringConstraint struct {
// String constraint expression.
StringConstraint *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint `protobuf:"bytes,1,opt,name=string_constraint,json=stringConstraint,proto3,oneof"`
}SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint struct {
// The name of the geolocation field as defined in the schema.
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// The reference address that was inferred from the input query. The
// proximity of the reference address to the geolocation field will be
// used to filter the results.
Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
// The latitude of the geolocation inferred from the input query.
Latitude float64 `protobuf:"fixed64,4,opt,name=latitude,proto3" json:"latitude,omitempty"`
// The longitude of the geolocation inferred from the input query.
Longitude float64 `protobuf:"fixed64,5,opt,name=longitude,proto3" json:"longitude,omitempty"`
// The radius in meters around the address. The record is returned if
// the location of the geolocation field is within the radius.
RadiusInMeters float32 `protobuf:"fixed32,3,opt,name=radius_in_meters,json=radiusInMeters,proto3" json:"radius_in_meters,omitempty"`
// contains filtered or unexported fields
}Constraint of a geolocation field. Name of the geolocation field as defined in the schema.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) Descriptor
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint.ProtoReflect.Descriptor instead.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetAddress
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetAddress() stringfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetFieldName
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetFieldName() stringfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetLatitude
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetLatitude() float64func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetLongitude
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetLongitude() float64func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetRadiusInMeters
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) GetRadiusInMeters() float32func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) ProtoMessage
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) ProtoMessage()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) ProtoReflect
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) Reset
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) Reset()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) String
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_GeolocationConstraint) String() stringSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint struct {
// Name of the numerical field as defined in the schema.
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// The comparison operation performed between the field value and the
// value specified in the constraint.
Comparison SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison `protobuf:"varint,2,opt,name=comparison,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison" json:"comparison,omitempty"`
// The value specified in the numerical constraint.
Value float64 `protobuf:"fixed64,3,opt,name=value,proto3" json:"value,omitempty"`
// Identifies the keywords within the search query that match a filter.
QuerySegment string `protobuf:"bytes,4,opt,name=query_segment,json=querySegment,proto3" json:"query_segment,omitempty"`
// contains filtered or unexported fields
}Constraint expression of a number field. Example: price < 100.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) Descriptor
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint.ProtoReflect.Descriptor instead.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetComparison
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetComparison() SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparisonfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetFieldName
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetFieldName() stringfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetQuerySegment
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetQuerySegment() stringfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetValue
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) GetValue() float64func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) ProtoMessage
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) ProtoMessage()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) ProtoReflect
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) Reset
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) Reset()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) String
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint) String() stringSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison int32The comparison operation that was performed.
SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_COMPARISON_UNSPECIFIED, SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_EQUALS, SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_LESS_THAN_EQUALS, SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_LESS_THAN, SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_GREATER_THAN_EQUALS, SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_GREATER_THAN
const (
// Undefined comparison operator.
SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_COMPARISON_UNSPECIFIED SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 0
// Denotes equality `=` operator.
SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_EQUALS SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 1
// Denotes less than or equal to `<=` operator.="" searchresponse_naturallanguagequeryunderstandinginfo_structuredextractedfilter_numberconstraint_less_than_equals="">SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 2
// Denotes less than `<` operator.="" searchresponse_naturallanguagequeryunderstandinginfo_structuredextractedfilter_numberconstraint_less_than="">SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 3
// Denotes greater than or equal to `>=` operator.
SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_GREATER_THAN_EQUALS SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 4
// Denotes greater than `>` operator.
SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_GREATER_THAN SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison = 5
)func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Descriptor
func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Descriptor() protoreflect.EnumDescriptorfunc (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Enum
func (x SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Enum() *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparisonfunc (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) EnumDescriptor
func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison.Descriptor instead.
func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Number
func (x SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Number() protoreflect.EnumNumberfunc (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) String
func (x SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) String() stringfunc (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Type
func (SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_NumberConstraint_Comparison) Type() protoreflect.EnumTypeSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression struct {
// The expressions that were ORed together.
Expressions []*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expression `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`
// contains filtered or unexported fields
}Logical Or operator.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) Descriptor
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression.ProtoReflect.Descriptor instead.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) GetExpressions
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) GetExpressions() []*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_Expressionfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) ProtoMessage
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) ProtoMessage()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) ProtoReflect
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) Reset
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) Reset()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) String
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_OrExpression) String() stringSearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint
type SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint struct {
// Name of the string field as defined in the schema.
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// Values of the string field. The record will only be returned if the
// field value matches one of the values specified here.
Values []string `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
// Identifies the keywords within the search query that match a filter.
QuerySegment string `protobuf:"bytes,3,opt,name=query_segment,json=querySegment,proto3" json:"query_segment,omitempty"`
// contains filtered or unexported fields
}Constraint expression of a string field.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) Descriptor
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint.ProtoReflect.Descriptor instead.
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetFieldName
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetFieldName() stringfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetQuerySegment
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetQuerySegment() stringfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetValues
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) GetValues() []stringfunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) ProtoMessage
func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) ProtoMessage()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) ProtoReflect
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) Reset
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) Reset()func (*SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) String
func (x *SearchResponse_NaturalLanguageQueryUnderstandingInfo_StructuredExtractedFilter_StringConstraint) String() stringSearchResponse_OneBoxResult
type SearchResponse_OneBoxResult struct {
// The type of One Box result.
OneBoxType SearchResponse_OneBoxResult_OneBoxType `protobuf:"varint,1,opt,name=one_box_type,json=oneBoxType,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchResponse_OneBoxResult_OneBoxType" json:"one_box_type,omitempty"`
// The search results for this One Box.
SearchResults []*SearchResponse_SearchResult `protobuf:"bytes,2,rep,name=search_results,json=searchResults,proto3" json:"search_results,omitempty"`
// contains filtered or unexported fields
}OneBoxResult is a holder for all results of specific type that we want to display in UI differently.
func (*SearchResponse_OneBoxResult) Descriptor
func (*SearchResponse_OneBoxResult) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_OneBoxResult.ProtoReflect.Descriptor instead.
func (*SearchResponse_OneBoxResult) GetOneBoxType
func (x *SearchResponse_OneBoxResult) GetOneBoxType() SearchResponse_OneBoxResult_OneBoxTypefunc (*SearchResponse_OneBoxResult) GetSearchResults
func (x *SearchResponse_OneBoxResult) GetSearchResults() []*SearchResponse_SearchResultfunc (*SearchResponse_OneBoxResult) ProtoMessage
func (*SearchResponse_OneBoxResult) ProtoMessage()func (*SearchResponse_OneBoxResult) ProtoReflect
func (x *SearchResponse_OneBoxResult) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_OneBoxResult) Reset
func (x *SearchResponse_OneBoxResult) Reset()func (*SearchResponse_OneBoxResult) String
func (x *SearchResponse_OneBoxResult) String() stringSearchResponse_OneBoxResult_OneBoxType
type SearchResponse_OneBoxResult_OneBoxType int32The type of One Box result.
SearchResponse_OneBoxResult_ONE_BOX_TYPE_UNSPECIFIED, SearchResponse_OneBoxResult_PEOPLE, SearchResponse_OneBoxResult_ORGANIZATION, SearchResponse_OneBoxResult_SLACK
const (
// Default value. Should not be used.
SearchResponse_OneBoxResult_ONE_BOX_TYPE_UNSPECIFIED SearchResponse_OneBoxResult_OneBoxType = 0
// One Box result contains people results.
SearchResponse_OneBoxResult_PEOPLE SearchResponse_OneBoxResult_OneBoxType = 1
// One Box result contains organization results.
SearchResponse_OneBoxResult_ORGANIZATION SearchResponse_OneBoxResult_OneBoxType = 2
// One Box result contains slack results.
SearchResponse_OneBoxResult_SLACK SearchResponse_OneBoxResult_OneBoxType = 3
)func (SearchResponse_OneBoxResult_OneBoxType) Descriptor
func (SearchResponse_OneBoxResult_OneBoxType) Descriptor() protoreflect.EnumDescriptorfunc (SearchResponse_OneBoxResult_OneBoxType) Enum
func (SearchResponse_OneBoxResult_OneBoxType) EnumDescriptor
func (SearchResponse_OneBoxResult_OneBoxType) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchResponse_OneBoxResult_OneBoxType.Descriptor instead.
func (SearchResponse_OneBoxResult_OneBoxType) Number
func (x SearchResponse_OneBoxResult_OneBoxType) Number() protoreflect.EnumNumberfunc (SearchResponse_OneBoxResult_OneBoxType) String
func (x SearchResponse_OneBoxResult_OneBoxType) String() stringfunc (SearchResponse_OneBoxResult_OneBoxType) Type
func (SearchResponse_OneBoxResult_OneBoxType) Type() protoreflect.EnumTypeSearchResponse_QueryExpansionInfo
type SearchResponse_QueryExpansionInfo struct {
// Bool describing whether query expansion has occurred.
ExpandedQuery bool `protobuf:"varint,1,opt,name=expanded_query,json=expandedQuery,proto3" json:"expanded_query,omitempty"`
// Number of pinned results. This field will only be set when expansion
// happens and
// [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.pin_unexpanded_results]
// is set to true.
PinnedResultCount int64 `protobuf:"varint,2,opt,name=pinned_result_count,json=pinnedResultCount,proto3" json:"pinned_result_count,omitempty"`
// contains filtered or unexported fields
}Information describing query expansion including whether expansion has occurred.
func (*SearchResponse_QueryExpansionInfo) Descriptor
func (*SearchResponse_QueryExpansionInfo) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_QueryExpansionInfo.ProtoReflect.Descriptor instead.
func (*SearchResponse_QueryExpansionInfo) GetExpandedQuery
func (x *SearchResponse_QueryExpansionInfo) GetExpandedQuery() boolfunc (*SearchResponse_QueryExpansionInfo) GetPinnedResultCount
func (x *SearchResponse_QueryExpansionInfo) GetPinnedResultCount() int64func (*SearchResponse_QueryExpansionInfo) ProtoMessage
func (*SearchResponse_QueryExpansionInfo) ProtoMessage()func (*SearchResponse_QueryExpansionInfo) ProtoReflect
func (x *SearchResponse_QueryExpansionInfo) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_QueryExpansionInfo) Reset
func (x *SearchResponse_QueryExpansionInfo) Reset()func (*SearchResponse_QueryExpansionInfo) String
func (x *SearchResponse_QueryExpansionInfo) String() stringSearchResponse_SearchResult
type SearchResponse_SearchResult struct {
// [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] of the
// searched [Document][google.cloud.discoveryengine.v1alpha.Document].
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// The document data snippet in the search response. Only fields that are
// marked as `retrievable` are populated.
Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
// The chunk data in the search response if the
// [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode]
// is set to
// [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
Chunk *Chunk `protobuf:"bytes,18,opt,name=chunk,proto3" json:"chunk,omitempty"`
// Google provided available scores.
ModelScores map[string]*DoubleList `protobuf:"bytes,4,rep,name=model_scores,json=modelScores,proto3" json:"model_scores,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// A set of ranking signals associated with the result.
RankSignals *SearchResponse_SearchResult_RankSignals `protobuf:"bytes,7,opt,name=rank_signals,json=rankSignals,proto3" json:"rank_signals,omitempty"`
// contains filtered or unexported fields
}Represents the search results.
func (*SearchResponse_SearchResult) Descriptor
func (*SearchResponse_SearchResult) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_SearchResult.ProtoReflect.Descriptor instead.
func (*SearchResponse_SearchResult) GetChunk
func (x *SearchResponse_SearchResult) GetChunk() *Chunkfunc (*SearchResponse_SearchResult) GetDocument
func (x *SearchResponse_SearchResult) GetDocument() *Documentfunc (*SearchResponse_SearchResult) GetId
func (x *SearchResponse_SearchResult) GetId() stringfunc (*SearchResponse_SearchResult) GetModelScores
func (x *SearchResponse_SearchResult) GetModelScores() map[string]*DoubleListfunc (*SearchResponse_SearchResult) GetRankSignals
func (x *SearchResponse_SearchResult) GetRankSignals() *SearchResponse_SearchResult_RankSignalsfunc (*SearchResponse_SearchResult) ProtoMessage
func (*SearchResponse_SearchResult) ProtoMessage()func (*SearchResponse_SearchResult) ProtoReflect
func (x *SearchResponse_SearchResult) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_SearchResult) Reset
func (x *SearchResponse_SearchResult) Reset()func (*SearchResponse_SearchResult) String
func (x *SearchResponse_SearchResult) String() stringSearchResponse_SearchResult_RankSignals
type SearchResponse_SearchResult_RankSignals struct {
// Keyword matching adjustment.
KeywordSimilarityScore *float32 `protobuf:"fixed32,1,opt,name=keyword_similarity_score,json=keywordSimilarityScore,proto3,oneof" json:"keyword_similarity_score,omitempty"`
// Semantic relevance adjustment.
RelevanceScore *float32 `protobuf:"fixed32,2,opt,name=relevance_score,json=relevanceScore,proto3,oneof" json:"relevance_score,omitempty"`
// Semantic similarity adjustment.
SemanticSimilarityScore *float32 `protobuf:"fixed32,3,opt,name=semantic_similarity_score,json=semanticSimilarityScore,proto3,oneof" json:"semantic_similarity_score,omitempty"`
// Predicted conversion rate adjustment as a rank.
PctrRank *float32 `protobuf:"fixed32,4,opt,name=pctr_rank,json=pctrRank,proto3,oneof" json:"pctr_rank,omitempty"`
// Topicality adjustment as a rank.
TopicalityRank *float32 `protobuf:"fixed32,6,opt,name=topicality_rank,json=topicalityRank,proto3,oneof" json:"topicality_rank,omitempty"`
// Age of the document in hours.
DocumentAge *float32 `protobuf:"fixed32,7,opt,name=document_age,json=documentAge,proto3,oneof" json:"document_age,omitempty"`
// Combined custom boosts for a doc.
BoostingFactor *float32 `protobuf:"fixed32,8,opt,name=boosting_factor,json=boostingFactor,proto3,oneof" json:"boosting_factor,omitempty"`
// The default rank of the result.
DefaultRank float32 `protobuf:"fixed32,32,opt,name=default_rank,json=defaultRank,proto3" json:"default_rank,omitempty"`
// A list of custom clearbox signals.
CustomSignals []*SearchResponse_SearchResult_RankSignals_CustomSignal `protobuf:"bytes,33,rep,name=custom_signals,json=customSignals,proto3" json:"custom_signals,omitempty"`
// contains filtered or unexported fields
}A set of ranking signals.
func (*SearchResponse_SearchResult_RankSignals) Descriptor
func (*SearchResponse_SearchResult_RankSignals) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_SearchResult_RankSignals.ProtoReflect.Descriptor instead.
func (*SearchResponse_SearchResult_RankSignals) GetBoostingFactor
func (x *SearchResponse_SearchResult_RankSignals) GetBoostingFactor() float32func (*SearchResponse_SearchResult_RankSignals) GetCustomSignals
func (x *SearchResponse_SearchResult_RankSignals) GetCustomSignals() []*SearchResponse_SearchResult_RankSignals_CustomSignalfunc (*SearchResponse_SearchResult_RankSignals) GetDefaultRank
func (x *SearchResponse_SearchResult_RankSignals) GetDefaultRank() float32func (*SearchResponse_SearchResult_RankSignals) GetDocumentAge
func (x *SearchResponse_SearchResult_RankSignals) GetDocumentAge() float32func (*SearchResponse_SearchResult_RankSignals) GetKeywordSimilarityScore
func (x *SearchResponse_SearchResult_RankSignals) GetKeywordSimilarityScore() float32func (*SearchResponse_SearchResult_RankSignals) GetPctrRank
func (x *SearchResponse_SearchResult_RankSignals) GetPctrRank() float32func (*SearchResponse_SearchResult_RankSignals) GetRelevanceScore
func (x *SearchResponse_SearchResult_RankSignals) GetRelevanceScore() float32func (*SearchResponse_SearchResult_RankSignals) GetSemanticSimilarityScore
func (x *SearchResponse_SearchResult_RankSignals) GetSemanticSimilarityScore() float32func (*SearchResponse_SearchResult_RankSignals) GetTopicalityRank
func (x *SearchResponse_SearchResult_RankSignals) GetTopicalityRank() float32func (*SearchResponse_SearchResult_RankSignals) ProtoMessage
func (*SearchResponse_SearchResult_RankSignals) ProtoMessage()func (*SearchResponse_SearchResult_RankSignals) ProtoReflect
func (x *SearchResponse_SearchResult_RankSignals) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_SearchResult_RankSignals) Reset
func (x *SearchResponse_SearchResult_RankSignals) Reset()func (*SearchResponse_SearchResult_RankSignals) String
func (x *SearchResponse_SearchResult_RankSignals) String() stringSearchResponse_SearchResult_RankSignals_CustomSignal
type SearchResponse_SearchResult_RankSignals_CustomSignal struct {
// Name of the signal.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Float value representing the ranking signal (e.g. 1.25 for BM25).
Value float32 `protobuf:"fixed32,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}Custom clearbox signal represented by name and value pair.
func (*SearchResponse_SearchResult_RankSignals_CustomSignal) Descriptor
func (*SearchResponse_SearchResult_RankSignals_CustomSignal) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_SearchResult_RankSignals_CustomSignal.ProtoReflect.Descriptor instead.
func (*SearchResponse_SearchResult_RankSignals_CustomSignal) GetName
func (x *SearchResponse_SearchResult_RankSignals_CustomSignal) GetName() stringfunc (*SearchResponse_SearchResult_RankSignals_CustomSignal) GetValue
func (x *SearchResponse_SearchResult_RankSignals_CustomSignal) GetValue() float32func (*SearchResponse_SearchResult_RankSignals_CustomSignal) ProtoMessage
func (*SearchResponse_SearchResult_RankSignals_CustomSignal) ProtoMessage()func (*SearchResponse_SearchResult_RankSignals_CustomSignal) ProtoReflect
func (x *SearchResponse_SearchResult_RankSignals_CustomSignal) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_SearchResult_RankSignals_CustomSignal) Reset
func (x *SearchResponse_SearchResult_RankSignals_CustomSignal) Reset()func (*SearchResponse_SearchResult_RankSignals_CustomSignal) String
func (x *SearchResponse_SearchResult_RankSignals_CustomSignal) String() stringSearchResponse_SessionInfo
type SearchResponse_SessionInfo struct {
// Name of the session.
// If the auto-session mode is used (when
// [SearchRequest.session][google.cloud.discoveryengine.v1alpha.SearchRequest.session]
// ends with "-"), this field holds the newly generated session name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Query ID that corresponds to this search API call.
// One session can have multiple turns, each with a unique query ID.
//
// By specifying the session name and this query ID in the Answer API call,
// the answer generation happens in the context of the search results from
// this search call.
QueryId string `protobuf:"bytes,2,opt,name=query_id,json=queryId,proto3" json:"query_id,omitempty"`
// contains filtered or unexported fields
}Information about the session.
func (*SearchResponse_SessionInfo) Descriptor
func (*SearchResponse_SessionInfo) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_SessionInfo.ProtoReflect.Descriptor instead.
func (*SearchResponse_SessionInfo) GetName
func (x *SearchResponse_SessionInfo) GetName() stringfunc (*SearchResponse_SessionInfo) GetQueryId
func (x *SearchResponse_SessionInfo) GetQueryId() stringfunc (*SearchResponse_SessionInfo) ProtoMessage
func (*SearchResponse_SessionInfo) ProtoMessage()func (*SearchResponse_SessionInfo) ProtoReflect
func (x *SearchResponse_SessionInfo) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_SessionInfo) Reset
func (x *SearchResponse_SessionInfo) Reset()func (*SearchResponse_SessionInfo) String
func (x *SearchResponse_SessionInfo) String() stringSearchResponse_Summary
type SearchResponse_Summary struct {
// The summary content.
SummaryText string `protobuf:"bytes,1,opt,name=summary_text,json=summaryText,proto3" json:"summary_text,omitempty"`
// Additional summary-skipped reasons. This provides the reason for ignored
// cases. If nothing is skipped, this field is not set.
SummarySkippedReasons []SearchResponse_Summary_SummarySkippedReason `protobuf:"varint,2,rep,packed,name=summary_skipped_reasons,json=summarySkippedReasons,proto3,enum=google.cloud.discoveryengine.v1alpha.SearchResponse_Summary_SummarySkippedReason" json:"summary_skipped_reasons,omitempty"`
// A collection of Safety Attribute categories and their associated
// confidence scores.
SafetyAttributes *SearchResponse_Summary_SafetyAttributes `protobuf:"bytes,3,opt,name=safety_attributes,json=safetyAttributes,proto3" json:"safety_attributes,omitempty"`
// Summary with metadata information.
SummaryWithMetadata *SearchResponse_Summary_SummaryWithMetadata `protobuf:"bytes,4,opt,name=summary_with_metadata,json=summaryWithMetadata,proto3" json:"summary_with_metadata,omitempty"`
// contains filtered or unexported fields
}Summary of the top N search results specified by the summary spec.
func (*SearchResponse_Summary) Descriptor
func (*SearchResponse_Summary) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_Summary.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary) GetSafetyAttributes
func (x *SearchResponse_Summary) GetSafetyAttributes() *SearchResponse_Summary_SafetyAttributesfunc (*SearchResponse_Summary) GetSummarySkippedReasons
func (x *SearchResponse_Summary) GetSummarySkippedReasons() []SearchResponse_Summary_SummarySkippedReasonfunc (*SearchResponse_Summary) GetSummaryText
func (x *SearchResponse_Summary) GetSummaryText() stringfunc (*SearchResponse_Summary) GetSummaryWithMetadata
func (x *SearchResponse_Summary) GetSummaryWithMetadata() *SearchResponse_Summary_SummaryWithMetadatafunc (*SearchResponse_Summary) ProtoMessage
func (*SearchResponse_Summary) ProtoMessage()func (*SearchResponse_Summary) ProtoReflect
func (x *SearchResponse_Summary) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_Summary) Reset
func (x *SearchResponse_Summary) Reset()func (*SearchResponse_Summary) String
func (x *SearchResponse_Summary) String() stringSearchResponse_Summary_Citation
type SearchResponse_Summary_Citation struct {
// Index indicates the start of the segment, measured in bytes/unicode.
StartIndex int64 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
// End of the attributed segment, exclusive.
EndIndex int64 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
// Citation sources for the attributed segment.
Sources []*SearchResponse_Summary_CitationSource `protobuf:"bytes,3,rep,name=sources,proto3" json:"sources,omitempty"`
// contains filtered or unexported fields
}Citation info for a segment.
func (*SearchResponse_Summary_Citation) Descriptor
func (*SearchResponse_Summary_Citation) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_Summary_Citation.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_Citation) GetEndIndex
func (x *SearchResponse_Summary_Citation) GetEndIndex() int64func (*SearchResponse_Summary_Citation) GetSources
func (x *SearchResponse_Summary_Citation) GetSources() []*SearchResponse_Summary_CitationSourcefunc (*SearchResponse_Summary_Citation) GetStartIndex
func (x *SearchResponse_Summary_Citation) GetStartIndex() int64func (*SearchResponse_Summary_Citation) ProtoMessage
func (*SearchResponse_Summary_Citation) ProtoMessage()func (*SearchResponse_Summary_Citation) ProtoReflect
func (x *SearchResponse_Summary_Citation) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_Summary_Citation) Reset
func (x *SearchResponse_Summary_Citation) Reset()func (*SearchResponse_Summary_Citation) String
func (x *SearchResponse_Summary_Citation) String() stringSearchResponse_Summary_CitationMetadata
type SearchResponse_Summary_CitationMetadata struct {
// Citations for segments.
Citations []*SearchResponse_Summary_Citation `protobuf:"bytes,1,rep,name=citations,proto3" json:"citations,omitempty"`
// contains filtered or unexported fields
}Citation metadata.
func (*SearchResponse_Summary_CitationMetadata) Descriptor
func (*SearchResponse_Summary_CitationMetadata) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_Summary_CitationMetadata.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_CitationMetadata) GetCitations
func (x *SearchResponse_Summary_CitationMetadata) GetCitations() []*SearchResponse_Summary_Citationfunc (*SearchResponse_Summary_CitationMetadata) ProtoMessage
func (*SearchResponse_Summary_CitationMetadata) ProtoMessage()func (*SearchResponse_Summary_CitationMetadata) ProtoReflect
func (x *SearchResponse_Summary_CitationMetadata) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_Summary_CitationMetadata) Reset
func (x *SearchResponse_Summary_CitationMetadata) Reset()func (*SearchResponse_Summary_CitationMetadata) String
func (x *SearchResponse_Summary_CitationMetadata) String() stringSearchResponse_Summary_CitationSource
type SearchResponse_Summary_CitationSource struct {
// Document reference index from SummaryWithMetadata.references.
// It is 0-indexed and the value will be zero if the reference_index is
// not set explicitly.
ReferenceIndex int64 `protobuf:"varint,4,opt,name=reference_index,json=referenceIndex,proto3" json:"reference_index,omitempty"`
// contains filtered or unexported fields
}Citation source.
func (*SearchResponse_Summary_CitationSource) Descriptor
func (*SearchResponse_Summary_CitationSource) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_Summary_CitationSource.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_CitationSource) GetReferenceIndex
func (x *SearchResponse_Summary_CitationSource) GetReferenceIndex() int64func (*SearchResponse_Summary_CitationSource) ProtoMessage
func (*SearchResponse_Summary_CitationSource) ProtoMessage()func (*SearchResponse_Summary_CitationSource) ProtoReflect
func (x *SearchResponse_Summary_CitationSource) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_Summary_CitationSource) Reset
func (x *SearchResponse_Summary_CitationSource) Reset()func (*SearchResponse_Summary_CitationSource) String
func (x *SearchResponse_Summary_CitationSource) String() stringSearchResponse_Summary_Reference
type SearchResponse_Summary_Reference struct {
// Title of the document.
Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
// Required.
// [Document.name][google.cloud.discoveryengine.v1alpha.Document.name] of
// the document. Full resource name of the referenced document, in the
// format
// `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
Document string `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
// Cloud Storage or HTTP uri for the document.
Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
// List of cited chunk contents derived from document content.
ChunkContents []*SearchResponse_Summary_Reference_ChunkContent `protobuf:"bytes,4,rep,name=chunk_contents,json=chunkContents,proto3" json:"chunk_contents,omitempty"`
// contains filtered or unexported fields
}Document reference.
func (*SearchResponse_Summary_Reference) Descriptor
func (*SearchResponse_Summary_Reference) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_Summary_Reference.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_Reference) GetChunkContents
func (x *SearchResponse_Summary_Reference) GetChunkContents() []*SearchResponse_Summary_Reference_ChunkContentfunc (*SearchResponse_Summary_Reference) GetDocument
func (x *SearchResponse_Summary_Reference) GetDocument() stringfunc (*SearchResponse_Summary_Reference) GetTitle
func (x *SearchResponse_Summary_Reference) GetTitle() stringfunc (*SearchResponse_Summary_Reference) GetUri
func (x *SearchResponse_Summary_Reference) GetUri() stringfunc (*SearchResponse_Summary_Reference) ProtoMessage
func (*SearchResponse_Summary_Reference) ProtoMessage()func (*SearchResponse_Summary_Reference) ProtoReflect
func (x *SearchResponse_Summary_Reference) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_Summary_Reference) Reset
func (x *SearchResponse_Summary_Reference) Reset()func (*SearchResponse_Summary_Reference) String
func (x *SearchResponse_Summary_Reference) String() stringSearchResponse_Summary_Reference_ChunkContent
type SearchResponse_Summary_Reference_ChunkContent struct {
// Chunk textual content.
Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// Page identifier.
PageIdentifier string `protobuf:"bytes,2,opt,name=page_identifier,json=pageIdentifier,proto3" json:"page_identifier,omitempty"`
// contains filtered or unexported fields
}Chunk content.
func (*SearchResponse_Summary_Reference_ChunkContent) Descriptor
func (*SearchResponse_Summary_Reference_ChunkContent) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_Summary_Reference_ChunkContent.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_Reference_ChunkContent) GetContent
func (x *SearchResponse_Summary_Reference_ChunkContent) GetContent() stringfunc (*SearchResponse_Summary_Reference_ChunkContent) GetPageIdentifier
func (x *SearchResponse_Summary_Reference_ChunkContent) GetPageIdentifier() stringfunc (*SearchResponse_Summary_Reference_ChunkContent) ProtoMessage
func (*SearchResponse_Summary_Reference_ChunkContent) ProtoMessage()func (*SearchResponse_Summary_Reference_ChunkContent) ProtoReflect
func (x *SearchResponse_Summary_Reference_ChunkContent) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_Summary_Reference_ChunkContent) Reset
func (x *SearchResponse_Summary_Reference_ChunkContent) Reset()func (*SearchResponse_Summary_Reference_ChunkContent) String
func (x *SearchResponse_Summary_Reference_ChunkContent) String() stringSearchResponse_Summary_SafetyAttributes
type SearchResponse_Summary_SafetyAttributes struct {
// The display names of Safety Attribute categories associated with the
// generated content. Order matches the Scores.
Categories []string `protobuf:"bytes,1,rep,name=categories,proto3" json:"categories,omitempty"`
// The confidence scores of the each category, higher
// value means higher confidence. Order matches the Categories.
Scores []float32 `protobuf:"fixed32,2,rep,packed,name=scores,proto3" json:"scores,omitempty"`
// contains filtered or unexported fields
}Safety Attribute categories and their associated confidence scores.
func (*SearchResponse_Summary_SafetyAttributes) Descriptor
func (*SearchResponse_Summary_SafetyAttributes) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_Summary_SafetyAttributes.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_SafetyAttributes) GetCategories
func (x *SearchResponse_Summary_SafetyAttributes) GetCategories() []stringfunc (*SearchResponse_Summary_SafetyAttributes) GetScores
func (x *SearchResponse_Summary_SafetyAttributes) GetScores() []float32func (*SearchResponse_Summary_SafetyAttributes) ProtoMessage
func (*SearchResponse_Summary_SafetyAttributes) ProtoMessage()func (*SearchResponse_Summary_SafetyAttributes) ProtoReflect
func (x *SearchResponse_Summary_SafetyAttributes) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_Summary_SafetyAttributes) Reset
func (x *SearchResponse_Summary_SafetyAttributes) Reset()func (*SearchResponse_Summary_SafetyAttributes) String
func (x *SearchResponse_Summary_SafetyAttributes) String() stringSearchResponse_Summary_SummarySkippedReason
type SearchResponse_Summary_SummarySkippedReason int32An Enum for summary-skipped reasons.
SearchResponse_Summary_SUMMARY_SKIPPED_REASON_UNSPECIFIED, SearchResponse_Summary_ADVERSARIAL_QUERY_IGNORED, SearchResponse_Summary_NON_SUMMARY_SEEKING_QUERY_IGNORED, SearchResponse_Summary_OUT_OF_DOMAIN_QUERY_IGNORED, SearchResponse_Summary_POTENTIAL_POLICY_VIOLATION, SearchResponse_Summary_LLM_ADDON_NOT_ENABLED, SearchResponse_Summary_NO_RELEVANT_CONTENT, SearchResponse_Summary_JAIL_BREAKING_QUERY_IGNORED, SearchResponse_Summary_CUSTOMER_POLICY_VIOLATION, SearchResponse_Summary_NON_SUMMARY_SEEKING_QUERY_IGNORED_V2
const (
// Default value. The summary skipped reason is not specified.
SearchResponse_Summary_SUMMARY_SKIPPED_REASON_UNSPECIFIED SearchResponse_Summary_SummarySkippedReason = 0
// The adversarial query ignored case.
//
// Only used when
// [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query]
// is set to `true`.
SearchResponse_Summary_ADVERSARIAL_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 1
// The non-summary seeking query ignored case.
//
// Only used when
// [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query]
// is set to `true`.
SearchResponse_Summary_NON_SUMMARY_SEEKING_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 2
// The out-of-domain query ignored case.
//
// Google skips the summary if there are no high-relevance search results.
// For example, the data store contains facts about company A but the
// user query is asking questions about company B.
SearchResponse_Summary_OUT_OF_DOMAIN_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 3
// The potential policy violation case.
//
// Google skips the summary if there is a potential policy violation
// detected. This includes content that may be violent or toxic.
SearchResponse_Summary_POTENTIAL_POLICY_VIOLATION SearchResponse_Summary_SummarySkippedReason = 4
// The LLM addon not enabled case.
//
// Google skips the summary if the LLM addon is not enabled.
SearchResponse_Summary_LLM_ADDON_NOT_ENABLED SearchResponse_Summary_SummarySkippedReason = 5
// The no relevant content case.
//
// Google skips the summary if there is no relevant content in the
// retrieved search results.
SearchResponse_Summary_NO_RELEVANT_CONTENT SearchResponse_Summary_SummarySkippedReason = 6
// The jail-breaking query ignored case.
//
// For example, "Reply in the tone of a competing company's CEO".
// Only used when
// [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
// is set to `true`.
SearchResponse_Summary_JAIL_BREAKING_QUERY_IGNORED SearchResponse_Summary_SummarySkippedReason = 7
// The customer policy violation case.
//
// Google skips the summary if there is a customer policy violation
// detected. The policy is defined by the customer.
SearchResponse_Summary_CUSTOMER_POLICY_VIOLATION SearchResponse_Summary_SummarySkippedReason = 8
// The non-answer seeking query ignored case.
//
// Only used when
// [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
// is set to `true`.
SearchResponse_Summary_NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 SearchResponse_Summary_SummarySkippedReason = 9
)func (SearchResponse_Summary_SummarySkippedReason) Descriptor
func (SearchResponse_Summary_SummarySkippedReason) Descriptor() protoreflect.EnumDescriptorfunc (SearchResponse_Summary_SummarySkippedReason) Enum
func (x SearchResponse_Summary_SummarySkippedReason) Enum() *SearchResponse_Summary_SummarySkippedReasonfunc (SearchResponse_Summary_SummarySkippedReason) EnumDescriptor
func (SearchResponse_Summary_SummarySkippedReason) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchResponse_Summary_SummarySkippedReason.Descriptor instead.
func (SearchResponse_Summary_SummarySkippedReason) Number
func (x SearchResponse_Summary_SummarySkippedReason) Number() protoreflect.EnumNumberfunc (SearchResponse_Summary_SummarySkippedReason) String
func (x SearchResponse_Summary_SummarySkippedReason) String() stringfunc (SearchResponse_Summary_SummarySkippedReason) Type
func (SearchResponse_Summary_SummarySkippedReason) Type() protoreflect.EnumTypeSearchResponse_Summary_SummaryWithMetadata
type SearchResponse_Summary_SummaryWithMetadata struct {
// Summary text with no citation information.
Summary string `protobuf:"bytes,1,opt,name=summary,proto3" json:"summary,omitempty"`
// Citation metadata for given summary.
CitationMetadata *SearchResponse_Summary_CitationMetadata `protobuf:"bytes,2,opt,name=citation_metadata,json=citationMetadata,proto3" json:"citation_metadata,omitempty"`
// Document References.
References []*SearchResponse_Summary_Reference `protobuf:"bytes,3,rep,name=references,proto3" json:"references,omitempty"`
// contains filtered or unexported fields
}Summary with metadata information.
func (*SearchResponse_Summary_SummaryWithMetadata) Descriptor
func (*SearchResponse_Summary_SummaryWithMetadata) Descriptor() ([]byte, []int)Deprecated: Use SearchResponse_Summary_SummaryWithMetadata.ProtoReflect.Descriptor instead.
func (*SearchResponse_Summary_SummaryWithMetadata) GetCitationMetadata
func (x *SearchResponse_Summary_SummaryWithMetadata) GetCitationMetadata() *SearchResponse_Summary_CitationMetadatafunc (*SearchResponse_Summary_SummaryWithMetadata) GetReferences
func (x *SearchResponse_Summary_SummaryWithMetadata) GetReferences() []*SearchResponse_Summary_Referencefunc (*SearchResponse_Summary_SummaryWithMetadata) GetSummary
func (x *SearchResponse_Summary_SummaryWithMetadata) GetSummary() stringfunc (*SearchResponse_Summary_SummaryWithMetadata) ProtoMessage
func (*SearchResponse_Summary_SummaryWithMetadata) ProtoMessage()func (*SearchResponse_Summary_SummaryWithMetadata) ProtoReflect
func (x *SearchResponse_Summary_SummaryWithMetadata) ProtoReflect() protoreflect.Messagefunc (*SearchResponse_Summary_SummaryWithMetadata) Reset
func (x *SearchResponse_Summary_SummaryWithMetadata) Reset()func (*SearchResponse_Summary_SummaryWithMetadata) String
func (x *SearchResponse_Summary_SummaryWithMetadata) String() stringSearchServiceClient
type SearchServiceClient interface {
// Performs a search.
Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchResponse, error)
}SearchServiceClient is the client API for SearchService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewSearchServiceClient
func NewSearchServiceClient(cc grpc.ClientConnInterface) SearchServiceClientSearchServiceServer
type SearchServiceServer interface {
// Performs a search.
Search(context.Context, *SearchRequest) (*SearchResponse, error)
}SearchServiceServer is the server API for SearchService service. All implementations should embed UnimplementedSearchServiceServer for forward compatibility
SearchTier
type SearchTier int32Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.
SearchTier_SEARCH_TIER_UNSPECIFIED, SearchTier_SEARCH_TIER_STANDARD, SearchTier_SEARCH_TIER_ENTERPRISE
const (
// Default value when the enum is unspecified. This is invalid to use.
SearchTier_SEARCH_TIER_UNSPECIFIED SearchTier = 0
// Standard tier.
SearchTier_SEARCH_TIER_STANDARD SearchTier = 1
// Enterprise tier.
SearchTier_SEARCH_TIER_ENTERPRISE SearchTier = 2
)func (SearchTier) Descriptor
func (SearchTier) Descriptor() protoreflect.EnumDescriptorfunc (SearchTier) Enum
func (x SearchTier) Enum() *SearchTierfunc (SearchTier) EnumDescriptor
func (SearchTier) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchTier.Descriptor instead.
func (SearchTier) Number
func (x SearchTier) Number() protoreflect.EnumNumberfunc (SearchTier) String
func (x SearchTier) String() stringfunc (SearchTier) Type
func (SearchTier) Type() protoreflect.EnumTypeSearchTuningServiceClient
type SearchTuningServiceClient interface {
// Trains a custom model.
TrainCustomModel(ctx context.Context, in *TrainCustomModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets a list of all the custom models.
ListCustomModels(ctx context.Context, in *ListCustomModelsRequest, opts ...grpc.CallOption) (*ListCustomModelsResponse, error)
}SearchTuningServiceClient is the client API for SearchTuningService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewSearchTuningServiceClient
func NewSearchTuningServiceClient(cc grpc.ClientConnInterface) SearchTuningServiceClientSearchTuningServiceServer
type SearchTuningServiceServer interface {
// Trains a custom model.
TrainCustomModel(context.Context, *TrainCustomModelRequest) (*longrunningpb.Operation, error)
// Gets a list of all the custom models.
ListCustomModels(context.Context, *ListCustomModelsRequest) (*ListCustomModelsResponse, error)
}SearchTuningServiceServer is the server API for SearchTuningService service. All implementations should embed UnimplementedSearchTuningServiceServer for forward compatibility
SearchUseCase
type SearchUseCase int32Defines a further subdivision of SolutionType.
Specifically applies to
[SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
SearchUseCase_SEARCH_USE_CASE_UNSPECIFIED, SearchUseCase_SEARCH_USE_CASE_SEARCH, SearchUseCase_SEARCH_USE_CASE_BROWSE
const (
// Value used when unset. Will not occur in CSS.
SearchUseCase_SEARCH_USE_CASE_UNSPECIFIED SearchUseCase = 0
// Search use case. Expects the traffic has a non-empty
// [query][google.cloud.discoveryengine.v1alpha.SearchRequest.query].
SearchUseCase_SEARCH_USE_CASE_SEARCH SearchUseCase = 1
// Browse use case. Expects the traffic has an empty
// [query][google.cloud.discoveryengine.v1alpha.SearchRequest.query].
SearchUseCase_SEARCH_USE_CASE_BROWSE SearchUseCase = 2
)func (SearchUseCase) Descriptor
func (SearchUseCase) Descriptor() protoreflect.EnumDescriptorfunc (SearchUseCase) Enum
func (x SearchUseCase) Enum() *SearchUseCasefunc (SearchUseCase) EnumDescriptor
func (SearchUseCase) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchUseCase.Descriptor instead.
func (SearchUseCase) Number
func (x SearchUseCase) Number() protoreflect.EnumNumberfunc (SearchUseCase) String
func (x SearchUseCase) String() stringfunc (SearchUseCase) Type
func (SearchUseCase) Type() protoreflect.EnumTypeServingConfig
type ServingConfig struct {
// Industry vertical specific config.
//
// Types that are valid to be assigned to VerticalConfig:
//
// *ServingConfig_MediaConfig_
// *ServingConfig_GenericConfig_
VerticalConfig isServingConfig_VerticalConfig `protobuf_oneof:"vertical_config"`
// Immutable. Fully qualified name
// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The human readable serving config display name. Used in Discovery
// UI.
//
// This field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an INVALID_ARGUMENT error is returned.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Required. Immutable. Specifies the solution type that a serving config can
// be associated with.
SolutionType SolutionType `protobuf:"varint,3,opt,name=solution_type,json=solutionType,proto3,enum=google.cloud.discoveryengine.v1alpha.SolutionType" json:"solution_type,omitempty"`
// The id of the model to use at serving time.
// Currently only RecommendationModels are supported.
// Can be changed but only to a compatible model (e.g.
// others-you-may-like CTR to others-you-may-like CVR).
//
// Required when
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
ModelId string `protobuf:"bytes,4,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
// How much diversity to use in recommendation model results e.g.
// `medium-diversity` or `high-diversity`. Currently supported values:
//
// * `no-diversity`
// * `low-diversity`
// * `medium-diversity`
// * `high-diversity`
// * `auto-diversity`
//
// If not specified, we choose default based on recommendation model
// type. Default value: `no-diversity`.
//
// Can only be set if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
DiversityLevel string `protobuf:"bytes,5,opt,name=diversity_level,json=diversityLevel,proto3" json:"diversity_level,omitempty"`
// Bring your own embedding config. The config is used for search semantic
// retrieval. The retrieval is based on the dot product of
// [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
// and the document embeddings that are provided by this EmbeddingConfig. If
// [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
// is provided, it overrides this
// [ServingConfig.embedding_config][google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config].
EmbeddingConfig *EmbeddingConfig `protobuf:"bytes,20,opt,name=embedding_config,json=embeddingConfig,proto3" json:"embedding_config,omitempty"`
// The ranking expression controls the customized ranking on retrieval
// documents. To leverage this, document embedding is required. The ranking
// expression setting in ServingConfig applies to all search requests served
// by the serving config. However, if
// [SearchRequest.ranking_expression][google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression]
// is specified, it overrides the ServingConfig ranking expression.
//
// The ranking expression is a single function or multiple functions that are
// joined by "+".
//
// - ranking_expression = function, { " + ", function };
//
// Supported functions:
//
// - double * relevance_score
// - double * dotProduct(embedding_field_path)
//
// Function variables:
//
// - `relevance_score`: pre-defined keywords, used for measure relevance
// between query and document.
//
// - `embedding_field_path`: the document embedding field
// used with query embedding vector.
//
// - `dotProduct`: embedding function between embedding_field_path and query
// embedding vector.
//
// Example ranking expression:
//
// If document has an embedding field doc_embedding, the ranking expression
// could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
RankingExpression string `protobuf:"bytes,21,opt,name=ranking_expression,json=rankingExpression,proto3" json:"ranking_expression,omitempty"`
// Guided search configs.
GuidedSearchSpec *GuidedSearchSpec `protobuf:"bytes,22,opt,name=guided_search_spec,json=guidedSearchSpec,proto3" json:"guided_search_spec,omitempty"`
// Custom fine tuning configs.
// If
// [SearchRequest.custom_fine_tuning_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.custom_fine_tuning_spec]
// is set, it has higher priority than the configs set here.
CustomFineTuningSpec *CustomFineTuningSpec `protobuf:"bytes,24,opt,name=custom_fine_tuning_spec,json=customFineTuningSpec,proto3" json:"custom_fine_tuning_spec,omitempty"`
// Output only. ServingConfig created timestamp.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. ServingConfig updated timestamp.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Filter controls to use in serving path.
// All triggered filter controls will be applied.
// Filter controls must be in the same data store as the serving config.
// Maximum of 20 filter controls.
FilterControlIds []string `protobuf:"bytes,11,rep,name=filter_control_ids,json=filterControlIds,proto3" json:"filter_control_ids,omitempty"`
// Boost controls to use in serving path.
// All triggered boost controls will be applied.
// Boost controls must be in the same data store as the serving config.
// Maximum of 20 boost controls.
BoostControlIds []string `protobuf:"bytes,12,rep,name=boost_control_ids,json=boostControlIds,proto3" json:"boost_control_ids,omitempty"`
// IDs of the redirect controls. Only the first triggered redirect
// action is applied, even if multiple apply. Maximum number of
// specifications is 100.
//
// Can only be set if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
RedirectControlIds []string `protobuf:"bytes,14,rep,name=redirect_control_ids,json=redirectControlIds,proto3" json:"redirect_control_ids,omitempty"`
// Condition synonyms specifications. If multiple synonyms conditions
// match, all matching synonyms controls in the list will execute.
// Maximum number of specifications is 100.
//
// Can only be set if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
SynonymsControlIds []string `protobuf:"bytes,15,rep,name=synonyms_control_ids,json=synonymsControlIds,proto3" json:"synonyms_control_ids,omitempty"`
// Condition oneway synonyms specifications. If multiple oneway synonyms
// conditions match, all matching oneway synonyms controls in the list
// will execute. Maximum number of specifications is 100.
//
// Can only be set if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
OnewaySynonymsControlIds []string `protobuf:"bytes,16,rep,name=oneway_synonyms_control_ids,json=onewaySynonymsControlIds,proto3" json:"oneway_synonyms_control_ids,omitempty"`
// Condition do not associate specifications. If multiple do not
// associate conditions match, all matching do not associate controls in
// the list will execute.
// Order does not matter.
// Maximum number of specifications is 100.
//
// Can only be set if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
DissociateControlIds []string `protobuf:"bytes,17,rep,name=dissociate_control_ids,json=dissociateControlIds,proto3" json:"dissociate_control_ids,omitempty"`
// Condition replacement specifications.
// Applied according to the order in the list.
// A previously replaced term can not be re-replaced.
// Maximum number of specifications is 100.
//
// Can only be set if
// [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
// [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
ReplacementControlIds []string `protobuf:"bytes,18,rep,name=replacement_control_ids,json=replacementControlIds,proto3" json:"replacement_control_ids,omitempty"`
// Condition ignore specifications. If multiple ignore
// conditions match, all matching ignore controls in the list will
// execute.
// Order does not matter.
// Maximum number of specifications is 100.
IgnoreControlIds []string `protobuf:"bytes,19,rep,name=ignore_control_ids,json=ignoreControlIds,proto3" json:"ignore_control_ids,omitempty"`
// contains filtered or unexported fields
}Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
func (*ServingConfig) Descriptor
func (*ServingConfig) Descriptor() ([]byte, []int)Deprecated: Use ServingConfig.ProtoReflect.Descriptor instead.
func (*ServingConfig) GetBoostControlIds
func (x *ServingConfig) GetBoostControlIds() []stringfunc (*ServingConfig) GetCreateTime
func (x *ServingConfig) GetCreateTime() *timestamppb.Timestampfunc (*ServingConfig) GetCustomFineTuningSpec
func (x *ServingConfig) GetCustomFineTuningSpec() *CustomFineTuningSpecfunc (*ServingConfig) GetDisplayName
func (x *ServingConfig) GetDisplayName() stringfunc (*ServingConfig) GetDissociateControlIds
func (x *ServingConfig) GetDissociateControlIds() []stringfunc (*ServingConfig) GetDiversityLevel
func (x *ServingConfig) GetDiversityLevel() stringfunc (*ServingConfig) GetEmbeddingConfig
func (x *ServingConfig) GetEmbeddingConfig() *EmbeddingConfigfunc (*ServingConfig) GetFilterControlIds
func (x *ServingConfig) GetFilterControlIds() []stringfunc (*ServingConfig) GetGenericConfig
func (x *ServingConfig) GetGenericConfig() *ServingConfig_GenericConfigfunc (*ServingConfig) GetGuidedSearchSpec
func (x *ServingConfig) GetGuidedSearchSpec() *GuidedSearchSpecfunc (*ServingConfig) GetIgnoreControlIds
func (x *ServingConfig) GetIgnoreControlIds() []stringfunc (*ServingConfig) GetMediaConfig
func (x *ServingConfig) GetMediaConfig() *ServingConfig_MediaConfigfunc (*ServingConfig) GetModelId
func (x *ServingConfig) GetModelId() stringfunc (*ServingConfig) GetName
func (x *ServingConfig) GetName() stringfunc (*ServingConfig) GetOnewaySynonymsControlIds
func (x *ServingConfig) GetOnewaySynonymsControlIds() []stringfunc (*ServingConfig) GetRankingExpression
func (x *ServingConfig) GetRankingExpression() stringfunc (*ServingConfig) GetRedirectControlIds
func (x *ServingConfig) GetRedirectControlIds() []stringfunc (*ServingConfig) GetReplacementControlIds
func (x *ServingConfig) GetReplacementControlIds() []stringfunc (*ServingConfig) GetSolutionType
func (x *ServingConfig) GetSolutionType() SolutionTypefunc (*ServingConfig) GetSynonymsControlIds
func (x *ServingConfig) GetSynonymsControlIds() []stringfunc (*ServingConfig) GetUpdateTime
func (x *ServingConfig) GetUpdateTime() *timestamppb.Timestampfunc (*ServingConfig) GetVerticalConfig
func (x *ServingConfig) GetVerticalConfig() isServingConfig_VerticalConfigfunc (*ServingConfig) ProtoMessage
func (*ServingConfig) ProtoMessage()func (*ServingConfig) ProtoReflect
func (x *ServingConfig) ProtoReflect() protoreflect.Messagefunc (*ServingConfig) Reset
func (x *ServingConfig) Reset()func (*ServingConfig) String
func (x *ServingConfig) String() stringServingConfigServiceClient
type ServingConfigServiceClient interface {
// Updates a ServingConfig.
//
// Returns a NOT_FOUND error if the ServingConfig does not exist.
UpdateServingConfig(ctx context.Context, in *UpdateServingConfigRequest, opts ...grpc.CallOption) (*ServingConfig, error)
// Gets a ServingConfig.
//
// Returns a NotFound error if the ServingConfig does not exist.
GetServingConfig(ctx context.Context, in *GetServingConfigRequest, opts ...grpc.CallOption) (*ServingConfig, error)
// Lists all ServingConfigs linked to this dataStore.
ListServingConfigs(ctx context.Context, in *ListServingConfigsRequest, opts ...grpc.CallOption) (*ListServingConfigsResponse, error)
}ServingConfigServiceClient is the client API for ServingConfigService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewServingConfigServiceClient
func NewServingConfigServiceClient(cc grpc.ClientConnInterface) ServingConfigServiceClientServingConfigServiceServer
type ServingConfigServiceServer interface {
// Updates a ServingConfig.
//
// Returns a NOT_FOUND error if the ServingConfig does not exist.
UpdateServingConfig(context.Context, *UpdateServingConfigRequest) (*ServingConfig, error)
// Gets a ServingConfig.
//
// Returns a NotFound error if the ServingConfig does not exist.
GetServingConfig(context.Context, *GetServingConfigRequest) (*ServingConfig, error)
// Lists all ServingConfigs linked to this dataStore.
ListServingConfigs(context.Context, *ListServingConfigsRequest) (*ListServingConfigsResponse, error)
}ServingConfigServiceServer is the server API for ServingConfigService service. All implementations should embed UnimplementedServingConfigServiceServer for forward compatibility
ServingConfig_GenericConfig
type ServingConfig_GenericConfig struct {
// Specifies the expected behavior of content search.
// Only valid for content-search enabled data store.
ContentSearchSpec *SearchRequest_ContentSearchSpec `protobuf:"bytes,1,opt,name=content_search_spec,json=contentSearchSpec,proto3" json:"content_search_spec,omitempty"`
// contains filtered or unexported fields
}Specifies the configurations needed for Generic Discovery.Currently we support:
content_search_spec: configuration for generic content search.
func (*ServingConfig_GenericConfig) Descriptor
func (*ServingConfig_GenericConfig) Descriptor() ([]byte, []int)Deprecated: Use ServingConfig_GenericConfig.ProtoReflect.Descriptor instead.
func (*ServingConfig_GenericConfig) GetContentSearchSpec
func (x *ServingConfig_GenericConfig) GetContentSearchSpec() *SearchRequest_ContentSearchSpecfunc (*ServingConfig_GenericConfig) ProtoMessage
func (*ServingConfig_GenericConfig) ProtoMessage()func (*ServingConfig_GenericConfig) ProtoReflect
func (x *ServingConfig_GenericConfig) ProtoReflect() protoreflect.Messagefunc (*ServingConfig_GenericConfig) Reset
func (x *ServingConfig_GenericConfig) Reset()func (*ServingConfig_GenericConfig) String
func (x *ServingConfig_GenericConfig) String() stringServingConfig_GenericConfig_
type ServingConfig_GenericConfig_ struct {
// The GenericConfig of the serving configuration.
GenericConfig *ServingConfig_GenericConfig `protobuf:"bytes,10,opt,name=generic_config,json=genericConfig,proto3,oneof"`
}ServingConfig_MediaConfig
type ServingConfig_MediaConfig struct {
// Specify the threshold for demoting watched content, the threshold can be
// either percentage or minutes value.
// This must be set for `media-complete` event type.
//
// Types that are valid to be assigned to DemoteContentWatched:
//
// *ServingConfig_MediaConfig_ContentWatchedPercentageThreshold
// *ServingConfig_MediaConfig_ContentWatchedSecondsThreshold
DemoteContentWatched isServingConfig_MediaConfig_DemoteContentWatched `protobuf_oneof:"demote_content_watched"`
// Specifies the event type used for demoting recommendation result.
// Currently supported values:
//
// * `view-item`: Item viewed.
// * `media-play`: Start/resume watching a video, playing a song, etc.
// * `media-complete`: Finished or stopped midway through a video, song,
// etc.
//
// If unset, watch history demotion will not be applied. Content freshness
// demotion will still be applied.
DemotionEventType string `protobuf:"bytes,1,opt,name=demotion_event_type,json=demotionEventType,proto3" json:"demotion_event_type,omitempty"`
// Specifies the content freshness used for recommendation result.
// Contents will be demoted if contents were published for more than content
// freshness cutoff days.
ContentFreshnessCutoffDays int32 `protobuf:"varint,4,opt,name=content_freshness_cutoff_days,json=contentFreshnessCutoffDays,proto3" json:"content_freshness_cutoff_days,omitempty"`
// contains filtered or unexported fields
}Specifies the configurations needed for Media Discovery. Currently we support:
demote_content_watched: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result.promote_fresh_content: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
func (*ServingConfig_MediaConfig) Descriptor
func (*ServingConfig_MediaConfig) Descriptor() ([]byte, []int)Deprecated: Use ServingConfig_MediaConfig.ProtoReflect.Descriptor instead.
func (*ServingConfig_MediaConfig) GetContentFreshnessCutoffDays
func (x *ServingConfig_MediaConfig) GetContentFreshnessCutoffDays() int32func (*ServingConfig_MediaConfig) GetContentWatchedPercentageThreshold
func (x *ServingConfig_MediaConfig) GetContentWatchedPercentageThreshold() float32func (*ServingConfig_MediaConfig) GetContentWatchedSecondsThreshold
func (x *ServingConfig_MediaConfig) GetContentWatchedSecondsThreshold() float32func (*ServingConfig_MediaConfig) GetDemoteContentWatched
func (x *ServingConfig_MediaConfig) GetDemoteContentWatched() isServingConfig_MediaConfig_DemoteContentWatchedfunc (*ServingConfig_MediaConfig) GetDemotionEventType
func (x *ServingConfig_MediaConfig) GetDemotionEventType() stringfunc (*ServingConfig_MediaConfig) ProtoMessage
func (*ServingConfig_MediaConfig) ProtoMessage()func (*ServingConfig_MediaConfig) ProtoReflect
func (x *ServingConfig_MediaConfig) ProtoReflect() protoreflect.Messagefunc (*ServingConfig_MediaConfig) Reset
func (x *ServingConfig_MediaConfig) Reset()func (*ServingConfig_MediaConfig) String
func (x *ServingConfig_MediaConfig) String() stringServingConfig_MediaConfig_
type ServingConfig_MediaConfig_ struct {
// The MediaConfig of the serving configuration.
MediaConfig *ServingConfig_MediaConfig `protobuf:"bytes,7,opt,name=media_config,json=mediaConfig,proto3,oneof"`
}ServingConfig_MediaConfig_ContentWatchedPercentageThreshold
type ServingConfig_MediaConfig_ContentWatchedPercentageThreshold struct {
// Specifies the content watched percentage threshold for demotion.
// Threshold value must be between [0, 1.0] inclusive.
ContentWatchedPercentageThreshold float32 `protobuf:"fixed32,2,opt,name=content_watched_percentage_threshold,json=contentWatchedPercentageThreshold,proto3,oneof"`
}ServingConfig_MediaConfig_ContentWatchedSecondsThreshold
type ServingConfig_MediaConfig_ContentWatchedSecondsThreshold struct {
// Specifies the content watched minutes threshold for demotion.
ContentWatchedSecondsThreshold float32 `protobuf:"fixed32,5,opt,name=content_watched_seconds_threshold,json=contentWatchedSecondsThreshold,proto3,oneof"`
}Session
type Session struct {
// Immutable. Fully qualified name
// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The display name of the session.
//
// This field is used to identify the session in the UI.
// By default, the display name is the first turn query text in the session.
DisplayName string `protobuf:"bytes,7,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The state of the session.
State Session_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.discoveryengine.v1alpha.Session_State" json:"state,omitempty"`
// A unique identifier for tracking users.
UserPseudoId string `protobuf:"bytes,3,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
// Turns.
Turns []*Session_Turn `protobuf:"bytes,4,rep,name=turns,proto3" json:"turns,omitempty"`
// Output only. The time the session started.
StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. The time the session finished.
EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Optional. Whether the session is pinned, pinned session will be displayed
// on the top of the session list.
IsPinned bool `protobuf:"varint,8,opt,name=is_pinned,json=isPinned,proto3" json:"is_pinned,omitempty"`
// contains filtered or unexported fields
}External session proto definition.
func (*Session) Descriptor
Deprecated: Use Session.ProtoReflect.Descriptor instead.
func (*Session) GetDisplayName
func (*Session) GetEndTime
func (x *Session) GetEndTime() *timestamppb.Timestampfunc (*Session) GetIsPinned
func (*Session) GetName
func (*Session) GetStartTime
func (x *Session) GetStartTime() *timestamppb.Timestampfunc (*Session) GetState
func (x *Session) GetState() Session_Statefunc (*Session) GetTurns
func (x *Session) GetTurns() []*Session_Turnfunc (*Session) GetUserPseudoId
func (*Session) ProtoMessage
func (*Session) ProtoMessage()func (*Session) ProtoReflect
func (x *Session) ProtoReflect() protoreflect.Messagefunc (*Session) Reset
func (x *Session) Reset()func (*Session) String
SessionServiceClient
type SessionServiceClient interface {
// Creates a Session.
//
// If the [Session][google.cloud.discoveryengine.v1alpha.Session] to create
// already exists, an ALREADY_EXISTS error is returned.
CreateSession(ctx context.Context, in *CreateSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Deletes a Session.
//
// If the [Session][google.cloud.discoveryengine.v1alpha.Session] to delete
// does not exist, a NOT_FOUND error is returned.
DeleteSession(ctx context.Context, in *DeleteSessionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates a Session.
//
// [Session][google.cloud.discoveryengine.v1alpha.Session] action type cannot
// be changed. If the [Session][google.cloud.discoveryengine.v1alpha.Session]
// to update does not exist, a NOT_FOUND error is returned.
UpdateSession(ctx context.Context, in *UpdateSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Gets a Session.
GetSession(ctx context.Context, in *GetSessionRequest, opts ...grpc.CallOption) (*Session, error)
// Lists all Sessions by their parent
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
ListSessions(ctx context.Context, in *ListSessionsRequest, opts ...grpc.CallOption) (*ListSessionsResponse, error)
// Lists metadata for all files in the current session.
ListFiles(ctx context.Context, in *ListFilesRequest, opts ...grpc.CallOption) (*ListFilesResponse, error)
}SessionServiceClient is the client API for SessionService 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 NewSessionServiceClient
func NewSessionServiceClient(cc grpc.ClientConnInterface) SessionServiceClientSessionServiceServer
type SessionServiceServer interface {
// Creates a Session.
//
// If the [Session][google.cloud.discoveryengine.v1alpha.Session] to create
// already exists, an ALREADY_EXISTS error is returned.
CreateSession(context.Context, *CreateSessionRequest) (*Session, error)
// Deletes a Session.
//
// If the [Session][google.cloud.discoveryengine.v1alpha.Session] to delete
// does not exist, a NOT_FOUND error is returned.
DeleteSession(context.Context, *DeleteSessionRequest) (*emptypb.Empty, error)
// Updates a Session.
//
// [Session][google.cloud.discoveryengine.v1alpha.Session] action type cannot
// be changed. If the [Session][google.cloud.discoveryengine.v1alpha.Session]
// to update does not exist, a NOT_FOUND error is returned.
UpdateSession(context.Context, *UpdateSessionRequest) (*Session, error)
// Gets a Session.
GetSession(context.Context, *GetSessionRequest) (*Session, error)
// Lists all Sessions by their parent
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)
// Lists metadata for all files in the current session.
ListFiles(context.Context, *ListFilesRequest) (*ListFilesResponse, error)
}SessionServiceServer is the server API for SessionService service. All implementations should embed UnimplementedSessionServiceServer for forward compatibility
Session_State
type Session_State int32Enumeration of the state of the session.
Session_STATE_UNSPECIFIED, Session_IN_PROGRESS
const (
// State is unspecified.
Session_STATE_UNSPECIFIED Session_State = 0
// The session is currently open.
Session_IN_PROGRESS Session_State = 1
)func (Session_State) Descriptor
func (Session_State) Descriptor() protoreflect.EnumDescriptorfunc (Session_State) Enum
func (x Session_State) Enum() *Session_Statefunc (Session_State) EnumDescriptor
func (Session_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Session_State.Descriptor instead.
func (Session_State) Number
func (x Session_State) Number() protoreflect.EnumNumberfunc (Session_State) String
func (x Session_State) String() stringfunc (Session_State) Type
func (Session_State) Type() protoreflect.EnumTypeSession_Turn
type Session_Turn struct {
// Optional. The user query. May not be set if this turn is merely
// regenerating an answer to a different turn
Query *Query `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
// Optional. The resource name of the answer to the user query.
//
// Only set if the answer generation (/answer API call) happened in this
// turn.
Answer string `protobuf:"bytes,2,opt,name=answer,proto3" json:"answer,omitempty"`
// Output only. In
// [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetSession]
// API, if
// [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1alpha.GetSessionRequest.include_answer_details]
// is set to true, this field will be populated when getting answer query
// session.
DetailedAnswer *Answer `protobuf:"bytes,7,opt,name=detailed_answer,json=detailedAnswer,proto3" json:"detailed_answer,omitempty"`
// Optional. Represents metadata related to the query config, for example
// LLM model and version used, model parameters (temperature, grounding
// parameters, etc.). The prefix "google." is reserved for Google-developed
// functionality.
QueryConfig map[string]string `protobuf:"bytes,16,rep,name=query_config,json=queryConfig,proto3" json:"query_config,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}Represents a turn, including a query from the user and a answer from service.
func (*Session_Turn) Descriptor
func (*Session_Turn) Descriptor() ([]byte, []int)Deprecated: Use Session_Turn.ProtoReflect.Descriptor instead.
func (*Session_Turn) GetAnswer
func (x *Session_Turn) GetAnswer() stringfunc (*Session_Turn) GetDetailedAnswer
func (x *Session_Turn) GetDetailedAnswer() *Answerfunc (*Session_Turn) GetQuery
func (x *Session_Turn) GetQuery() *Queryfunc (*Session_Turn) GetQueryConfig
func (x *Session_Turn) GetQueryConfig() map[string]stringfunc (*Session_Turn) ProtoMessage
func (*Session_Turn) ProtoMessage()func (*Session_Turn) ProtoReflect
func (x *Session_Turn) ProtoReflect() protoreflect.Messagefunc (*Session_Turn) Reset
func (x *Session_Turn) Reset()func (*Session_Turn) String
func (x *Session_Turn) String() stringSetUriPatternDocumentDataMetadata
type SetUriPatternDocumentDataMetadata 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.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*SetUriPatternDocumentDataMetadata) Descriptor
func (*SetUriPatternDocumentDataMetadata) Descriptor() ([]byte, []int)Deprecated: Use SetUriPatternDocumentDataMetadata.ProtoReflect.Descriptor instead.
func (*SetUriPatternDocumentDataMetadata) GetCreateTime
func (x *SetUriPatternDocumentDataMetadata) GetCreateTime() *timestamppb.Timestampfunc (*SetUriPatternDocumentDataMetadata) GetUpdateTime
func (x *SetUriPatternDocumentDataMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*SetUriPatternDocumentDataMetadata) ProtoMessage
func (*SetUriPatternDocumentDataMetadata) ProtoMessage()func (*SetUriPatternDocumentDataMetadata) ProtoReflect
func (x *SetUriPatternDocumentDataMetadata) ProtoReflect() protoreflect.Messagefunc (*SetUriPatternDocumentDataMetadata) Reset
func (x *SetUriPatternDocumentDataMetadata) Reset()func (*SetUriPatternDocumentDataMetadata) String
func (x *SetUriPatternDocumentDataMetadata) String() stringSetUriPatternDocumentDataRequest
type SetUriPatternDocumentDataRequest struct {
// Required. Full resource name of the
// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
// such as
// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
SiteSearchEngine string `protobuf:"bytes,1,opt,name=site_search_engine,json=siteSearchEngine,proto3" json:"site_search_engine,omitempty"`
// Document data keyed by URI pattern. Each entry must be consistent with
// the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
// [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
// "type": "object",
//
// "properties": {
// "Categories": {
// "type": "array",
// "items": {
// "retrievable": true,
// "type": "string"
// }
// }
// }
//
// document_data_map = {
// "www.url1.com/*": {
// "Categories": ["category1", "category2"]
// },
// "www.url2.com/*": {
// "Categories": ["category3"]
// }
// }
DocumentDataMap map[string]*structpb.Struct `protobuf:"bytes,2,rep,name=document_data_map,json=documentDataMap,proto3" json:"document_data_map,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// If true, clears the document data map. If true,
// [SetUriPatternDocumentDataRequest.document_data_map][google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.document_data_map]
// must be empty.
EmptyDocumentDataMap bool `protobuf:"varint,4,opt,name=empty_document_data_map,json=emptyDocumentDataMap,proto3" json:"empty_document_data_map,omitempty"`
// Optional. If not provided, the current
// [Schema][google.cloud.discoveryengine.v1alpha.Schema] is used. If provided,
// validates and updates the
// [Schema][google.cloud.discoveryengine.v1alpha.Schema]. If validation fails,
// an error is returned.
Schema *structpb.Struct `protobuf:"bytes,3,opt,name=schema,proto3" json:"schema,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] method.
func (*SetUriPatternDocumentDataRequest) Descriptor
func (*SetUriPatternDocumentDataRequest) Descriptor() ([]byte, []int)Deprecated: Use SetUriPatternDocumentDataRequest.ProtoReflect.Descriptor instead.
func (*SetUriPatternDocumentDataRequest) GetDocumentDataMap
func (x *SetUriPatternDocumentDataRequest) GetDocumentDataMap() map[string]*structpb.Structfunc (*SetUriPatternDocumentDataRequest) GetEmptyDocumentDataMap
func (x *SetUriPatternDocumentDataRequest) GetEmptyDocumentDataMap() boolfunc (*SetUriPatternDocumentDataRequest) GetSchema
func (x *SetUriPatternDocumentDataRequest) GetSchema() *structpb.Structfunc (*SetUriPatternDocumentDataRequest) GetSiteSearchEngine
func (x *SetUriPatternDocumentDataRequest) GetSiteSearchEngine() stringfunc (*SetUriPatternDocumentDataRequest) ProtoMessage
func (*SetUriPatternDocumentDataRequest) ProtoMessage()func (*SetUriPatternDocumentDataRequest) ProtoReflect
func (x *SetUriPatternDocumentDataRequest) ProtoReflect() protoreflect.Messagefunc (*SetUriPatternDocumentDataRequest) Reset
func (x *SetUriPatternDocumentDataRequest) Reset()func (*SetUriPatternDocumentDataRequest) String
func (x *SetUriPatternDocumentDataRequest) String() stringSetUriPatternDocumentDataResponse
type SetUriPatternDocumentDataResponse struct {
// contains filtered or unexported fields
}Response message for [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] method.
func (*SetUriPatternDocumentDataResponse) Descriptor
func (*SetUriPatternDocumentDataResponse) Descriptor() ([]byte, []int)Deprecated: Use SetUriPatternDocumentDataResponse.ProtoReflect.Descriptor instead.
func (*SetUriPatternDocumentDataResponse) ProtoMessage
func (*SetUriPatternDocumentDataResponse) ProtoMessage()func (*SetUriPatternDocumentDataResponse) ProtoReflect
func (x *SetUriPatternDocumentDataResponse) ProtoReflect() protoreflect.Messagefunc (*SetUriPatternDocumentDataResponse) Reset
func (x *SetUriPatternDocumentDataResponse) Reset()func (*SetUriPatternDocumentDataResponse) String
func (x *SetUriPatternDocumentDataResponse) String() stringSiteSearchEngine
type SiteSearchEngine struct {
// The fully qualified resource name of the site search engine.
// Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
func (*SiteSearchEngine) Descriptor
func (*SiteSearchEngine) Descriptor() ([]byte, []int)Deprecated: Use SiteSearchEngine.ProtoReflect.Descriptor instead.
func (*SiteSearchEngine) GetName
func (x *SiteSearchEngine) GetName() stringfunc (*SiteSearchEngine) ProtoMessage
func (*SiteSearchEngine) ProtoMessage()func (*SiteSearchEngine) ProtoReflect
func (x *SiteSearchEngine) ProtoReflect() protoreflect.Messagefunc (*SiteSearchEngine) Reset
func (x *SiteSearchEngine) Reset()func (*SiteSearchEngine) String
func (x *SiteSearchEngine) String() stringSiteSearchEngineServiceClient
type SiteSearchEngineServiceClient interface {
// Gets the
// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine].
GetSiteSearchEngine(ctx context.Context, in *GetSiteSearchEngineRequest, opts ...grpc.CallOption) (*SiteSearchEngine, error)
// Creates a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
CreateTargetSite(ctx context.Context, in *CreateTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Creates [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in a
// batch.
BatchCreateTargetSites(ctx context.Context, in *BatchCreateTargetSitesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
GetTargetSite(ctx context.Context, in *GetTargetSiteRequest, opts ...grpc.CallOption) (*TargetSite, error)
// Updates a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
UpdateTargetSite(ctx context.Context, in *UpdateTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
DeleteTargetSite(ctx context.Context, in *DeleteTargetSiteRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets a list of
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s.
ListTargetSites(ctx context.Context, in *ListTargetSitesRequest, opts ...grpc.CallOption) (*ListTargetSitesResponse, error)
// Upgrade from basic site search to advanced site search.
EnableAdvancedSiteSearch(ctx context.Context, in *EnableAdvancedSiteSearchRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Downgrade from advanced site search to basic site search.
DisableAdvancedSiteSearch(ctx context.Context, in *DisableAdvancedSiteSearchRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Request on-demand recrawl for a list of URIs.
RecrawlUris(ctx context.Context, in *RecrawlUrisRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Verify target sites' ownership and validity.
// This API sends all the target sites under site search engine for
// verification.
BatchVerifyTargetSites(ctx context.Context, in *BatchVerifyTargetSitesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Returns list of target sites with its domain verification status.
// This method can only be called under data store with BASIC_SITE_SEARCH
// state at the moment.
FetchDomainVerificationStatus(ctx context.Context, in *FetchDomainVerificationStatusRequest, opts ...grpc.CallOption) (*FetchDomainVerificationStatusResponse, error)
// Sets the URI Pattern to Document data mapping for an Advanced Site Search
// DataStore.
SetUriPatternDocumentData(ctx context.Context, in *SetUriPatternDocumentDataRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets the URI Pattern to Document data mapping for an Advanced Site Search
// DataStore.
GetUriPatternDocumentData(ctx context.Context, in *GetUriPatternDocumentDataRequest, opts ...grpc.CallOption) (*GetUriPatternDocumentDataResponse, error)
}SiteSearchEngineServiceClient is the client API for SiteSearchEngineService 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 NewSiteSearchEngineServiceClient
func NewSiteSearchEngineServiceClient(cc grpc.ClientConnInterface) SiteSearchEngineServiceClientSiteSearchEngineServiceServer
type SiteSearchEngineServiceServer interface {
// Gets the
// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine].
GetSiteSearchEngine(context.Context, *GetSiteSearchEngineRequest) (*SiteSearchEngine, error)
// Creates a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
CreateTargetSite(context.Context, *CreateTargetSiteRequest) (*longrunningpb.Operation, error)
// Creates [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in a
// batch.
BatchCreateTargetSites(context.Context, *BatchCreateTargetSitesRequest) (*longrunningpb.Operation, error)
// Gets a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
GetTargetSite(context.Context, *GetTargetSiteRequest) (*TargetSite, error)
// Updates a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
UpdateTargetSite(context.Context, *UpdateTargetSiteRequest) (*longrunningpb.Operation, error)
// Deletes a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
DeleteTargetSite(context.Context, *DeleteTargetSiteRequest) (*longrunningpb.Operation, error)
// Gets a list of
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s.
ListTargetSites(context.Context, *ListTargetSitesRequest) (*ListTargetSitesResponse, error)
// Upgrade from basic site search to advanced site search.
EnableAdvancedSiteSearch(context.Context, *EnableAdvancedSiteSearchRequest) (*longrunningpb.Operation, error)
// Downgrade from advanced site search to basic site search.
DisableAdvancedSiteSearch(context.Context, *DisableAdvancedSiteSearchRequest) (*longrunningpb.Operation, error)
// Request on-demand recrawl for a list of URIs.
RecrawlUris(context.Context, *RecrawlUrisRequest) (*longrunningpb.Operation, error)
// Verify target sites' ownership and validity.
// This API sends all the target sites under site search engine for
// verification.
BatchVerifyTargetSites(context.Context, *BatchVerifyTargetSitesRequest) (*longrunningpb.Operation, error)
// Returns list of target sites with its domain verification status.
// This method can only be called under data store with BASIC_SITE_SEARCH
// state at the moment.
FetchDomainVerificationStatus(context.Context, *FetchDomainVerificationStatusRequest) (*FetchDomainVerificationStatusResponse, error)
// Sets the URI Pattern to Document data mapping for an Advanced Site Search
// DataStore.
SetUriPatternDocumentData(context.Context, *SetUriPatternDocumentDataRequest) (*longrunningpb.Operation, error)
// Gets the URI Pattern to Document data mapping for an Advanced Site Search
// DataStore.
GetUriPatternDocumentData(context.Context, *GetUriPatternDocumentDataRequest) (*GetUriPatternDocumentDataResponse, error)
}SiteSearchEngineServiceServer is the server API for SiteSearchEngineService service. All implementations should embed UnimplementedSiteSearchEngineServiceServer for forward compatibility
SiteVerificationInfo
type SiteVerificationInfo struct {
// Site verification state indicating the ownership and validity.
SiteVerificationState SiteVerificationInfo_SiteVerificationState `protobuf:"varint,1,opt,name=site_verification_state,json=siteVerificationState,proto3,enum=google.cloud.discoveryengine.v1alpha.SiteVerificationInfo_SiteVerificationState" json:"site_verification_state,omitempty"`
// Latest site verification time.
VerifyTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=verify_time,json=verifyTime,proto3" json:"verify_time,omitempty"`
// contains filtered or unexported fields
}Verification information for target sites in advanced site search.
func (*SiteVerificationInfo) Descriptor
func (*SiteVerificationInfo) Descriptor() ([]byte, []int)Deprecated: Use SiteVerificationInfo.ProtoReflect.Descriptor instead.
func (*SiteVerificationInfo) GetSiteVerificationState
func (x *SiteVerificationInfo) GetSiteVerificationState() SiteVerificationInfo_SiteVerificationStatefunc (*SiteVerificationInfo) GetVerifyTime
func (x *SiteVerificationInfo) GetVerifyTime() *timestamppb.Timestampfunc (*SiteVerificationInfo) ProtoMessage
func (*SiteVerificationInfo) ProtoMessage()func (*SiteVerificationInfo) ProtoReflect
func (x *SiteVerificationInfo) ProtoReflect() protoreflect.Messagefunc (*SiteVerificationInfo) Reset
func (x *SiteVerificationInfo) Reset()func (*SiteVerificationInfo) String
func (x *SiteVerificationInfo) String() stringSiteVerificationInfo_SiteVerificationState
type SiteVerificationInfo_SiteVerificationState int32Site verification state.
SiteVerificationInfo_SITE_VERIFICATION_STATE_UNSPECIFIED, SiteVerificationInfo_VERIFIED, SiteVerificationInfo_UNVERIFIED, SiteVerificationInfo_EXEMPTED
const (
// Defaults to VERIFIED.
SiteVerificationInfo_SITE_VERIFICATION_STATE_UNSPECIFIED SiteVerificationInfo_SiteVerificationState = 0
// Site ownership verified.
SiteVerificationInfo_VERIFIED SiteVerificationInfo_SiteVerificationState = 1
// Site ownership pending verification or verification failed.
SiteVerificationInfo_UNVERIFIED SiteVerificationInfo_SiteVerificationState = 2
// Site exempt from verification, e.g., a public website that opens to all.
SiteVerificationInfo_EXEMPTED SiteVerificationInfo_SiteVerificationState = 3
)func (SiteVerificationInfo_SiteVerificationState) Descriptor
func (SiteVerificationInfo_SiteVerificationState) Descriptor() protoreflect.EnumDescriptorfunc (SiteVerificationInfo_SiteVerificationState) Enum
func (x SiteVerificationInfo_SiteVerificationState) Enum() *SiteVerificationInfo_SiteVerificationStatefunc (SiteVerificationInfo_SiteVerificationState) EnumDescriptor
func (SiteVerificationInfo_SiteVerificationState) EnumDescriptor() ([]byte, []int)Deprecated: Use SiteVerificationInfo_SiteVerificationState.Descriptor instead.
func (SiteVerificationInfo_SiteVerificationState) Number
func (x SiteVerificationInfo_SiteVerificationState) Number() protoreflect.EnumNumberfunc (SiteVerificationInfo_SiteVerificationState) String
func (x SiteVerificationInfo_SiteVerificationState) String() stringfunc (SiteVerificationInfo_SiteVerificationState) Type
func (SiteVerificationInfo_SiteVerificationState) Type() protoreflect.EnumTypeSolutionType
type SolutionType int32The type of solution.
SolutionType_SOLUTION_TYPE_UNSPECIFIED, SolutionType_SOLUTION_TYPE_RECOMMENDATION, SolutionType_SOLUTION_TYPE_SEARCH, SolutionType_SOLUTION_TYPE_CHAT, SolutionType_SOLUTION_TYPE_GENERATIVE_CHAT
const (
// Default value.
SolutionType_SOLUTION_TYPE_UNSPECIFIED SolutionType = 0
// Used for Recommendations AI.
SolutionType_SOLUTION_TYPE_RECOMMENDATION SolutionType = 1
// Used for Discovery Search.
SolutionType_SOLUTION_TYPE_SEARCH SolutionType = 2
// Used for use cases related to the Generative AI agent.
SolutionType_SOLUTION_TYPE_CHAT SolutionType = 3
// Used for use cases related to the Generative Chat agent.
// It's used for Generative chat engine only, the associated data stores
// must enrolled with `SOLUTION_TYPE_CHAT` solution.
SolutionType_SOLUTION_TYPE_GENERATIVE_CHAT SolutionType = 4
)func (SolutionType) Descriptor
func (SolutionType) Descriptor() protoreflect.EnumDescriptorfunc (SolutionType) Enum
func (x SolutionType) Enum() *SolutionTypefunc (SolutionType) EnumDescriptor
func (SolutionType) EnumDescriptor() ([]byte, []int)Deprecated: Use SolutionType.Descriptor instead.
func (SolutionType) Number
func (x SolutionType) Number() protoreflect.EnumNumberfunc (SolutionType) String
func (x SolutionType) String() stringfunc (SolutionType) Type
func (SolutionType) Type() protoreflect.EnumTypeSpannerSource
type SpannerSource struct {
// The project ID that contains the Spanner source. Has a length limit of 128
// characters. If not specified, inherits the project ID from the parent
// request.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Required. The instance ID of the source Spanner table.
InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Required. The database ID of the source Spanner table.
DatabaseId string `protobuf:"bytes,3,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
// Required. The table name of the Spanner database that needs to be imported.
TableId string `protobuf:"bytes,4,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Whether to apply data boost on Spanner export. Enabling this option will
// incur additional cost. More info can be found
// [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).
EnableDataBoost bool `protobuf:"varint,5,opt,name=enable_data_boost,json=enableDataBoost,proto3" json:"enable_data_boost,omitempty"`
// contains filtered or unexported fields
}The Spanner source for importing data
func (*SpannerSource) Descriptor
func (*SpannerSource) Descriptor() ([]byte, []int)Deprecated: Use SpannerSource.ProtoReflect.Descriptor instead.
func (*SpannerSource) GetDatabaseId
func (x *SpannerSource) GetDatabaseId() stringfunc (*SpannerSource) GetEnableDataBoost
func (x *SpannerSource) GetEnableDataBoost() boolfunc (*SpannerSource) GetInstanceId
func (x *SpannerSource) GetInstanceId() stringfunc (*SpannerSource) GetProjectId
func (x *SpannerSource) GetProjectId() stringfunc (*SpannerSource) GetTableId
func (x *SpannerSource) GetTableId() stringfunc (*SpannerSource) ProtoMessage
func (*SpannerSource) ProtoMessage()func (*SpannerSource) ProtoReflect
func (x *SpannerSource) ProtoReflect() protoreflect.Messagefunc (*SpannerSource) Reset
func (x *SpannerSource) Reset()func (*SpannerSource) String
func (x *SpannerSource) String() stringSuggestionDenyListEntry
type SuggestionDenyListEntry struct {
// Required. Phrase to block from suggestions served. Can be maximum 125
// characters.
BlockPhrase string `protobuf:"bytes,1,opt,name=block_phrase,json=blockPhrase,proto3" json:"block_phrase,omitempty"`
// Required. The match operator to apply for this phrase. Whether to block the
// exact phrase, or block any suggestions containing this phrase.
MatchOperator SuggestionDenyListEntry_MatchOperator `protobuf:"varint,2,opt,name=match_operator,json=matchOperator,proto3,enum=google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry_MatchOperator" json:"match_operator,omitempty"`
// contains filtered or unexported fields
}Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
func (*SuggestionDenyListEntry) Descriptor
func (*SuggestionDenyListEntry) Descriptor() ([]byte, []int)Deprecated: Use SuggestionDenyListEntry.ProtoReflect.Descriptor instead.
func (*SuggestionDenyListEntry) GetBlockPhrase
func (x *SuggestionDenyListEntry) GetBlockPhrase() stringfunc (*SuggestionDenyListEntry) GetMatchOperator
func (x *SuggestionDenyListEntry) GetMatchOperator() SuggestionDenyListEntry_MatchOperatorfunc (*SuggestionDenyListEntry) ProtoMessage
func (*SuggestionDenyListEntry) ProtoMessage()func (*SuggestionDenyListEntry) ProtoReflect
func (x *SuggestionDenyListEntry) ProtoReflect() protoreflect.Messagefunc (*SuggestionDenyListEntry) Reset
func (x *SuggestionDenyListEntry) Reset()func (*SuggestionDenyListEntry) String
func (x *SuggestionDenyListEntry) String() stringSuggestionDenyListEntry_MatchOperator
type SuggestionDenyListEntry_MatchOperator int32Operator for matching with the generated suggestions.
SuggestionDenyListEntry_MATCH_OPERATOR_UNSPECIFIED, SuggestionDenyListEntry_EXACT_MATCH, SuggestionDenyListEntry_CONTAINS
const (
// Default value. Should not be used
SuggestionDenyListEntry_MATCH_OPERATOR_UNSPECIFIED SuggestionDenyListEntry_MatchOperator = 0
// If the suggestion is an exact match to the block_phrase, then block it.
SuggestionDenyListEntry_EXACT_MATCH SuggestionDenyListEntry_MatchOperator = 1
// If the suggestion contains the block_phrase, then block it.
SuggestionDenyListEntry_CONTAINS SuggestionDenyListEntry_MatchOperator = 2
)func (SuggestionDenyListEntry_MatchOperator) Descriptor
func (SuggestionDenyListEntry_MatchOperator) Descriptor() protoreflect.EnumDescriptorfunc (SuggestionDenyListEntry_MatchOperator) Enum
func (SuggestionDenyListEntry_MatchOperator) EnumDescriptor
func (SuggestionDenyListEntry_MatchOperator) EnumDescriptor() ([]byte, []int)Deprecated: Use SuggestionDenyListEntry_MatchOperator.Descriptor instead.
func (SuggestionDenyListEntry_MatchOperator) Number
func (x SuggestionDenyListEntry_MatchOperator) Number() protoreflect.EnumNumberfunc (SuggestionDenyListEntry_MatchOperator) String
func (x SuggestionDenyListEntry_MatchOperator) String() stringfunc (SuggestionDenyListEntry_MatchOperator) Type
func (SuggestionDenyListEntry_MatchOperator) Type() protoreflect.EnumTypeTargetSite
type TargetSite struct {
// Output only. The fully qualified resource name of the target site.
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`
// The `target_site_id` is system-generated.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Input only. The user provided URI pattern from which the
// `generated_uri_pattern` is generated.
ProvidedUriPattern string `protobuf:"bytes,2,opt,name=provided_uri_pattern,json=providedUriPattern,proto3" json:"provided_uri_pattern,omitempty"`
// The type of the target site, e.g., whether the site is to be included or
// excluded.
Type TargetSite_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1alpha.TargetSite_Type" json:"type,omitempty"`
// Input only. If set to false, a uri_pattern is generated to include all
// pages whose address contains the provided_uri_pattern. If set to true, an
// uri_pattern is generated to try to be an exact match of the
// provided_uri_pattern or just the specific page if the provided_uri_pattern
// is a specific one. provided_uri_pattern is always normalized to
// generate the URI pattern to be used by the search engine.
ExactMatch bool `protobuf:"varint,6,opt,name=exact_match,json=exactMatch,proto3" json:"exact_match,omitempty"`
// Output only. This is system-generated based on the provided_uri_pattern.
GeneratedUriPattern string `protobuf:"bytes,4,opt,name=generated_uri_pattern,json=generatedUriPattern,proto3" json:"generated_uri_pattern,omitempty"`
// Output only. Root domain of the provided_uri_pattern.
RootDomainUri string `protobuf:"bytes,10,opt,name=root_domain_uri,json=rootDomainUri,proto3" json:"root_domain_uri,omitempty"`
// Output only. Site ownership and validity verification status.
SiteVerificationInfo *SiteVerificationInfo `protobuf:"bytes,7,opt,name=site_verification_info,json=siteVerificationInfo,proto3" json:"site_verification_info,omitempty"`
// Output only. Indexing status.
IndexingStatus TargetSite_IndexingStatus `protobuf:"varint,8,opt,name=indexing_status,json=indexingStatus,proto3,enum=google.cloud.discoveryengine.v1alpha.TargetSite_IndexingStatus" json:"indexing_status,omitempty"`
// Output only. The target site's last updated time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. Failure reason.
FailureReason *TargetSite_FailureReason `protobuf:"bytes,9,opt,name=failure_reason,json=failureReason,proto3" json:"failure_reason,omitempty"`
// contains filtered or unexported fields
}A target site for the SiteSearchEngine.
func (*TargetSite) Descriptor
func (*TargetSite) Descriptor() ([]byte, []int)Deprecated: Use TargetSite.ProtoReflect.Descriptor instead.
func (*TargetSite) GetExactMatch
func (x *TargetSite) GetExactMatch() boolfunc (*TargetSite) GetFailureReason
func (x *TargetSite) GetFailureReason() *TargetSite_FailureReasonfunc (*TargetSite) GetGeneratedUriPattern
func (x *TargetSite) GetGeneratedUriPattern() stringfunc (*TargetSite) GetIndexingStatus
func (x *TargetSite) GetIndexingStatus() TargetSite_IndexingStatusfunc (*TargetSite) GetName
func (x *TargetSite) GetName() stringfunc (*TargetSite) GetProvidedUriPattern
func (x *TargetSite) GetProvidedUriPattern() stringfunc (*TargetSite) GetRootDomainUri
func (x *TargetSite) GetRootDomainUri() stringfunc (*TargetSite) GetSiteVerificationInfo
func (x *TargetSite) GetSiteVerificationInfo() *SiteVerificationInfofunc (*TargetSite) GetType
func (x *TargetSite) GetType() TargetSite_Typefunc (*TargetSite) GetUpdateTime
func (x *TargetSite) GetUpdateTime() *timestamppb.Timestampfunc (*TargetSite) ProtoMessage
func (*TargetSite) ProtoMessage()func (*TargetSite) ProtoReflect
func (x *TargetSite) ProtoReflect() protoreflect.Messagefunc (*TargetSite) Reset
func (x *TargetSite) Reset()func (*TargetSite) String
func (x *TargetSite) String() stringTargetSite_FailureReason
type TargetSite_FailureReason struct {
// Failure reason.
//
// Types that are valid to be assigned to Failure:
//
// *TargetSite_FailureReason_QuotaFailure_
Failure isTargetSite_FailureReason_Failure `protobuf_oneof:"failure"`
// contains filtered or unexported fields
}Site search indexing failure reasons.
func (*TargetSite_FailureReason) Descriptor
func (*TargetSite_FailureReason) Descriptor() ([]byte, []int)Deprecated: Use TargetSite_FailureReason.ProtoReflect.Descriptor instead.
func (*TargetSite_FailureReason) GetFailure
func (x *TargetSite_FailureReason) GetFailure() isTargetSite_FailureReason_Failurefunc (*TargetSite_FailureReason) GetQuotaFailure
func (x *TargetSite_FailureReason) GetQuotaFailure() *TargetSite_FailureReason_QuotaFailurefunc (*TargetSite_FailureReason) ProtoMessage
func (*TargetSite_FailureReason) ProtoMessage()func (*TargetSite_FailureReason) ProtoReflect
func (x *TargetSite_FailureReason) ProtoReflect() protoreflect.Messagefunc (*TargetSite_FailureReason) Reset
func (x *TargetSite_FailureReason) Reset()func (*TargetSite_FailureReason) String
func (x *TargetSite_FailureReason) String() stringTargetSite_FailureReason_QuotaFailure
type TargetSite_FailureReason_QuotaFailure struct {
// This number is an estimation on how much total quota this project needs
// to successfully complete indexing.
TotalRequiredQuota int64 `protobuf:"varint,1,opt,name=total_required_quota,json=totalRequiredQuota,proto3" json:"total_required_quota,omitempty"`
// contains filtered or unexported fields
}Failed due to insufficient quota.
func (*TargetSite_FailureReason_QuotaFailure) Descriptor
func (*TargetSite_FailureReason_QuotaFailure) Descriptor() ([]byte, []int)Deprecated: Use TargetSite_FailureReason_QuotaFailure.ProtoReflect.Descriptor instead.
func (*TargetSite_FailureReason_QuotaFailure) GetTotalRequiredQuota
func (x *TargetSite_FailureReason_QuotaFailure) GetTotalRequiredQuota() int64func (*TargetSite_FailureReason_QuotaFailure) ProtoMessage
func (*TargetSite_FailureReason_QuotaFailure) ProtoMessage()func (*TargetSite_FailureReason_QuotaFailure) ProtoReflect
func (x *TargetSite_FailureReason_QuotaFailure) ProtoReflect() protoreflect.Messagefunc (*TargetSite_FailureReason_QuotaFailure) Reset
func (x *TargetSite_FailureReason_QuotaFailure) Reset()func (*TargetSite_FailureReason_QuotaFailure) String
func (x *TargetSite_FailureReason_QuotaFailure) String() stringTargetSite_FailureReason_QuotaFailure_
type TargetSite_FailureReason_QuotaFailure_ struct {
// Failed due to insufficient quota.
QuotaFailure *TargetSite_FailureReason_QuotaFailure `protobuf:"bytes,1,opt,name=quota_failure,json=quotaFailure,proto3,oneof"`
}TargetSite_IndexingStatus
type TargetSite_IndexingStatus int32Target site indexing status enumeration.
TargetSite_INDEXING_STATUS_UNSPECIFIED, TargetSite_PENDING, TargetSite_FAILED, TargetSite_SUCCEEDED, TargetSite_DELETING
const (
// Defaults to SUCCEEDED.
TargetSite_INDEXING_STATUS_UNSPECIFIED TargetSite_IndexingStatus = 0
// The target site is in the update queue and will be picked up by indexing
// pipeline.
TargetSite_PENDING TargetSite_IndexingStatus = 1
// The target site fails to be indexed.
TargetSite_FAILED TargetSite_IndexingStatus = 2
// The target site has been indexed.
TargetSite_SUCCEEDED TargetSite_IndexingStatus = 3
// The previously indexed target site has been marked to be deleted. This is
// a transitioning state which will resulted in either:
// 1. target site deleted if unindexing is successful;
// 2. state reverts to SUCCEEDED if the unindexing fails.
TargetSite_DELETING TargetSite_IndexingStatus = 4
)func (TargetSite_IndexingStatus) Descriptor
func (TargetSite_IndexingStatus) Descriptor() protoreflect.EnumDescriptorfunc (TargetSite_IndexingStatus) Enum
func (x TargetSite_IndexingStatus) Enum() *TargetSite_IndexingStatusfunc (TargetSite_IndexingStatus) EnumDescriptor
func (TargetSite_IndexingStatus) EnumDescriptor() ([]byte, []int)Deprecated: Use TargetSite_IndexingStatus.Descriptor instead.
func (TargetSite_IndexingStatus) Number
func (x TargetSite_IndexingStatus) Number() protoreflect.EnumNumberfunc (TargetSite_IndexingStatus) String
func (x TargetSite_IndexingStatus) String() stringfunc (TargetSite_IndexingStatus) Type
func (TargetSite_IndexingStatus) Type() protoreflect.EnumTypeTargetSite_Type
type TargetSite_Type int32Possible target site types.
TargetSite_TYPE_UNSPECIFIED, TargetSite_INCLUDE, TargetSite_EXCLUDE
const (
// This value is unused. In this case, server behavior defaults to
// [Type.INCLUDE][google.cloud.discoveryengine.v1alpha.TargetSite.Type.INCLUDE].
TargetSite_TYPE_UNSPECIFIED TargetSite_Type = 0
// Include the target site.
TargetSite_INCLUDE TargetSite_Type = 1
// Exclude the target site.
TargetSite_EXCLUDE TargetSite_Type = 2
)func (TargetSite_Type) Descriptor
func (TargetSite_Type) Descriptor() protoreflect.EnumDescriptorfunc (TargetSite_Type) Enum
func (x TargetSite_Type) Enum() *TargetSite_Typefunc (TargetSite_Type) EnumDescriptor
func (TargetSite_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use TargetSite_Type.Descriptor instead.
func (TargetSite_Type) Number
func (x TargetSite_Type) Number() protoreflect.EnumNumberfunc (TargetSite_Type) String
func (x TargetSite_Type) String() stringfunc (TargetSite_Type) Type
func (TargetSite_Type) Type() protoreflect.EnumTypeTextInput
type TextInput struct {
// Text input.
Input string `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty"`
// Conversation context of the input.
Context *ConversationContext `protobuf:"bytes,2,opt,name=context,proto3" json:"context,omitempty"`
// contains filtered or unexported fields
}Defines text input.
func (*TextInput) Descriptor
Deprecated: Use TextInput.ProtoReflect.Descriptor instead.
func (*TextInput) GetContext
func (x *TextInput) GetContext() *ConversationContextfunc (*TextInput) GetInput
func (*TextInput) ProtoMessage
func (*TextInput) ProtoMessage()func (*TextInput) ProtoReflect
func (x *TextInput) ProtoReflect() protoreflect.Messagefunc (*TextInput) Reset
func (x *TextInput) Reset()func (*TextInput) String
TrainCustomModelMetadata
type TrainCustomModelMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
func (*TrainCustomModelMetadata) Descriptor
func (*TrainCustomModelMetadata) Descriptor() ([]byte, []int)Deprecated: Use TrainCustomModelMetadata.ProtoReflect.Descriptor instead.
func (*TrainCustomModelMetadata) GetCreateTime
func (x *TrainCustomModelMetadata) GetCreateTime() *timestamppb.Timestampfunc (*TrainCustomModelMetadata) GetUpdateTime
func (x *TrainCustomModelMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*TrainCustomModelMetadata) ProtoMessage
func (*TrainCustomModelMetadata) ProtoMessage()func (*TrainCustomModelMetadata) ProtoReflect
func (x *TrainCustomModelMetadata) ProtoReflect() protoreflect.Messagefunc (*TrainCustomModelMetadata) Reset
func (x *TrainCustomModelMetadata) Reset()func (*TrainCustomModelMetadata) String
func (x *TrainCustomModelMetadata) String() stringTrainCustomModelRequest
type TrainCustomModelRequest struct {
// Model training input.
//
// Types that are valid to be assigned to TrainingInput:
//
// *TrainCustomModelRequest_GcsTrainingInput_
TrainingInput isTrainCustomModelRequest_TrainingInput `protobuf_oneof:"training_input"`
// Required. The resource name of the Data Store, such as
// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
// This field is used to identify the data store where to train the models.
DataStore string `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// Model to be trained. Supported values are:
//
// - **search-tuning**: Fine tuning the search system based on data provided.
ModelType string `protobuf:"bytes,3,opt,name=model_type,json=modelType,proto3" json:"model_type,omitempty"`
// The desired location of errors incurred during the data ingestion and
// training.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,4,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// If not provided, a UUID will be generated.
ModelId string `protobuf:"bytes,5,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
// contains filtered or unexported fields
}Request message for [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1alpha.SearchTuningService.TrainCustomModel] method.
func (*TrainCustomModelRequest) Descriptor
func (*TrainCustomModelRequest) Descriptor() ([]byte, []int)Deprecated: Use TrainCustomModelRequest.ProtoReflect.Descriptor instead.
func (*TrainCustomModelRequest) GetDataStore
func (x *TrainCustomModelRequest) GetDataStore() stringfunc (*TrainCustomModelRequest) GetErrorConfig
func (x *TrainCustomModelRequest) GetErrorConfig() *ImportErrorConfigfunc (*TrainCustomModelRequest) GetGcsTrainingInput
func (x *TrainCustomModelRequest) GetGcsTrainingInput() *TrainCustomModelRequest_GcsTrainingInputfunc (*TrainCustomModelRequest) GetModelId
func (x *TrainCustomModelRequest) GetModelId() stringfunc (*TrainCustomModelRequest) GetModelType
func (x *TrainCustomModelRequest) GetModelType() stringfunc (*TrainCustomModelRequest) GetTrainingInput
func (x *TrainCustomModelRequest) GetTrainingInput() isTrainCustomModelRequest_TrainingInputfunc (*TrainCustomModelRequest) ProtoMessage
func (*TrainCustomModelRequest) ProtoMessage()func (*TrainCustomModelRequest) ProtoReflect
func (x *TrainCustomModelRequest) ProtoReflect() protoreflect.Messagefunc (*TrainCustomModelRequest) Reset
func (x *TrainCustomModelRequest) Reset()func (*TrainCustomModelRequest) String
func (x *TrainCustomModelRequest) String() stringTrainCustomModelRequest_GcsTrainingInput
type TrainCustomModelRequest_GcsTrainingInput struct {
// The Cloud Storage corpus data which could be associated in train data.
// The data path format is `gs://Cloud Storage training data input.
func (*TrainCustomModelRequest_GcsTrainingInput) Descriptor
func (*TrainCustomModelRequest_GcsTrainingInput) Descriptor() ([]byte, []int)Deprecated: Use TrainCustomModelRequest_GcsTrainingInput.ProtoReflect.Descriptor instead.
func (*TrainCustomModelRequest_GcsTrainingInput) GetCorpusDataPath
func (x *TrainCustomModelRequest_GcsTrainingInput) GetCorpusDataPath() stringfunc (*TrainCustomModelRequest_GcsTrainingInput) GetQueryDataPath
func (x *TrainCustomModelRequest_GcsTrainingInput) GetQueryDataPath() stringfunc (*TrainCustomModelRequest_GcsTrainingInput) GetTestDataPath
func (x *TrainCustomModelRequest_GcsTrainingInput) GetTestDataPath() stringfunc (*TrainCustomModelRequest_GcsTrainingInput) GetTrainDataPath
func (x *TrainCustomModelRequest_GcsTrainingInput) GetTrainDataPath() stringfunc (*TrainCustomModelRequest_GcsTrainingInput) ProtoMessage
func (*TrainCustomModelRequest_GcsTrainingInput) ProtoMessage()func (*TrainCustomModelRequest_GcsTrainingInput) ProtoReflect
func (x *TrainCustomModelRequest_GcsTrainingInput) ProtoReflect() protoreflect.Messagefunc (*TrainCustomModelRequest_GcsTrainingInput) Reset
func (x *TrainCustomModelRequest_GcsTrainingInput) Reset()func (*TrainCustomModelRequest_GcsTrainingInput) String
func (x *TrainCustomModelRequest_GcsTrainingInput) String() stringTrainCustomModelRequest_GcsTrainingInput_
type TrainCustomModelRequest_GcsTrainingInput_ struct {
// Cloud Storage training input.
GcsTrainingInput *TrainCustomModelRequest_GcsTrainingInput `protobuf:"bytes,2,opt,name=gcs_training_input,json=gcsTrainingInput,proto3,oneof"`
}TrainCustomModelResponse
type TrainCustomModelResponse struct {
// A sample of errors encountered while processing the data.
ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
// Echoes the destination for the complete errors in the request if set.
ErrorConfig *ImportErrorConfig `protobuf:"bytes,2,opt,name=error_config,json=errorConfig,proto3" json:"error_config,omitempty"`
// The trained model status. Possible values are:
//
// - **bad-data**: The training data quality is bad.
// - **no-improvement**: Tuning didn't improve performance. Won't deploy.
// - **in-progress**: Model training job creation is in progress.
// - **training**: Model is actively training.
// - **evaluating**: The model is evaluating trained metrics.
// - **indexing**: The model trained metrics are indexing.
// - **ready**: The model is ready for serving.
ModelStatus string `protobuf:"bytes,3,opt,name=model_status,json=modelStatus,proto3" json:"model_status,omitempty"`
// The metrics of the trained model.
Metrics map[string]float64 `protobuf:"bytes,4,rep,name=metrics,proto3" json:"metrics,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"fixed64,2,opt,name=value"`
// Fully qualified name of the CustomTuningModel.
ModelName string `protobuf:"bytes,5,opt,name=model_name,json=modelName,proto3" json:"model_name,omitempty"`
// contains filtered or unexported fields
}Response of the [TrainCustomModelRequest][google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest]. This message is returned by the google.longrunning.Operations.response field.
func (*TrainCustomModelResponse) Descriptor
func (*TrainCustomModelResponse) Descriptor() ([]byte, []int)Deprecated: Use TrainCustomModelResponse.ProtoReflect.Descriptor instead.
func (*TrainCustomModelResponse) GetErrorConfig
func (x *TrainCustomModelResponse) GetErrorConfig() *ImportErrorConfigfunc (*TrainCustomModelResponse) GetErrorSamples
func (x *TrainCustomModelResponse) GetErrorSamples() []*status.Statusfunc (*TrainCustomModelResponse) GetMetrics
func (x *TrainCustomModelResponse) GetMetrics() map[string]float64func (*TrainCustomModelResponse) GetModelName
func (x *TrainCustomModelResponse) GetModelName() stringfunc (*TrainCustomModelResponse) GetModelStatus
func (x *TrainCustomModelResponse) GetModelStatus() stringfunc (*TrainCustomModelResponse) ProtoMessage
func (*TrainCustomModelResponse) ProtoMessage()func (*TrainCustomModelResponse) ProtoReflect
func (x *TrainCustomModelResponse) ProtoReflect() protoreflect.Messagefunc (*TrainCustomModelResponse) Reset
func (x *TrainCustomModelResponse) Reset()func (*TrainCustomModelResponse) String
func (x *TrainCustomModelResponse) String() stringTransactionInfo
type TransactionInfo struct {
// Required. Total non-zero value associated with the transaction. This value
// may include shipping, tax, or other adjustments to the total value that you
// want to include.
Value *float32 `protobuf:"fixed32,1,opt,name=value,proto3,oneof" json:"value,omitempty"`
// Required. Currency code. Use three-character ISO-4217 code.
Currency string `protobuf:"bytes,2,opt,name=currency,proto3" json:"currency,omitempty"`
// The transaction ID with a length limit of 128 characters.
TransactionId string `protobuf:"bytes,3,opt,name=transaction_id,json=transactionId,proto3" json:"transaction_id,omitempty"`
// All the taxes associated with the transaction.
Tax *float32 `protobuf:"fixed32,4,opt,name=tax,proto3,oneof" json:"tax,omitempty"`
// All the costs associated with the products. These can be manufacturing
// costs, shipping expenses not borne by the end user, or any other costs,
// such that:
//
// * Profit =
// [value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value] -
// [tax][google.cloud.discoveryengine.v1alpha.TransactionInfo.tax] -
// [cost][google.cloud.discoveryengine.v1alpha.TransactionInfo.cost]
Cost *float32 `protobuf:"fixed32,5,opt,name=cost,proto3,oneof" json:"cost,omitempty"`
// The total discount(s) value applied to this transaction.
// This figure should be excluded from
// [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value]
//
// For example, if a user paid
// [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value]
// amount, then nominal (pre-discount) value of the transaction is the sum of
// [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value]
// and
// [TransactionInfo.discount_value][google.cloud.discoveryengine.v1alpha.TransactionInfo.discount_value]
//
// This means that profit is calculated the same way, regardless of the
// discount value, and that
// [TransactionInfo.discount_value][google.cloud.discoveryengine.v1alpha.TransactionInfo.discount_value]
// can be larger than
// [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value]:
//
// * Profit =
// [value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value] -
// [tax][google.cloud.discoveryengine.v1alpha.TransactionInfo.tax] -
// [cost][google.cloud.discoveryengine.v1alpha.TransactionInfo.cost]
DiscountValue *float32 `protobuf:"fixed32,6,opt,name=discount_value,json=discountValue,proto3,oneof" json:"discount_value,omitempty"`
// contains filtered or unexported fields
}A transaction represents the entire purchase transaction.
func (*TransactionInfo) Descriptor
func (*TransactionInfo) Descriptor() ([]byte, []int)Deprecated: Use TransactionInfo.ProtoReflect.Descriptor instead.
func (*TransactionInfo) GetCost
func (x *TransactionInfo) GetCost() float32func (*TransactionInfo) GetCurrency
func (x *TransactionInfo) GetCurrency() stringfunc (*TransactionInfo) GetDiscountValue
func (x *TransactionInfo) GetDiscountValue() float32func (*TransactionInfo) GetTax
func (x *TransactionInfo) GetTax() float32func (*TransactionInfo) GetTransactionId
func (x *TransactionInfo) GetTransactionId() stringfunc (*TransactionInfo) GetValue
func (x *TransactionInfo) GetValue() float32func (*TransactionInfo) ProtoMessage
func (*TransactionInfo) ProtoMessage()func (*TransactionInfo) ProtoReflect
func (x *TransactionInfo) ProtoReflect() protoreflect.Messagefunc (*TransactionInfo) Reset
func (x *TransactionInfo) Reset()func (*TransactionInfo) String
func (x *TransactionInfo) String() stringTuneEngineMetadata
type TuneEngineMetadata struct {
// Required. The resource name of the engine that this tune applies to.
// Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Engine string `protobuf:"bytes,1,opt,name=engine,proto3" json:"engine,omitempty"`
// contains filtered or unexported fields
}Metadata associated with a tune operation.
func (*TuneEngineMetadata) Descriptor
func (*TuneEngineMetadata) Descriptor() ([]byte, []int)Deprecated: Use TuneEngineMetadata.ProtoReflect.Descriptor instead.
func (*TuneEngineMetadata) GetEngine
func (x *TuneEngineMetadata) GetEngine() stringfunc (*TuneEngineMetadata) ProtoMessage
func (*TuneEngineMetadata) ProtoMessage()func (*TuneEngineMetadata) ProtoReflect
func (x *TuneEngineMetadata) ProtoReflect() protoreflect.Messagefunc (*TuneEngineMetadata) Reset
func (x *TuneEngineMetadata) Reset()func (*TuneEngineMetadata) String
func (x *TuneEngineMetadata) String() stringTuneEngineRequest
type TuneEngineRequest struct {
// Required. The resource name of the engine to tune.
// Format:
// `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).
func (*TuneEngineRequest) Descriptor
func (*TuneEngineRequest) Descriptor() ([]byte, []int)Deprecated: Use TuneEngineRequest.ProtoReflect.Descriptor instead.
func (*TuneEngineRequest) GetName
func (x *TuneEngineRequest) GetName() stringfunc (*TuneEngineRequest) ProtoMessage
func (*TuneEngineRequest) ProtoMessage()func (*TuneEngineRequest) ProtoReflect
func (x *TuneEngineRequest) ProtoReflect() protoreflect.Messagefunc (*TuneEngineRequest) Reset
func (x *TuneEngineRequest) Reset()func (*TuneEngineRequest) String
func (x *TuneEngineRequest) String() stringTuneEngineResponse
type TuneEngineResponse struct {
// contains filtered or unexported fields
}Response associated with a tune operation.
func (*TuneEngineResponse) Descriptor
func (*TuneEngineResponse) Descriptor() ([]byte, []int)Deprecated: Use TuneEngineResponse.ProtoReflect.Descriptor instead.
func (*TuneEngineResponse) ProtoMessage
func (*TuneEngineResponse) ProtoMessage()func (*TuneEngineResponse) ProtoReflect
func (x *TuneEngineResponse) ProtoReflect() protoreflect.Messagefunc (*TuneEngineResponse) Reset
func (x *TuneEngineResponse) Reset()func (*TuneEngineResponse) String
func (x *TuneEngineResponse) String() stringUnimplementedAclConfigServiceServer
type UnimplementedAclConfigServiceServer struct {
}UnimplementedAclConfigServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedAclConfigServiceServer) GetAclConfig
func (UnimplementedAclConfigServiceServer) GetAclConfig(context.Context, *GetAclConfigRequest) (*AclConfig, error)func (UnimplementedAclConfigServiceServer) UpdateAclConfig
func (UnimplementedAclConfigServiceServer) UpdateAclConfig(context.Context, *UpdateAclConfigRequest) (*AclConfig, error)UnimplementedChunkServiceServer
type UnimplementedChunkServiceServer struct {
}UnimplementedChunkServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedChunkServiceServer) GetChunk
func (UnimplementedChunkServiceServer) GetChunk(context.Context, *GetChunkRequest) (*Chunk, error)func (UnimplementedChunkServiceServer) ListChunks
func (UnimplementedChunkServiceServer) ListChunks(context.Context, *ListChunksRequest) (*ListChunksResponse, error)UnimplementedCompletionServiceServer
type UnimplementedCompletionServiceServer struct {
}UnimplementedCompletionServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedCompletionServiceServer) CompleteQuery
func (UnimplementedCompletionServiceServer) CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)func (UnimplementedCompletionServiceServer) ImportCompletionSuggestions
func (UnimplementedCompletionServiceServer) ImportCompletionSuggestions(context.Context, *ImportCompletionSuggestionsRequest) (*longrunningpb.Operation, error)func (UnimplementedCompletionServiceServer) ImportSuggestionDenyListEntries
func (UnimplementedCompletionServiceServer) ImportSuggestionDenyListEntries(context.Context, *ImportSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)func (UnimplementedCompletionServiceServer) PurgeCompletionSuggestions
func (UnimplementedCompletionServiceServer) PurgeCompletionSuggestions(context.Context, *PurgeCompletionSuggestionsRequest) (*longrunningpb.Operation, error)func (UnimplementedCompletionServiceServer) PurgeSuggestionDenyListEntries
func (UnimplementedCompletionServiceServer) PurgeSuggestionDenyListEntries(context.Context, *PurgeSuggestionDenyListEntriesRequest) (*longrunningpb.Operation, error)UnimplementedControlServiceServer
type UnimplementedControlServiceServer struct {
}UnimplementedControlServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedControlServiceServer) CreateControl
func (UnimplementedControlServiceServer) CreateControl(context.Context, *CreateControlRequest) (*Control, error)func (UnimplementedControlServiceServer) DeleteControl
func (UnimplementedControlServiceServer) DeleteControl(context.Context, *DeleteControlRequest) (*emptypb.Empty, error)func (UnimplementedControlServiceServer) GetControl
func (UnimplementedControlServiceServer) GetControl(context.Context, *GetControlRequest) (*Control, error)func (UnimplementedControlServiceServer) ListControls
func (UnimplementedControlServiceServer) ListControls(context.Context, *ListControlsRequest) (*ListControlsResponse, error)func (UnimplementedControlServiceServer) UpdateControl
func (UnimplementedControlServiceServer) UpdateControl(context.Context, *UpdateControlRequest) (*Control, error)UnimplementedConversationalSearchServiceServer
type UnimplementedConversationalSearchServiceServer struct {
}UnimplementedConversationalSearchServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedConversationalSearchServiceServer) AnswerQuery
func (UnimplementedConversationalSearchServiceServer) AnswerQuery(context.Context, *AnswerQueryRequest) (*AnswerQueryResponse, error)func (UnimplementedConversationalSearchServiceServer) ConverseConversation
func (UnimplementedConversationalSearchServiceServer) ConverseConversation(context.Context, *ConverseConversationRequest) (*ConverseConversationResponse, error)func (UnimplementedConversationalSearchServiceServer) CreateConversation
func (UnimplementedConversationalSearchServiceServer) CreateConversation(context.Context, *CreateConversationRequest) (*Conversation, error)func (UnimplementedConversationalSearchServiceServer) CreateSession
func (UnimplementedConversationalSearchServiceServer) CreateSession(context.Context, *CreateSessionRequest) (*Session, error)func (UnimplementedConversationalSearchServiceServer) DeleteConversation
func (UnimplementedConversationalSearchServiceServer) DeleteConversation(context.Context, *DeleteConversationRequest) (*emptypb.Empty, error)func (UnimplementedConversationalSearchServiceServer) DeleteSession
func (UnimplementedConversationalSearchServiceServer) DeleteSession(context.Context, *DeleteSessionRequest) (*emptypb.Empty, error)func (UnimplementedConversationalSearchServiceServer) GetAnswer
func (UnimplementedConversationalSearchServiceServer) GetAnswer(context.Context, *GetAnswerRequest) (*Answer, error)func (UnimplementedConversationalSearchServiceServer) GetConversation
func (UnimplementedConversationalSearchServiceServer) GetConversation(context.Context, *GetConversationRequest) (*Conversation, error)func (UnimplementedConversationalSearchServiceServer) GetSession
func (UnimplementedConversationalSearchServiceServer) GetSession(context.Context, *GetSessionRequest) (*Session, error)func (UnimplementedConversationalSearchServiceServer) ListConversations
func (UnimplementedConversationalSearchServiceServer) ListConversations(context.Context, *ListConversationsRequest) (*ListConversationsResponse, error)func (UnimplementedConversationalSearchServiceServer) ListSessions
func (UnimplementedConversationalSearchServiceServer) ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)func (UnimplementedConversationalSearchServiceServer) UpdateConversation
func (UnimplementedConversationalSearchServiceServer) UpdateConversation(context.Context, *UpdateConversationRequest) (*Conversation, error)func (UnimplementedConversationalSearchServiceServer) UpdateSession
func (UnimplementedConversationalSearchServiceServer) UpdateSession(context.Context, *UpdateSessionRequest) (*Session, error)UnimplementedDataStoreServiceServer
type UnimplementedDataStoreServiceServer struct {
}UnimplementedDataStoreServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedDataStoreServiceServer) CreateDataStore
func (UnimplementedDataStoreServiceServer) CreateDataStore(context.Context, *CreateDataStoreRequest) (*longrunningpb.Operation, error)func (UnimplementedDataStoreServiceServer) DeleteDataStore
func (UnimplementedDataStoreServiceServer) DeleteDataStore(context.Context, *DeleteDataStoreRequest) (*longrunningpb.Operation, error)func (UnimplementedDataStoreServiceServer) GetDataStore
func (UnimplementedDataStoreServiceServer) GetDataStore(context.Context, *GetDataStoreRequest) (*DataStore, error)func (UnimplementedDataStoreServiceServer) GetDocumentProcessingConfig
func (UnimplementedDataStoreServiceServer) GetDocumentProcessingConfig(context.Context, *GetDocumentProcessingConfigRequest) (*DocumentProcessingConfig, error)func (UnimplementedDataStoreServiceServer) ListDataStores
func (UnimplementedDataStoreServiceServer) ListDataStores(context.Context, *ListDataStoresRequest) (*ListDataStoresResponse, error)func (UnimplementedDataStoreServiceServer) UpdateDataStore
func (UnimplementedDataStoreServiceServer) UpdateDataStore(context.Context, *UpdateDataStoreRequest) (*DataStore, error)func (UnimplementedDataStoreServiceServer) UpdateDocumentProcessingConfig
func (UnimplementedDataStoreServiceServer) UpdateDocumentProcessingConfig(context.Context, *UpdateDocumentProcessingConfigRequest) (*DocumentProcessingConfig, error)UnimplementedDocumentServiceServer
type UnimplementedDocumentServiceServer struct {
}UnimplementedDocumentServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedDocumentServiceServer) BatchGetDocumentsMetadata
func (UnimplementedDocumentServiceServer) BatchGetDocumentsMetadata(context.Context, *BatchGetDocumentsMetadataRequest) (*BatchGetDocumentsMetadataResponse, error)func (UnimplementedDocumentServiceServer) CreateDocument
func (UnimplementedDocumentServiceServer) CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)func (UnimplementedDocumentServiceServer) DeleteDocument
func (UnimplementedDocumentServiceServer) DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)func (UnimplementedDocumentServiceServer) GetDocument
func (UnimplementedDocumentServiceServer) GetDocument(context.Context, *GetDocumentRequest) (*Document, error)func (UnimplementedDocumentServiceServer) GetProcessedDocument
func (UnimplementedDocumentServiceServer) GetProcessedDocument(context.Context, *GetProcessedDocumentRequest) (*ProcessedDocument, error)func (UnimplementedDocumentServiceServer) ImportDocuments
func (UnimplementedDocumentServiceServer) ImportDocuments(context.Context, *ImportDocumentsRequest) (*longrunningpb.Operation, error)func (UnimplementedDocumentServiceServer) ListDocuments
func (UnimplementedDocumentServiceServer) ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)func (UnimplementedDocumentServiceServer) PurgeDocuments
func (UnimplementedDocumentServiceServer) PurgeDocuments(context.Context, *PurgeDocumentsRequest) (*longrunningpb.Operation, error)func (UnimplementedDocumentServiceServer) UpdateDocument
func (UnimplementedDocumentServiceServer) UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)UnimplementedEngineServiceServer
type UnimplementedEngineServiceServer struct {
}UnimplementedEngineServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedEngineServiceServer) CreateEngine
func (UnimplementedEngineServiceServer) CreateEngine(context.Context, *CreateEngineRequest) (*longrunningpb.Operation, error)func (UnimplementedEngineServiceServer) DeleteEngine
func (UnimplementedEngineServiceServer) DeleteEngine(context.Context, *DeleteEngineRequest) (*longrunningpb.Operation, error)func (UnimplementedEngineServiceServer) GetEngine
func (UnimplementedEngineServiceServer) GetEngine(context.Context, *GetEngineRequest) (*Engine, error)func (UnimplementedEngineServiceServer) ListEngines
func (UnimplementedEngineServiceServer) ListEngines(context.Context, *ListEnginesRequest) (*ListEnginesResponse, error)func (UnimplementedEngineServiceServer) PauseEngine
func (UnimplementedEngineServiceServer) PauseEngine(context.Context, *PauseEngineRequest) (*Engine, error)func (UnimplementedEngineServiceServer) ResumeEngine
func (UnimplementedEngineServiceServer) ResumeEngine(context.Context, *ResumeEngineRequest) (*Engine, error)func (UnimplementedEngineServiceServer) TuneEngine
func (UnimplementedEngineServiceServer) TuneEngine(context.Context, *TuneEngineRequest) (*longrunningpb.Operation, error)func (UnimplementedEngineServiceServer) UpdateEngine
func (UnimplementedEngineServiceServer) UpdateEngine(context.Context, *UpdateEngineRequest) (*Engine, error)UnimplementedEstimateBillingServiceServer
type UnimplementedEstimateBillingServiceServer struct {
}UnimplementedEstimateBillingServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedEstimateBillingServiceServer) EstimateDataSize
func (UnimplementedEstimateBillingServiceServer) EstimateDataSize(context.Context, *EstimateDataSizeRequest) (*longrunningpb.Operation, error)UnimplementedEvaluationServiceServer
type UnimplementedEvaluationServiceServer struct {
}UnimplementedEvaluationServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedEvaluationServiceServer) CreateEvaluation
func (UnimplementedEvaluationServiceServer) CreateEvaluation(context.Context, *CreateEvaluationRequest) (*longrunningpb.Operation, error)func (UnimplementedEvaluationServiceServer) GetEvaluation
func (UnimplementedEvaluationServiceServer) GetEvaluation(context.Context, *GetEvaluationRequest) (*Evaluation, error)func (UnimplementedEvaluationServiceServer) ListEvaluationResults
func (UnimplementedEvaluationServiceServer) ListEvaluationResults(context.Context, *ListEvaluationResultsRequest) (*ListEvaluationResultsResponse, error)func (UnimplementedEvaluationServiceServer) ListEvaluations
func (UnimplementedEvaluationServiceServer) ListEvaluations(context.Context, *ListEvaluationsRequest) (*ListEvaluationsResponse, error)UnimplementedGroundedGenerationServiceServer
type UnimplementedGroundedGenerationServiceServer struct {
}UnimplementedGroundedGenerationServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedGroundedGenerationServiceServer) CheckGrounding
func (UnimplementedGroundedGenerationServiceServer) CheckGrounding(context.Context, *CheckGroundingRequest) (*CheckGroundingResponse, error)UnimplementedProjectServiceServer
type UnimplementedProjectServiceServer struct {
}UnimplementedProjectServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedProjectServiceServer) GetProject
func (UnimplementedProjectServiceServer) GetProject(context.Context, *GetProjectRequest) (*Project, error)func (UnimplementedProjectServiceServer) ProvisionProject
func (UnimplementedProjectServiceServer) ProvisionProject(context.Context, *ProvisionProjectRequest) (*longrunningpb.Operation, error)func (UnimplementedProjectServiceServer) ReportConsentChange
func (UnimplementedProjectServiceServer) ReportConsentChange(context.Context, *ReportConsentChangeRequest) (*Project, error)UnimplementedRankServiceServer
type UnimplementedRankServiceServer struct {
}UnimplementedRankServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedRankServiceServer) Rank
func (UnimplementedRankServiceServer) Rank(context.Context, *RankRequest) (*RankResponse, error)UnimplementedRecommendationServiceServer
type UnimplementedRecommendationServiceServer struct {
}UnimplementedRecommendationServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedRecommendationServiceServer) Recommend
func (UnimplementedRecommendationServiceServer) Recommend(context.Context, *RecommendRequest) (*RecommendResponse, error)UnimplementedSampleQueryServiceServer
type UnimplementedSampleQueryServiceServer struct {
}UnimplementedSampleQueryServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedSampleQueryServiceServer) CreateSampleQuery
func (UnimplementedSampleQueryServiceServer) CreateSampleQuery(context.Context, *CreateSampleQueryRequest) (*SampleQuery, error)func (UnimplementedSampleQueryServiceServer) DeleteSampleQuery
func (UnimplementedSampleQueryServiceServer) DeleteSampleQuery(context.Context, *DeleteSampleQueryRequest) (*emptypb.Empty, error)func (UnimplementedSampleQueryServiceServer) GetSampleQuery
func (UnimplementedSampleQueryServiceServer) GetSampleQuery(context.Context, *GetSampleQueryRequest) (*SampleQuery, error)func (UnimplementedSampleQueryServiceServer) ImportSampleQueries
func (UnimplementedSampleQueryServiceServer) ImportSampleQueries(context.Context, *ImportSampleQueriesRequest) (*longrunningpb.Operation, error)func (UnimplementedSampleQueryServiceServer) ListSampleQueries
func (UnimplementedSampleQueryServiceServer) ListSampleQueries(context.Context, *ListSampleQueriesRequest) (*ListSampleQueriesResponse, error)func (UnimplementedSampleQueryServiceServer) UpdateSampleQuery
func (UnimplementedSampleQueryServiceServer) UpdateSampleQuery(context.Context, *UpdateSampleQueryRequest) (*SampleQuery, error)UnimplementedSampleQuerySetServiceServer
type UnimplementedSampleQuerySetServiceServer struct {
}UnimplementedSampleQuerySetServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedSampleQuerySetServiceServer) CreateSampleQuerySet
func (UnimplementedSampleQuerySetServiceServer) CreateSampleQuerySet(context.Context, *CreateSampleQuerySetRequest) (*SampleQuerySet, error)func (UnimplementedSampleQuerySetServiceServer) DeleteSampleQuerySet
func (UnimplementedSampleQuerySetServiceServer) DeleteSampleQuerySet(context.Context, *DeleteSampleQuerySetRequest) (*emptypb.Empty, error)func (UnimplementedSampleQuerySetServiceServer) GetSampleQuerySet
func (UnimplementedSampleQuerySetServiceServer) GetSampleQuerySet(context.Context, *GetSampleQuerySetRequest) (*SampleQuerySet, error)func (UnimplementedSampleQuerySetServiceServer) ListSampleQuerySets
func (UnimplementedSampleQuerySetServiceServer) ListSampleQuerySets(context.Context, *ListSampleQuerySetsRequest) (*ListSampleQuerySetsResponse, error)func (UnimplementedSampleQuerySetServiceServer) UpdateSampleQuerySet
func (UnimplementedSampleQuerySetServiceServer) UpdateSampleQuerySet(context.Context, *UpdateSampleQuerySetRequest) (*SampleQuerySet, error)UnimplementedSchemaServiceServer
type UnimplementedSchemaServiceServer struct {
}UnimplementedSchemaServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedSchemaServiceServer) CreateSchema
func (UnimplementedSchemaServiceServer) CreateSchema(context.Context, *CreateSchemaRequest) (*longrunningpb.Operation, error)func (UnimplementedSchemaServiceServer) DeleteSchema
func (UnimplementedSchemaServiceServer) DeleteSchema(context.Context, *DeleteSchemaRequest) (*longrunningpb.Operation, error)func (UnimplementedSchemaServiceServer) GetSchema
func (UnimplementedSchemaServiceServer) GetSchema(context.Context, *GetSchemaRequest) (*Schema, error)func (UnimplementedSchemaServiceServer) ListSchemas
func (UnimplementedSchemaServiceServer) ListSchemas(context.Context, *ListSchemasRequest) (*ListSchemasResponse, error)func (UnimplementedSchemaServiceServer) UpdateSchema
func (UnimplementedSchemaServiceServer) UpdateSchema(context.Context, *UpdateSchemaRequest) (*longrunningpb.Operation, error)UnimplementedSearchServiceServer
type UnimplementedSearchServiceServer struct {
}UnimplementedSearchServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedSearchServiceServer) Search
func (UnimplementedSearchServiceServer) Search(context.Context, *SearchRequest) (*SearchResponse, error)UnimplementedSearchTuningServiceServer
type UnimplementedSearchTuningServiceServer struct {
}UnimplementedSearchTuningServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedSearchTuningServiceServer) ListCustomModels
func (UnimplementedSearchTuningServiceServer) ListCustomModels(context.Context, *ListCustomModelsRequest) (*ListCustomModelsResponse, error)func (UnimplementedSearchTuningServiceServer) TrainCustomModel
func (UnimplementedSearchTuningServiceServer) TrainCustomModel(context.Context, *TrainCustomModelRequest) (*longrunningpb.Operation, error)UnimplementedServingConfigServiceServer
type UnimplementedServingConfigServiceServer struct {
}UnimplementedServingConfigServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedServingConfigServiceServer) GetServingConfig
func (UnimplementedServingConfigServiceServer) GetServingConfig(context.Context, *GetServingConfigRequest) (*ServingConfig, error)func (UnimplementedServingConfigServiceServer) ListServingConfigs
func (UnimplementedServingConfigServiceServer) ListServingConfigs(context.Context, *ListServingConfigsRequest) (*ListServingConfigsResponse, error)func (UnimplementedServingConfigServiceServer) UpdateServingConfig
func (UnimplementedServingConfigServiceServer) UpdateServingConfig(context.Context, *UpdateServingConfigRequest) (*ServingConfig, error)UnimplementedSessionServiceServer
type UnimplementedSessionServiceServer struct {
}UnimplementedSessionServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedSessionServiceServer) CreateSession
func (UnimplementedSessionServiceServer) CreateSession(context.Context, *CreateSessionRequest) (*Session, error)func (UnimplementedSessionServiceServer) DeleteSession
func (UnimplementedSessionServiceServer) DeleteSession(context.Context, *DeleteSessionRequest) (*emptypb.Empty, error)func (UnimplementedSessionServiceServer) GetSession
func (UnimplementedSessionServiceServer) GetSession(context.Context, *GetSessionRequest) (*Session, error)func (UnimplementedSessionServiceServer) ListFiles
func (UnimplementedSessionServiceServer) ListFiles(context.Context, *ListFilesRequest) (*ListFilesResponse, error)func (UnimplementedSessionServiceServer) ListSessions
func (UnimplementedSessionServiceServer) ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)func (UnimplementedSessionServiceServer) UpdateSession
func (UnimplementedSessionServiceServer) UpdateSession(context.Context, *UpdateSessionRequest) (*Session, error)UnimplementedSiteSearchEngineServiceServer
type UnimplementedSiteSearchEngineServiceServer struct {
}UnimplementedSiteSearchEngineServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedSiteSearchEngineServiceServer) BatchCreateTargetSites
func (UnimplementedSiteSearchEngineServiceServer) BatchCreateTargetSites(context.Context, *BatchCreateTargetSitesRequest) (*longrunningpb.Operation, error)func (UnimplementedSiteSearchEngineServiceServer) BatchVerifyTargetSites
func (UnimplementedSiteSearchEngineServiceServer) BatchVerifyTargetSites(context.Context, *BatchVerifyTargetSitesRequest) (*longrunningpb.Operation, error)func (UnimplementedSiteSearchEngineServiceServer) CreateTargetSite
func (UnimplementedSiteSearchEngineServiceServer) CreateTargetSite(context.Context, *CreateTargetSiteRequest) (*longrunningpb.Operation, error)func (UnimplementedSiteSearchEngineServiceServer) DeleteTargetSite
func (UnimplementedSiteSearchEngineServiceServer) DeleteTargetSite(context.Context, *DeleteTargetSiteRequest) (*longrunningpb.Operation, error)func (UnimplementedSiteSearchEngineServiceServer) DisableAdvancedSiteSearch
func (UnimplementedSiteSearchEngineServiceServer) DisableAdvancedSiteSearch(context.Context, *DisableAdvancedSiteSearchRequest) (*longrunningpb.Operation, error)func (UnimplementedSiteSearchEngineServiceServer) EnableAdvancedSiteSearch
func (UnimplementedSiteSearchEngineServiceServer) EnableAdvancedSiteSearch(context.Context, *EnableAdvancedSiteSearchRequest) (*longrunningpb.Operation, error)func (UnimplementedSiteSearchEngineServiceServer) FetchDomainVerificationStatus
func (UnimplementedSiteSearchEngineServiceServer) FetchDomainVerificationStatus(context.Context, *FetchDomainVerificationStatusRequest) (*FetchDomainVerificationStatusResponse, error)func (UnimplementedSiteSearchEngineServiceServer) GetSiteSearchEngine
func (UnimplementedSiteSearchEngineServiceServer) GetSiteSearchEngine(context.Context, *GetSiteSearchEngineRequest) (*SiteSearchEngine, error)func (UnimplementedSiteSearchEngineServiceServer) GetTargetSite
func (UnimplementedSiteSearchEngineServiceServer) GetTargetSite(context.Context, *GetTargetSiteRequest) (*TargetSite, error)func (UnimplementedSiteSearchEngineServiceServer) GetUriPatternDocumentData
func (UnimplementedSiteSearchEngineServiceServer) GetUriPatternDocumentData(context.Context, *GetUriPatternDocumentDataRequest) (*GetUriPatternDocumentDataResponse, error)func (UnimplementedSiteSearchEngineServiceServer) ListTargetSites
func (UnimplementedSiteSearchEngineServiceServer) ListTargetSites(context.Context, *ListTargetSitesRequest) (*ListTargetSitesResponse, error)func (UnimplementedSiteSearchEngineServiceServer) RecrawlUris
func (UnimplementedSiteSearchEngineServiceServer) RecrawlUris(context.Context, *RecrawlUrisRequest) (*longrunningpb.Operation, error)func (UnimplementedSiteSearchEngineServiceServer) SetUriPatternDocumentData
func (UnimplementedSiteSearchEngineServiceServer) SetUriPatternDocumentData(context.Context, *SetUriPatternDocumentDataRequest) (*longrunningpb.Operation, error)func (UnimplementedSiteSearchEngineServiceServer) UpdateTargetSite
func (UnimplementedSiteSearchEngineServiceServer) UpdateTargetSite(context.Context, *UpdateTargetSiteRequest) (*longrunningpb.Operation, error)UnimplementedUserEventServiceServer
type UnimplementedUserEventServiceServer struct {
}UnimplementedUserEventServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedUserEventServiceServer) CollectUserEvent
func (UnimplementedUserEventServiceServer) CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)func (UnimplementedUserEventServiceServer) ImportUserEvents
func (UnimplementedUserEventServiceServer) ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunningpb.Operation, error)func (UnimplementedUserEventServiceServer) PurgeUserEvents
func (UnimplementedUserEventServiceServer) PurgeUserEvents(context.Context, *PurgeUserEventsRequest) (*longrunningpb.Operation, error)func (UnimplementedUserEventServiceServer) WriteUserEvent
func (UnimplementedUserEventServiceServer) WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)UnsafeAclConfigServiceServer
type UnsafeAclConfigServiceServer interface {
// contains filtered or unexported methods
}UnsafeAclConfigServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AclConfigServiceServer will result in compilation errors.
UnsafeChunkServiceServer
type UnsafeChunkServiceServer interface {
// contains filtered or unexported methods
}UnsafeChunkServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ChunkServiceServer will result in compilation errors.
UnsafeCompletionServiceServer
type UnsafeCompletionServiceServer interface {
// contains filtered or unexported methods
}UnsafeCompletionServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CompletionServiceServer will result in compilation errors.
UnsafeControlServiceServer
type UnsafeControlServiceServer interface {
// contains filtered or unexported methods
}UnsafeControlServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ControlServiceServer will result in compilation errors.
UnsafeConversationalSearchServiceServer
type UnsafeConversationalSearchServiceServer interface {
// contains filtered or unexported methods
}UnsafeConversationalSearchServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ConversationalSearchServiceServer will result in compilation errors.
UnsafeDataStoreServiceServer
type UnsafeDataStoreServiceServer interface {
// contains filtered or unexported methods
}UnsafeDataStoreServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DataStoreServiceServer will result in compilation errors.
UnsafeDocumentServiceServer
type UnsafeDocumentServiceServer interface {
// contains filtered or unexported methods
}UnsafeDocumentServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DocumentServiceServer will result in compilation errors.
UnsafeEngineServiceServer
type UnsafeEngineServiceServer interface {
// contains filtered or unexported methods
}UnsafeEngineServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EngineServiceServer will result in compilation errors.
UnsafeEstimateBillingServiceServer
type UnsafeEstimateBillingServiceServer interface {
// contains filtered or unexported methods
}UnsafeEstimateBillingServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EstimateBillingServiceServer will result in compilation errors.
UnsafeEvaluationServiceServer
type UnsafeEvaluationServiceServer interface {
// contains filtered or unexported methods
}UnsafeEvaluationServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EvaluationServiceServer will result in compilation errors.
UnsafeGroundedGenerationServiceServer
type UnsafeGroundedGenerationServiceServer interface {
// contains filtered or unexported methods
}UnsafeGroundedGenerationServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to GroundedGenerationServiceServer will result in compilation errors.
UnsafeProjectServiceServer
type UnsafeProjectServiceServer interface {
// contains filtered or unexported methods
}UnsafeProjectServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ProjectServiceServer will result in compilation errors.
UnsafeRankServiceServer
type UnsafeRankServiceServer interface {
// contains filtered or unexported methods
}UnsafeRankServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RankServiceServer will result in compilation errors.
UnsafeRecommendationServiceServer
type UnsafeRecommendationServiceServer interface {
// contains filtered or unexported methods
}UnsafeRecommendationServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RecommendationServiceServer will result in compilation errors.
UnsafeSampleQueryServiceServer
type UnsafeSampleQueryServiceServer interface {
// contains filtered or unexported methods
}UnsafeSampleQueryServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SampleQueryServiceServer will result in compilation errors.
UnsafeSampleQuerySetServiceServer
type UnsafeSampleQuerySetServiceServer interface {
// contains filtered or unexported methods
}UnsafeSampleQuerySetServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SampleQuerySetServiceServer will result in compilation errors.
UnsafeSchemaServiceServer
type UnsafeSchemaServiceServer interface {
// contains filtered or unexported methods
}UnsafeSchemaServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SchemaServiceServer will result in compilation errors.
UnsafeSearchServiceServer
type UnsafeSearchServiceServer interface {
// contains filtered or unexported methods
}UnsafeSearchServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SearchServiceServer will result in compilation errors.
UnsafeSearchTuningServiceServer
type UnsafeSearchTuningServiceServer interface {
// contains filtered or unexported methods
}UnsafeSearchTuningServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SearchTuningServiceServer will result in compilation errors.
UnsafeServingConfigServiceServer
type UnsafeServingConfigServiceServer interface {
// contains filtered or unexported methods
}UnsafeServingConfigServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ServingConfigServiceServer will result in compilation errors.
UnsafeSessionServiceServer
type UnsafeSessionServiceServer interface {
// contains filtered or unexported methods
}UnsafeSessionServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SessionServiceServer will result in compilation errors.
UnsafeSiteSearchEngineServiceServer
type UnsafeSiteSearchEngineServiceServer interface {
// contains filtered or unexported methods
}UnsafeSiteSearchEngineServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SiteSearchEngineServiceServer will result in compilation errors.
UnsafeUserEventServiceServer
type UnsafeUserEventServiceServer interface {
// contains filtered or unexported methods
}UnsafeUserEventServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to UserEventServiceServer will result in compilation errors.
UpdateAclConfigRequest
type UpdateAclConfigRequest struct {
AclConfig *AclConfig `protobuf:"bytes,1,opt,name=acl_config,json=aclConfig,proto3" json:"acl_config,omitempty"`
// contains filtered or unexported fields
}Request message for UpdateAclConfig method.
func (*UpdateAclConfigRequest) Descriptor
func (*UpdateAclConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateAclConfigRequest.ProtoReflect.Descriptor instead.
func (*UpdateAclConfigRequest) GetAclConfig
func (x *UpdateAclConfigRequest) GetAclConfig() *AclConfigfunc (*UpdateAclConfigRequest) ProtoMessage
func (*UpdateAclConfigRequest) ProtoMessage()func (*UpdateAclConfigRequest) ProtoReflect
func (x *UpdateAclConfigRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateAclConfigRequest) Reset
func (x *UpdateAclConfigRequest) Reset()func (*UpdateAclConfigRequest) String
func (x *UpdateAclConfigRequest) String() stringUpdateControlRequest
type UpdateControlRequest struct {
// Required. The Control to update.
Control *Control `protobuf:"bytes,1,opt,name=control,proto3" json:"control,omitempty"`
// Optional. Indicates which fields in the provided
// [Control][google.cloud.discoveryengine.v1alpha.Control] to update. The
// following are NOT supported:
//
// * [Control.name][google.cloud.discoveryengine.v1alpha.Control.name]
// * [Control.solution_type][google.cloud.discoveryengine.v1alpha.Control.solution_type]
//
// If not set or empty, all supported fields are updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request for UpdateControl method.
func (*UpdateControlRequest) Descriptor
func (*UpdateControlRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateControlRequest.ProtoReflect.Descriptor instead.
func (*UpdateControlRequest) GetControl
func (x *UpdateControlRequest) GetControl() *Controlfunc (*UpdateControlRequest) GetUpdateMask
func (x *UpdateControlRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateControlRequest) ProtoMessage
func (*UpdateControlRequest) ProtoMessage()func (*UpdateControlRequest) ProtoReflect
func (x *UpdateControlRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateControlRequest) Reset
func (x *UpdateControlRequest) Reset()func (*UpdateControlRequest) String
func (x *UpdateControlRequest) String() stringUpdateConversationRequest
type UpdateConversationRequest struct {
// Required. The Conversation to update.
Conversation *Conversation `protobuf:"bytes,1,opt,name=conversation,proto3" json:"conversation,omitempty"`
// Indicates which fields in the provided
// [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
// update. The following are NOT supported:
//
// * [Conversation.name][google.cloud.discoveryengine.v1alpha.Conversation.name]
//
// If not set or empty, all supported fields are updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request for UpdateConversation method.
func (*UpdateConversationRequest) Descriptor
func (*UpdateConversationRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateConversationRequest.ProtoReflect.Descriptor instead.
func (*UpdateConversationRequest) GetConversation
func (x *UpdateConversationRequest) GetConversation() *Conversationfunc (*UpdateConversationRequest) GetUpdateMask
func (x *UpdateConversationRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateConversationRequest) ProtoMessage
func (*UpdateConversationRequest) ProtoMessage()func (*UpdateConversationRequest) ProtoReflect
func (x *UpdateConversationRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateConversationRequest) Reset
func (x *UpdateConversationRequest) Reset()func (*UpdateConversationRequest) String
func (x *UpdateConversationRequest) String() stringUpdateDataStoreRequest
type UpdateDataStoreRequest struct {
// Required. The [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]
// to update.
//
// If the caller does not have permission to update the
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], regardless of
// whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] to
// update does not exist, a NOT_FOUND error is returned.
DataStore *DataStore `protobuf:"bytes,1,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// Indicates which fields in the provided
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] to update.
//
// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
// is returned.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDataStore] method.
func (*UpdateDataStoreRequest) Descriptor
func (*UpdateDataStoreRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateDataStoreRequest.ProtoReflect.Descriptor instead.
func (*UpdateDataStoreRequest) GetDataStore
func (x *UpdateDataStoreRequest) GetDataStore() *DataStorefunc (*UpdateDataStoreRequest) GetUpdateMask
func (x *UpdateDataStoreRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateDataStoreRequest) ProtoMessage
func (*UpdateDataStoreRequest) ProtoMessage()func (*UpdateDataStoreRequest) ProtoReflect
func (x *UpdateDataStoreRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateDataStoreRequest) Reset
func (x *UpdateDataStoreRequest) Reset()func (*UpdateDataStoreRequest) String
func (x *UpdateDataStoreRequest) String() stringUpdateDocumentProcessingConfigRequest
type UpdateDocumentProcessingConfigRequest struct {
// Required. The
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
// to update.
//
// If the caller does not have permission to update the
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig],
// then a PERMISSION_DENIED error is returned.
//
// If the
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
// to update does not exist, a NOT_FOUND error is returned.
DocumentProcessingConfig *DocumentProcessingConfig `protobuf:"bytes,1,opt,name=document_processing_config,json=documentProcessingConfig,proto3" json:"document_processing_config,omitempty"`
// Indicates which fields in the provided
// [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]
// to update. The following are the only supported fields:
//
// * [DocumentProcessingConfig.ocr_config][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ocr_config]
//
// If not set, all supported fields are updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request for [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] method.
func (*UpdateDocumentProcessingConfigRequest) Descriptor
func (*UpdateDocumentProcessingConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateDocumentProcessingConfigRequest.ProtoReflect.Descriptor instead.
func (*UpdateDocumentProcessingConfigRequest) GetDocumentProcessingConfig
func (x *UpdateDocumentProcessingConfigRequest) GetDocumentProcessingConfig() *DocumentProcessingConfigfunc (*UpdateDocumentProcessingConfigRequest) GetUpdateMask
func (x *UpdateDocumentProcessingConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateDocumentProcessingConfigRequest) ProtoMessage
func (*UpdateDocumentProcessingConfigRequest) ProtoMessage()func (*UpdateDocumentProcessingConfigRequest) ProtoReflect
func (x *UpdateDocumentProcessingConfigRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateDocumentProcessingConfigRequest) Reset
func (x *UpdateDocumentProcessingConfigRequest) Reset()func (*UpdateDocumentProcessingConfigRequest) String
func (x *UpdateDocumentProcessingConfigRequest) String() stringUpdateDocumentRequest
type UpdateDocumentRequest struct {
// Required. The document to update/create.
//
// If the caller does not have permission to update the
// [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
// whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// If the [Document][google.cloud.discoveryengine.v1alpha.Document] to update
// does not exist and
// [allow_missing][google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest.allow_missing]
// is not set, a `NOT_FOUND` error is returned.
Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// If set to `true` and the
// [Document][google.cloud.discoveryengine.v1alpha.Document] is not found, a
// new [Document][google.cloud.discoveryengine.v1alpha.Document] is be
// created.
AllowMissing bool `protobuf:"varint,2,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
// Indicates which fields in the provided imported 'document' to update. If
// not set, by default updates all fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1alpha.DocumentService.UpdateDocument] method.
func (*UpdateDocumentRequest) Descriptor
func (*UpdateDocumentRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateDocumentRequest.ProtoReflect.Descriptor instead.
func (*UpdateDocumentRequest) GetAllowMissing
func (x *UpdateDocumentRequest) GetAllowMissing() boolfunc (*UpdateDocumentRequest) GetDocument
func (x *UpdateDocumentRequest) GetDocument() *Documentfunc (*UpdateDocumentRequest) GetUpdateMask
func (x *UpdateDocumentRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateDocumentRequest) ProtoMessage
func (*UpdateDocumentRequest) ProtoMessage()func (*UpdateDocumentRequest) ProtoReflect
func (x *UpdateDocumentRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateDocumentRequest) Reset
func (x *UpdateDocumentRequest) Reset()func (*UpdateDocumentRequest) String
func (x *UpdateDocumentRequest) String() stringUpdateEngineRequest
type UpdateEngineRequest struct {
// Required. The [Engine][google.cloud.discoveryengine.v1alpha.Engine] to
// update.
//
// If the caller does not have permission to update the
// [Engine][google.cloud.discoveryengine.v1alpha.Engine], regardless of
// whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the [Engine][google.cloud.discoveryengine.v1alpha.Engine] to update does
// not exist, a NOT_FOUND error is returned.
Engine *Engine `protobuf:"bytes,1,opt,name=engine,proto3" json:"engine,omitempty"`
// Indicates which fields in the provided
// [Engine][google.cloud.discoveryengine.v1alpha.Engine] to update.
//
// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
// is returned.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [EngineService.UpdateEngine][google.cloud.discoveryengine.v1alpha.EngineService.UpdateEngine] method.
func (*UpdateEngineRequest) Descriptor
func (*UpdateEngineRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateEngineRequest.ProtoReflect.Descriptor instead.
func (*UpdateEngineRequest) GetEngine
func (x *UpdateEngineRequest) GetEngine() *Enginefunc (*UpdateEngineRequest) GetUpdateMask
func (x *UpdateEngineRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateEngineRequest) ProtoMessage
func (*UpdateEngineRequest) ProtoMessage()func (*UpdateEngineRequest) ProtoReflect
func (x *UpdateEngineRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateEngineRequest) Reset
func (x *UpdateEngineRequest) Reset()func (*UpdateEngineRequest) String
func (x *UpdateEngineRequest) String() stringUpdateSampleQueryRequest
type UpdateSampleQueryRequest struct {
// Required. The simple query to update.
//
// If the caller does not have permission to update the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
// of whether or not it exists, a `PERMISSION_DENIED` error is returned.
//
// If the [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] to
// update does not exist a `NOT_FOUND` error is returned.
SampleQuery *SampleQuery `protobuf:"bytes,1,opt,name=sample_query,json=sampleQuery,proto3" json:"sample_query,omitempty"`
// Indicates which fields in the provided imported 'simple query' to update.
// If not set, will by default update all fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.UpdateSampleQuery] method.
func (*UpdateSampleQueryRequest) Descriptor
func (*UpdateSampleQueryRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateSampleQueryRequest.ProtoReflect.Descriptor instead.
func (*UpdateSampleQueryRequest) GetSampleQuery
func (x *UpdateSampleQueryRequest) GetSampleQuery() *SampleQueryfunc (*UpdateSampleQueryRequest) GetUpdateMask
func (x *UpdateSampleQueryRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateSampleQueryRequest) ProtoMessage
func (*UpdateSampleQueryRequest) ProtoMessage()func (*UpdateSampleQueryRequest) ProtoReflect
func (x *UpdateSampleQueryRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateSampleQueryRequest) Reset
func (x *UpdateSampleQueryRequest) Reset()func (*UpdateSampleQueryRequest) String
func (x *UpdateSampleQueryRequest) String() stringUpdateSampleQuerySetRequest
type UpdateSampleQuerySetRequest struct {
// Required. The sample query set to update.
//
// If the caller does not have permission to update the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
// regardless of whether or not it exists, a `PERMISSION_DENIED` error is
// returned.
//
// If the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] to
// update does not exist a `NOT_FOUND` error is returned.
SampleQuerySet *SampleQuerySet `protobuf:"bytes,1,opt,name=sample_query_set,json=sampleQuerySet,proto3" json:"sample_query_set,omitempty"`
// Indicates which fields in the provided imported 'sample query set' to
// update. If not set, will by default update all fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.UpdateSampleQuerySet] method.
func (*UpdateSampleQuerySetRequest) Descriptor
func (*UpdateSampleQuerySetRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateSampleQuerySetRequest.ProtoReflect.Descriptor instead.
func (*UpdateSampleQuerySetRequest) GetSampleQuerySet
func (x *UpdateSampleQuerySetRequest) GetSampleQuerySet() *SampleQuerySetfunc (*UpdateSampleQuerySetRequest) GetUpdateMask
func (x *UpdateSampleQuerySetRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateSampleQuerySetRequest) ProtoMessage
func (*UpdateSampleQuerySetRequest) ProtoMessage()func (*UpdateSampleQuerySetRequest) ProtoReflect
func (x *UpdateSampleQuerySetRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateSampleQuerySetRequest) Reset
func (x *UpdateSampleQuerySetRequest) Reset()func (*UpdateSampleQuerySetRequest) String
func (x *UpdateSampleQuerySetRequest) String() stringUpdateSchemaMetadata
type UpdateSchemaMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata for UpdateSchema LRO.
func (*UpdateSchemaMetadata) Descriptor
func (*UpdateSchemaMetadata) Descriptor() ([]byte, []int)Deprecated: Use UpdateSchemaMetadata.ProtoReflect.Descriptor instead.
func (*UpdateSchemaMetadata) GetCreateTime
func (x *UpdateSchemaMetadata) GetCreateTime() *timestamppb.Timestampfunc (*UpdateSchemaMetadata) GetUpdateTime
func (x *UpdateSchemaMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*UpdateSchemaMetadata) ProtoMessage
func (*UpdateSchemaMetadata) ProtoMessage()func (*UpdateSchemaMetadata) ProtoReflect
func (x *UpdateSchemaMetadata) ProtoReflect() protoreflect.Messagefunc (*UpdateSchemaMetadata) Reset
func (x *UpdateSchemaMetadata) Reset()func (*UpdateSchemaMetadata) String
func (x *UpdateSchemaMetadata) String() stringUpdateSchemaRequest
type UpdateSchemaRequest struct {
// Required. The [Schema][google.cloud.discoveryengine.v1alpha.Schema] to
// update.
Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`
// If set to true, and the
// [Schema][google.cloud.discoveryengine.v1alpha.Schema] is not found, a new
// [Schema][google.cloud.discoveryengine.v1alpha.Schema] is created. In this
// situation, `update_mask` is ignored.
AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
// contains filtered or unexported fields
}Request message for [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1alpha.SchemaService.UpdateSchema] method.
func (*UpdateSchemaRequest) Descriptor
func (*UpdateSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateSchemaRequest.ProtoReflect.Descriptor instead.
func (*UpdateSchemaRequest) GetAllowMissing
func (x *UpdateSchemaRequest) GetAllowMissing() boolfunc (*UpdateSchemaRequest) GetSchema
func (x *UpdateSchemaRequest) GetSchema() *Schemafunc (*UpdateSchemaRequest) ProtoMessage
func (*UpdateSchemaRequest) ProtoMessage()func (*UpdateSchemaRequest) ProtoReflect
func (x *UpdateSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateSchemaRequest) Reset
func (x *UpdateSchemaRequest) Reset()func (*UpdateSchemaRequest) String
func (x *UpdateSchemaRequest) String() stringUpdateServingConfigRequest
type UpdateServingConfigRequest struct {
// Required. The ServingConfig to update.
ServingConfig *ServingConfig `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
// Indicates which fields in the provided
// [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] to
// update. The following are NOT supported:
//
// * [ServingConfig.name][google.cloud.discoveryengine.v1alpha.ServingConfig.name]
//
// If not set, all supported fields are updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request for UpdateServingConfig method.
func (*UpdateServingConfigRequest) Descriptor
func (*UpdateServingConfigRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateServingConfigRequest.ProtoReflect.Descriptor instead.
func (*UpdateServingConfigRequest) GetServingConfig
func (x *UpdateServingConfigRequest) GetServingConfig() *ServingConfigfunc (*UpdateServingConfigRequest) GetUpdateMask
func (x *UpdateServingConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateServingConfigRequest) ProtoMessage
func (*UpdateServingConfigRequest) ProtoMessage()func (*UpdateServingConfigRequest) ProtoReflect
func (x *UpdateServingConfigRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateServingConfigRequest) Reset
func (x *UpdateServingConfigRequest) Reset()func (*UpdateServingConfigRequest) String
func (x *UpdateServingConfigRequest) String() stringUpdateSessionRequest
type UpdateSessionRequest struct {
// Required. The Session to update.
Session *Session `protobuf:"bytes,1,opt,name=session,proto3" json:"session,omitempty"`
// Indicates which fields in the provided
// [Session][google.cloud.discoveryengine.v1alpha.Session] to update. The
// following are NOT supported:
//
// * [Session.name][google.cloud.discoveryengine.v1alpha.Session.name]
//
// If not set or empty, all supported fields are updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request for UpdateSession method.
func (*UpdateSessionRequest) Descriptor
func (*UpdateSessionRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateSessionRequest.ProtoReflect.Descriptor instead.
func (*UpdateSessionRequest) GetSession
func (x *UpdateSessionRequest) GetSession() *Sessionfunc (*UpdateSessionRequest) GetUpdateMask
func (x *UpdateSessionRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateSessionRequest) ProtoMessage
func (*UpdateSessionRequest) ProtoMessage()func (*UpdateSessionRequest) ProtoReflect
func (x *UpdateSessionRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateSessionRequest) Reset
func (x *UpdateSessionRequest) Reset()func (*UpdateSessionRequest) String
func (x *UpdateSessionRequest) String() stringUpdateTargetSiteMetadata
type UpdateTargetSiteMetadata struct {
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Operation last update time. If the operation is done, this is also the
// finish time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}Metadata related to the progress of the [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite] operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*UpdateTargetSiteMetadata) Descriptor
func (*UpdateTargetSiteMetadata) Descriptor() ([]byte, []int)Deprecated: Use UpdateTargetSiteMetadata.ProtoReflect.Descriptor instead.
func (*UpdateTargetSiteMetadata) GetCreateTime
func (x *UpdateTargetSiteMetadata) GetCreateTime() *timestamppb.Timestampfunc (*UpdateTargetSiteMetadata) GetUpdateTime
func (x *UpdateTargetSiteMetadata) GetUpdateTime() *timestamppb.Timestampfunc (*UpdateTargetSiteMetadata) ProtoMessage
func (*UpdateTargetSiteMetadata) ProtoMessage()func (*UpdateTargetSiteMetadata) ProtoReflect
func (x *UpdateTargetSiteMetadata) ProtoReflect() protoreflect.Messagefunc (*UpdateTargetSiteMetadata) Reset
func (x *UpdateTargetSiteMetadata) Reset()func (*UpdateTargetSiteMetadata) String
func (x *UpdateTargetSiteMetadata) String() stringUpdateTargetSiteRequest
type UpdateTargetSiteRequest struct {
// Required. The target site to update.
// If the caller does not have permission to update the
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], regardless
// of whether or not it exists, a PERMISSION_DENIED error is returned.
//
// If the [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] to
// update does not exist, a NOT_FOUND error is returned.
TargetSite *TargetSite `protobuf:"bytes,1,opt,name=target_site,json=targetSite,proto3" json:"target_site,omitempty"`
// contains filtered or unexported fields
}Request message for [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite] method.
func (*UpdateTargetSiteRequest) Descriptor
func (*UpdateTargetSiteRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateTargetSiteRequest.ProtoReflect.Descriptor instead.
func (*UpdateTargetSiteRequest) GetTargetSite
func (x *UpdateTargetSiteRequest) GetTargetSite() *TargetSitefunc (*UpdateTargetSiteRequest) ProtoMessage
func (*UpdateTargetSiteRequest) ProtoMessage()func (*UpdateTargetSiteRequest) ProtoReflect
func (x *UpdateTargetSiteRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateTargetSiteRequest) Reset
func (x *UpdateTargetSiteRequest) Reset()func (*UpdateTargetSiteRequest) String
func (x *UpdateTargetSiteRequest) String() stringUserEvent
type UserEvent struct {
// Required. User event type. Allowed values are:
//
// Generic values:
//
// * `search`: Search for Documents.
// * `view-item`: Detailed page view of a Document.
// * `view-item-list`: View of a panel or ordered list of Documents.
// * `view-home-page`: View of the home page.
// * `view-category-page`: View of a category page, e.g. Home > Men > Jeans
//
// Retail-related values:
//
// * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping
// * `purchase`: Purchase an item(s)
//
// Media-related values:
//
// * `media-play`: Start/resume watching a video, playing a song, etc.
// * `media-complete`: Finished or stopped midway through a video, song, etc.
EventType string `protobuf:"bytes,1,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
// Required. A unique identifier for tracking visitors.
//
// For example, this could be implemented with an HTTP cookie, which should be
// able to uniquely identify a visitor on a single device. This unique
// identifier should not change if the visitor log in/out of the website.
//
// Do not set the field to the same fixed ID for different users. This mixes
// the event history of those users together, which results in degraded model
// quality.
//
// The field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
//
// The field should not contain PII or user-data. We recommend to use Google
// Analytics [Client
// ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
// for this field.
UserPseudoId string `protobuf:"bytes,2,opt,name=user_pseudo_id,json=userPseudoId,proto3" json:"user_pseudo_id,omitempty"`
// The [Engine][google.cloud.discoveryengine.v1alpha.Engine] resource name, in
// the form of
// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
//
// Optional. Only required for
// [Engine][google.cloud.discoveryengine.v1alpha.Engine] produced user events.
// For example, user events from blended search.
Engine string `protobuf:"bytes,19,opt,name=engine,proto3" json:"engine,omitempty"`
// The [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] resource
// full name, of the form
// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
//
// Optional. Only required for user events whose data store can't by
// determined by
// [UserEvent.engine][google.cloud.discoveryengine.v1alpha.UserEvent.engine]
// or
// [UserEvent.documents][google.cloud.discoveryengine.v1alpha.UserEvent.documents].
// If data store is set in the parent of write/import/collect user event
// requests, this field can be omitted.
DataStore string `protobuf:"bytes,20,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// Only required for
// [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents]
// method. Timestamp of when the user event happened.
EventTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
// Information about the end user.
UserInfo *UserInfo `protobuf:"bytes,4,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
// Should set to true if the request is made directly from the end user, in
// which case the
// [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1alpha.UserInfo.user_agent]
// can be populated from the HTTP request.
//
// This flag should be set only if the API request is made directly from the
// end user such as a mobile app (and not if a gateway or a server is
// processing and pushing the user events).
//
// This should not be set when using the JavaScript tag in
// [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent].
DirectUserRequest bool `protobuf:"varint,5,opt,name=direct_user_request,json=directUserRequest,proto3" json:"direct_user_request,omitempty"`
// A unique identifier for tracking a visitor session with a length limit of
// 128 bytes. A session is an aggregation of an end user behavior in a time
// span.
//
// A general guideline to populate the session_id:
//
// 1. If user has no activity for 30 min, a new session_id should be assigned.
// 2. The session_id should be unique across users, suggest use uuid or add
// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id]
// as prefix.
SessionId string `protobuf:"bytes,6,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// Page metadata such as categories and other critical information for certain
// event types such as `view-category-page`.
PageInfo *PageInfo `protobuf:"bytes,7,opt,name=page_info,json=pageInfo,proto3" json:"page_info,omitempty"`
// Token to attribute an API response to user action(s) to trigger the event.
//
// Highly recommended for user events that are the result of
// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
// This field enables accurate attribution of recommendation model
// performance.
//
// The value must be one of:
//
// * [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token] for events that are the result of
// [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
// * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1alpha.SearchResponse.attribution_token] for events that are the result of
// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
//
// This token enables us to accurately attribute page view or conversion
// completion back to the event and the particular predict response containing
// this clicked/purchased product. If user clicks on product K in the
// recommendation results, pass
// [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token]
// as a URL parameter to product K's page. When recording events on product
// K's page, log the
// [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token]
// to this field.
AttributionToken string `protobuf:"bytes,8,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
// The filter syntax consists of an expression language for constructing a
// predicate from one or more fields of the documents being filtered.
//
// One example is for `search` events, the associated
// [SearchRequest][google.cloud.discoveryengine.v1alpha.SearchRequest] may
// contain a filter expression in
// [SearchRequest.filter][google.cloud.discoveryengine.v1alpha.SearchRequest.filter]
// conforming to https://google.aip.dev/160#filtering.
//
// Similarly, for `view-item-list` events that are generated from a
// [RecommendRequest][google.cloud.discoveryengine.v1alpha.RecommendRequest],
// this field may be populated directly from
// [RecommendRequest.filter][google.cloud.discoveryengine.v1alpha.RecommendRequest.filter]
// conforming to https://google.aip.dev/160#filtering.
//
// The value must be a UTF-8 encoded string with a length limit of 1,000
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
Filter string `protobuf:"bytes,9,opt,name=filter,proto3" json:"filter,omitempty"`
// List of [Document][google.cloud.discoveryengine.v1alpha.Document]s
// associated with this user event.
//
// This field is optional except for the following event types:
//
// * `view-item`
// * `add-to-cart`
// * `purchase`
// * `media-play`
// * `media-complete`
//
// In a `search` event, this field represents the documents returned to the
// end user on the current page (the end user may have not finished browsing
// the whole page yet). When a new page is returned to the end user, after
// pagination/filtering/ordering even for the same query, a new `search` event
// with different
// [UserEvent.documents][google.cloud.discoveryengine.v1alpha.UserEvent.documents]
// is desired.
Documents []*DocumentInfo `protobuf:"bytes,10,rep,name=documents,proto3" json:"documents,omitempty"`
// Panel metadata associated with this user event.
Panel *PanelInfo `protobuf:"bytes,11,opt,name=panel,proto3" json:"panel,omitempty"`
// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
// details related to the event.
//
// This field should be set for `search` event.
SearchInfo *SearchInfo `protobuf:"bytes,12,opt,name=search_info,json=searchInfo,proto3" json:"search_info,omitempty"`
// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery]
// details related to the event.
//
// This field should be set for `search` event when autocomplete function is
// enabled and the user clicks a suggestion for search.
CompletionInfo *CompletionInfo `protobuf:"bytes,13,opt,name=completion_info,json=completionInfo,proto3" json:"completion_info,omitempty"`
// The transaction metadata (if any) associated with this user event.
TransactionInfo *TransactionInfo `protobuf:"bytes,14,opt,name=transaction_info,json=transactionInfo,proto3" json:"transaction_info,omitempty"`
// A list of identifiers for the independent experiment groups this user event
// belongs to. This is used to distinguish between user events associated with
// different experiment setups.
TagIds []string `protobuf:"bytes,15,rep,name=tag_ids,json=tagIds,proto3" json:"tag_ids,omitempty"`
// The promotion IDs if this is an event associated with promotions.
// Currently, this field is restricted to at most one ID.
PromotionIds []string `protobuf:"bytes,16,rep,name=promotion_ids,json=promotionIds,proto3" json:"promotion_ids,omitempty"`
// Extra user event features to include in the recommendation model.
// These attributes must NOT contain data that needs to be parsed or processed
// further, e.g. JSON or other encodings.
//
// If you provide custom attributes for ingested user events, also include
// them in the user events that you associate with prediction requests. Custom
// attribute formatting must be consistent between imported events and events
// provided with prediction requests. This lets the Discovery Engine API use
// those custom attributes when training models and serving predictions, which
// helps improve recommendation quality.
//
// This field needs to pass all below criteria, otherwise an
// `INVALID_ARGUMENT` error is returned:
//
// - The key must be a UTF-8 encoded string with a length limit of 5,000
// characters.
// - For text attributes, at most 400 values are allowed. Empty values are not
// allowed. Each value must be a UTF-8 encoded string with a length limit of
// 256 characters.
// - For number attributes, at most 400 values are allowed.
//
// For product recommendations, an example of extra user information is
// `traffic_channel`, which is how a user arrives at the site. Users can
// arrive
// at the site by coming to the site directly, coming through Google
// search, or in other ways.
Attributes map[string]*CustomAttribute `protobuf:"bytes,17,rep,name=attributes,proto3" json:"attributes,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Media-specific info.
MediaInfo *MediaInfo `protobuf:"bytes,18,opt,name=media_info,json=mediaInfo,proto3" json:"media_info,omitempty"`
// contains filtered or unexported fields
}UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
func (*UserEvent) Descriptor
Deprecated: Use UserEvent.ProtoReflect.Descriptor instead.
func (*UserEvent) GetAttributes
func (x *UserEvent) GetAttributes() map[string]*CustomAttributefunc (*UserEvent) GetAttributionToken
func (*UserEvent) GetCompletionInfo
func (x *UserEvent) GetCompletionInfo() *CompletionInfofunc (*UserEvent) GetDataStore
func (*UserEvent) GetDirectUserRequest
func (*UserEvent) GetDocuments
func (x *UserEvent) GetDocuments() []*DocumentInfofunc (*UserEvent) GetEngine
func (*UserEvent) GetEventTime
func (x *UserEvent) GetEventTime() *timestamppb.Timestampfunc (*UserEvent) GetEventType
func (*UserEvent) GetFilter
func (*UserEvent) GetMediaInfo
func (*UserEvent) GetPageInfo
func (*UserEvent) GetPanel
func (*UserEvent) GetPromotionIds
func (*UserEvent) GetSearchInfo
func (x *UserEvent) GetSearchInfo() *SearchInfofunc (*UserEvent) GetSessionId
func (*UserEvent) GetTagIds
func (*UserEvent) GetTransactionInfo
func (x *UserEvent) GetTransactionInfo() *TransactionInfofunc (*UserEvent) GetUserInfo
func (*UserEvent) GetUserPseudoId
func (*UserEvent) ProtoMessage
func (*UserEvent) ProtoMessage()func (*UserEvent) ProtoReflect
func (x *UserEvent) ProtoReflect() protoreflect.Messagefunc (*UserEvent) Reset
func (x *UserEvent) Reset()func (*UserEvent) String
UserEventServiceClient
type UserEventServiceClient interface {
// Writes a single user event.
WriteUserEvent(ctx context.Context, in *WriteUserEventRequest, opts ...grpc.CallOption) (*UserEvent, error)
// Writes a single user event from the browser. This uses a GET request to
// due to browser restriction of POST-ing to a third-party domain.
//
// This method is used only by the Discovery Engine API JavaScript pixel and
// Google Tag Manager. Users should not call this method directly.
CollectUserEvent(ctx context.Context, in *CollectUserEventRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, error)
// Deletes permanently all user events specified by the filter provided.
// Depending on the number of events specified by the filter, this operation
// could take hours or days to complete. To test a filter, use the list
// command first.
PurgeUserEvents(ctx context.Context, in *PurgeUserEventsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Bulk import of user events. Request processing might be
// synchronous. Events that already exist are skipped.
// Use this method for backfilling historical user events.
//
// Operation.response is of type ImportResponse. Note that it is
// possible for a subset of the items to be successfully inserted.
// Operation.metadata is of type ImportMetadata.
ImportUserEvents(ctx context.Context, in *ImportUserEventsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}UserEventServiceClient is the client API for UserEventService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewUserEventServiceClient
func NewUserEventServiceClient(cc grpc.ClientConnInterface) UserEventServiceClientUserEventServiceServer
type UserEventServiceServer interface {
// Writes a single user event.
WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)
// Writes a single user event from the browser. This uses a GET request to
// due to browser restriction of POST-ing to a third-party domain.
//
// This method is used only by the Discovery Engine API JavaScript pixel and
// Google Tag Manager. Users should not call this method directly.
CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)
// Deletes permanently all user events specified by the filter provided.
// Depending on the number of events specified by the filter, this operation
// could take hours or days to complete. To test a filter, use the list
// command first.
PurgeUserEvents(context.Context, *PurgeUserEventsRequest) (*longrunningpb.Operation, error)
// Bulk import of user events. Request processing might be
// synchronous. Events that already exist are skipped.
// Use this method for backfilling historical user events.
//
// Operation.response is of type ImportResponse. Note that it is
// possible for a subset of the items to be successfully inserted.
// Operation.metadata is of type ImportMetadata.
ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunningpb.Operation, error)
}UserEventServiceServer is the server API for UserEventService service. All implementations should embed UnimplementedUserEventServiceServer for forward compatibility
UserInfo
type UserInfo struct {
// Highly recommended for logged-in users. Unique identifier for logged-in
// user, such as a user name. Don't set for anonymous users.
//
// Always use a hashed value for this ID.
//
// Don't set the field to the same fixed ID for different users. This mixes
// the event history of those users together, which results in degraded
// model quality.
//
// The field must be a UTF-8 encoded string with a length limit of 128
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
// User agent as included in the HTTP header.
//
// The field must be a UTF-8 encoded string with a length limit of 1,000
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
//
// This should not be set when using the client side event reporting with
// GTM or JavaScript tag in
// [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent]
// or if
// [UserEvent.direct_user_request][google.cloud.discoveryengine.v1alpha.UserEvent.direct_user_request]
// is set.
UserAgent string `protobuf:"bytes,2,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
// contains filtered or unexported fields
}Information of an end user.
func (*UserInfo) Descriptor
Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.
func (*UserInfo) GetUserAgent
func (*UserInfo) GetUserId
func (*UserInfo) ProtoMessage
func (*UserInfo) ProtoMessage()func (*UserInfo) ProtoReflect
func (x *UserInfo) ProtoReflect() protoreflect.Messagefunc (*UserInfo) Reset
func (x *UserInfo) Reset()func (*UserInfo) String
VideoCharacteristics
type VideoCharacteristics struct {
// Output only. Video width in pixels.
Width int32 `protobuf:"varint,1,opt,name=width,proto3" json:"width,omitempty"`
// Output only. Video height in pixels.
Height int32 `protobuf:"varint,2,opt,name=height,proto3" json:"height,omitempty"`
// Output only. Video duration.
Duration *durationpb.Duration `protobuf:"bytes,3,opt,name=duration,proto3" json:"duration,omitempty"`
// Output only. Frame rate (frames per second).
FrameRate float64 `protobuf:"fixed64,4,opt,name=frame_rate,json=frameRate,proto3" json:"frame_rate,omitempty"`
// Output only. Audio codecs used in the video.
AudioCodecs []string `protobuf:"bytes,5,rep,name=audio_codecs,json=audioCodecs,proto3" json:"audio_codecs,omitempty"`
// Output only. Video codecs used in the video.
VideoCodecs []string `protobuf:"bytes,6,rep,name=video_codecs,json=videoCodecs,proto3" json:"video_codecs,omitempty"`
// Output only. Bitrate of the video in kbps.
VideoBitrateKbps int32 `protobuf:"varint,7,opt,name=video_bitrate_kbps,json=videoBitrateKbps,proto3" json:"video_bitrate_kbps,omitempty"`
// Output only. Bitrate of the audio in kbps.
AudioBitrateKbps int32 `protobuf:"varint,8,opt,name=audio_bitrate_kbps,json=audioBitrateKbps,proto3" json:"audio_bitrate_kbps,omitempty"`
// contains filtered or unexported fields
}Standard characteristics of a video media view.
func (*VideoCharacteristics) Descriptor
func (*VideoCharacteristics) Descriptor() ([]byte, []int)Deprecated: Use VideoCharacteristics.ProtoReflect.Descriptor instead.
func (*VideoCharacteristics) GetAudioBitrateKbps
func (x *VideoCharacteristics) GetAudioBitrateKbps() int32func (*VideoCharacteristics) GetAudioCodecs
func (x *VideoCharacteristics) GetAudioCodecs() []stringfunc (*VideoCharacteristics) GetDuration
func (x *VideoCharacteristics) GetDuration() *durationpb.Durationfunc (*VideoCharacteristics) GetFrameRate
func (x *VideoCharacteristics) GetFrameRate() float64func (*VideoCharacteristics) GetHeight
func (x *VideoCharacteristics) GetHeight() int32func (*VideoCharacteristics) GetVideoBitrateKbps
func (x *VideoCharacteristics) GetVideoBitrateKbps() int32func (*VideoCharacteristics) GetVideoCodecs
func (x *VideoCharacteristics) GetVideoCodecs() []stringfunc (*VideoCharacteristics) GetWidth
func (x *VideoCharacteristics) GetWidth() int32func (*VideoCharacteristics) ProtoMessage
func (*VideoCharacteristics) ProtoMessage()func (*VideoCharacteristics) ProtoReflect
func (x *VideoCharacteristics) ProtoReflect() protoreflect.Messagefunc (*VideoCharacteristics) Reset
func (x *VideoCharacteristics) Reset()func (*VideoCharacteristics) String
func (x *VideoCharacteristics) String() stringWorkspaceConfig
type WorkspaceConfig struct {
// The Google Workspace data source.
Type WorkspaceConfig_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.discoveryengine.v1alpha.WorkspaceConfig_Type" json:"type,omitempty"`
// Obfuscated Dasher customer ID.
DasherCustomerId string `protobuf:"bytes,2,opt,name=dasher_customer_id,json=dasherCustomerId,proto3" json:"dasher_customer_id,omitempty"`
// contains filtered or unexported fields
}Config to store data store type configuration for workspace data
func (*WorkspaceConfig) Descriptor
func (*WorkspaceConfig) Descriptor() ([]byte, []int)Deprecated: Use WorkspaceConfig.ProtoReflect.Descriptor instead.
func (*WorkspaceConfig) GetDasherCustomerId
func (x *WorkspaceConfig) GetDasherCustomerId() stringfunc (*WorkspaceConfig) GetType
func (x *WorkspaceConfig) GetType() WorkspaceConfig_Typefunc (*WorkspaceConfig) ProtoMessage
func (*WorkspaceConfig) ProtoMessage()func (*WorkspaceConfig) ProtoReflect
func (x *WorkspaceConfig) ProtoReflect() protoreflect.Messagefunc (*WorkspaceConfig) Reset
func (x *WorkspaceConfig) Reset()func (*WorkspaceConfig) String
func (x *WorkspaceConfig) String() stringWorkspaceConfig_Type
type WorkspaceConfig_Type int32Specifies the type of Workspace App supported by this DataStore
WorkspaceConfig_TYPE_UNSPECIFIED, WorkspaceConfig_GOOGLE_DRIVE, WorkspaceConfig_GOOGLE_MAIL, WorkspaceConfig_GOOGLE_SITES, WorkspaceConfig_GOOGLE_CALENDAR, WorkspaceConfig_GOOGLE_CHAT, WorkspaceConfig_GOOGLE_GROUPS, WorkspaceConfig_GOOGLE_KEEP
const (
// Defaults to an unspecified Workspace type.
WorkspaceConfig_TYPE_UNSPECIFIED WorkspaceConfig_Type = 0
// Workspace Data Store contains Drive data
WorkspaceConfig_GOOGLE_DRIVE WorkspaceConfig_Type = 1
// Workspace Data Store contains Mail data
WorkspaceConfig_GOOGLE_MAIL WorkspaceConfig_Type = 2
// Workspace Data Store contains Sites data
WorkspaceConfig_GOOGLE_SITES WorkspaceConfig_Type = 3
// Workspace Data Store contains Calendar data
WorkspaceConfig_GOOGLE_CALENDAR WorkspaceConfig_Type = 4
// Workspace Data Store contains Chat data
WorkspaceConfig_GOOGLE_CHAT WorkspaceConfig_Type = 5
// Workspace Data Store contains Groups data
WorkspaceConfig_GOOGLE_GROUPS WorkspaceConfig_Type = 6
// Workspace Data Store contains Keep data
WorkspaceConfig_GOOGLE_KEEP WorkspaceConfig_Type = 7
)func (WorkspaceConfig_Type) Descriptor
func (WorkspaceConfig_Type) Descriptor() protoreflect.EnumDescriptorfunc (WorkspaceConfig_Type) Enum
func (x WorkspaceConfig_Type) Enum() *WorkspaceConfig_Typefunc (WorkspaceConfig_Type) EnumDescriptor
func (WorkspaceConfig_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use WorkspaceConfig_Type.Descriptor instead.
func (WorkspaceConfig_Type) Number
func (x WorkspaceConfig_Type) Number() protoreflect.EnumNumberfunc (WorkspaceConfig_Type) String
func (x WorkspaceConfig_Type) String() stringfunc (WorkspaceConfig_Type) Type
func (WorkspaceConfig_Type) Type() protoreflect.EnumTypeWriteUserEventRequest
type WriteUserEventRequest struct {
// Required. The parent resource name.
// If the write user event action is applied in
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] level, the
// format is:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
// If the write user event action is applied in [Location][] level, for
// example, the event with
// [Document][google.cloud.discoveryengine.v1alpha.Document] across multiple
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], the format is:
// `projects/{project}/locations/{location}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. User event to write.
UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3,oneof" json:"user_event,omitempty"`
// If set to true, the user event is written asynchronously after
// validation, and the API responds without waiting for the write.
WriteAsync bool `protobuf:"varint,3,opt,name=write_async,json=writeAsync,proto3" json:"write_async,omitempty"`
// contains filtered or unexported fields
}Request message for WriteUserEvent method.
func (*WriteUserEventRequest) Descriptor
func (*WriteUserEventRequest) Descriptor() ([]byte, []int)Deprecated: Use WriteUserEventRequest.ProtoReflect.Descriptor instead.
func (*WriteUserEventRequest) GetParent
func (x *WriteUserEventRequest) GetParent() stringfunc (*WriteUserEventRequest) GetUserEvent
func (x *WriteUserEventRequest) GetUserEvent() *UserEventfunc (*WriteUserEventRequest) GetWriteAsync
func (x *WriteUserEventRequest) GetWriteAsync() boolfunc (*WriteUserEventRequest) ProtoMessage
func (*WriteUserEventRequest) ProtoMessage()func (*WriteUserEventRequest) ProtoReflect
func (x *WriteUserEventRequest) ProtoReflect() protoreflect.Messagefunc (*WriteUserEventRequest) Reset
func (x *WriteUserEventRequest) Reset()func (*WriteUserEventRequest) String
func (x *WriteUserEventRequest) String() string