searchindex

package
v0.0.0-...-aeb3b05 Latest Latest
Warning

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

 Go to latest Published: Dec 20, 2024 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	SearchIndexFileService_BatchCreate_FullMethodName = "/yandex.cloud.ai.assistants.v1.searchindex.SearchIndexFileService/BatchCreate"
	SearchIndexFileService_Get_FullMethodName         = "/yandex.cloud.ai.assistants.v1.searchindex.SearchIndexFileService/Get"
	SearchIndexFileService_List_FullMethodName        = "/yandex.cloud.ai.assistants.v1.searchindex.SearchIndexFileService/List"
)
View Source 
const (
	SearchIndexService_Create_FullMethodName = "/yandex.cloud.ai.assistants.v1.searchindex.SearchIndexService/Create"
	SearchIndexService_Get_FullMethodName    = "/yandex.cloud.ai.assistants.v1.searchindex.SearchIndexService/Get"
	SearchIndexService_Update_FullMethodName = "/yandex.cloud.ai.assistants.v1.searchindex.SearchIndexService/Update"
	SearchIndexService_Delete_FullMethodName = "/yandex.cloud.ai.assistants.v1.searchindex.SearchIndexService/Delete"
	SearchIndexService_List_FullMethodName   = "/yandex.cloud.ai.assistants.v1.searchindex.SearchIndexService/List"
)

Variables

View Source 
var (
	NormalizationStrategy_name = map[int32]string{
		0: "NORMALIZATION_STRATEGY_UNSPECIFIED",
		1: "MIN_MAX",
		2: "L2",
	}
	NormalizationStrategy_value = map[string]int32{
		"NORMALIZATION_STRATEGY_UNSPECIFIED": 0,
		"MIN_MAX":                            1,
		"L2":                                 2,
	}
)

Enum value maps for NormalizationStrategy.

View Source 
var (
	MeanCombinationStrategy_MeanEvaluationTechnique_name = map[int32]string{
		0: "MEAN_EVALUATION_TECHNIQUE_UNSPECIFIED",
		1: "ARITHMETIC",
		2: "GEOMETRIC",
		3: "HARMONIC",
	}
	MeanCombinationStrategy_MeanEvaluationTechnique_value = map[string]int32{
		"MEAN_EVALUATION_TECHNIQUE_UNSPECIFIED": 0,
		"ARITHMETIC":                            1,
		"GEOMETRIC":                             2,
		"HARMONIC":                              3,
	}
)

Enum value maps for MeanCombinationStrategy_MeanEvaluationTechnique.

View Source 
var File_yandex_cloud_ai_assistants_v1_searchindex_common_proto protoreflect.FileDescriptor
View Source 
var File_yandex_cloud_ai_assistants_v1_searchindex_search_index_file_proto protoreflect.FileDescriptor
View Source 
var File_yandex_cloud_ai_assistants_v1_searchindex_search_index_file_service_proto protoreflect.FileDescriptor
View Source 
var File_yandex_cloud_ai_assistants_v1_searchindex_search_index_proto protoreflect.FileDescriptor
View Source 
var File_yandex_cloud_ai_assistants_v1_searchindex_search_index_service_proto protoreflect.FileDescriptor
View Source 
var SearchIndexFileService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "yandex.cloud.ai.assistants.v1.searchindex.SearchIndexFileService",
	HandlerType: (*SearchIndexFileServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "BatchCreate",
			Handler:    _SearchIndexFileService_BatchCreate_Handler,
		},
		{
			MethodName: "Get",
			Handler:    _SearchIndexFileService_Get_Handler,
		},
		{
			MethodName: "List",
			Handler:    _SearchIndexFileService_List_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "yandex/cloud/ai/assistants/v1/searchindex/search_index_file_service.proto",
}

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

View Source 
var SearchIndexService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "yandex.cloud.ai.assistants.v1.searchindex.SearchIndexService",
	HandlerType: (*SearchIndexServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Create",
			Handler:    _SearchIndexService_Create_Handler,
		},
		{
			MethodName: "Get",
			Handler:    _SearchIndexService_Get_Handler,
		},
		{
			MethodName: "Update",
			Handler:    _SearchIndexService_Update_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _SearchIndexService_Delete_Handler,
		},
		{
			MethodName: "List",
			Handler:    _SearchIndexService_List_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "yandex/cloud/ai/assistants/v1/searchindex/search_index_service.proto",
}

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

Functions

func RegisterSearchIndexFileServiceServer 

func RegisterSearchIndexFileServiceServer(s grpc.ServiceRegistrar, srv SearchIndexFileServiceServer)

func RegisterSearchIndexServiceServer 

func RegisterSearchIndexServiceServer(s grpc.ServiceRegistrar, srv SearchIndexServiceServer)

Types

type BatchCreateSearchIndexFileRequest 

type BatchCreateSearchIndexFileRequest struct {
	FileIds       []string `protobuf:"bytes,1,rep,name=file_ids,json=fileIds,proto3" json:"file_ids,omitempty"`
	SearchIndexId string   `protobuf:"bytes,2,opt,name=search_index_id,json=searchIndexId,proto3" json:"search_index_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for creating multiple files within a search index.

func (*BatchCreateSearchIndexFileRequest) Descriptor deprecated 

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

Deprecated: Use BatchCreateSearchIndexFileRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateSearchIndexFileRequest) GetFileIds 

func (x *BatchCreateSearchIndexFileRequest) GetFileIds() []string

func (*BatchCreateSearchIndexFileRequest) GetSearchIndexId 

func (x *BatchCreateSearchIndexFileRequest) GetSearchIndexId() string

func (*BatchCreateSearchIndexFileRequest) ProtoMessage 

func (*BatchCreateSearchIndexFileRequest) ProtoMessage()

func (*BatchCreateSearchIndexFileRequest) ProtoReflect 

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

func (*BatchCreateSearchIndexFileRequest) Reset 

func (x *BatchCreateSearchIndexFileRequest) Reset()

func (*BatchCreateSearchIndexFileRequest) SetFileIds 

func (m *BatchCreateSearchIndexFileRequest) SetFileIds(v []string)

func (*BatchCreateSearchIndexFileRequest) SetSearchIndexId 

func (m *BatchCreateSearchIndexFileRequest) SetSearchIndexId(v string)

func (*BatchCreateSearchIndexFileRequest) String 

func (x *BatchCreateSearchIndexFileRequest) String() string

type BatchCreateSearchIndexFileResponse 

type BatchCreateSearchIndexFileResponse struct {
	Files []*SearchIndexFile `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"`
	// contains filtered or unexported fields
}

Response message for the BatchCreate operation.

func (*BatchCreateSearchIndexFileResponse) Descriptor deprecated 

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

Deprecated: Use BatchCreateSearchIndexFileResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateSearchIndexFileResponse) GetFiles 

func (x *BatchCreateSearchIndexFileResponse) GetFiles() []*SearchIndexFile

func (*BatchCreateSearchIndexFileResponse) ProtoMessage 

func (*BatchCreateSearchIndexFileResponse) ProtoMessage()

func (*BatchCreateSearchIndexFileResponse) ProtoReflect 

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

func (*BatchCreateSearchIndexFileResponse) Reset 

func (x *BatchCreateSearchIndexFileResponse) Reset()

func (*BatchCreateSearchIndexFileResponse) SetFiles 

func (m *BatchCreateSearchIndexFileResponse) SetFiles(v []*SearchIndexFile)

func (*BatchCreateSearchIndexFileResponse) String 

func (x *BatchCreateSearchIndexFileResponse) String() string

type ChunkingStrategy 

type ChunkingStrategy struct {

	// Types that are assignable to Strategy:
	//
	//	*ChunkingStrategy_StaticStrategy
	Strategy isChunkingStrategy_Strategy `protobuf_oneof:"Strategy"`
	// contains filtered or unexported fields
}

Defines a general strategy for chunking text into smaller segments. Currently, only StaticChunkingStrategy is supported.

func (*ChunkingStrategy) Descriptor deprecated 

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

Deprecated: Use ChunkingStrategy.ProtoReflect.Descriptor instead.

func (*ChunkingStrategy) GetStaticStrategy 

func (x *ChunkingStrategy) GetStaticStrategy() *StaticChunkingStrategy

func (*ChunkingStrategy) GetStrategy 

func (m *ChunkingStrategy) GetStrategy() isChunkingStrategy_Strategy

func (*ChunkingStrategy) ProtoMessage 

func (*ChunkingStrategy) ProtoMessage()

func (*ChunkingStrategy) ProtoReflect 

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

func (*ChunkingStrategy) Reset 

func (x *ChunkingStrategy) Reset()

func (*ChunkingStrategy) SetStaticStrategy 

func (m *ChunkingStrategy) SetStaticStrategy(v *StaticChunkingStrategy)

func (*ChunkingStrategy) SetStrategy 

func (m *ChunkingStrategy) SetStrategy(v ChunkingStrategy_Strategy)

func (*ChunkingStrategy) String 

func (x *ChunkingStrategy) String() string

type ChunkingStrategy_StaticStrategy 

type ChunkingStrategy_StaticStrategy struct {
	StaticStrategy *StaticChunkingStrategy `protobuf:"bytes,1,opt,name=static_strategy,json=staticStrategy,proto3,oneof"`
}

type ChunkingStrategy_Strategy 

type ChunkingStrategy_Strategy = isChunkingStrategy_Strategy

type CombinationStrategy 

type CombinationStrategy struct {

	// Types that are assignable to Strategy:
	//
	//	*CombinationStrategy_MeanCombination
	//	*CombinationStrategy_RrfCombination
	Strategy isCombinationStrategy_Strategy `protobuf_oneof:"Strategy"`
	// contains filtered or unexported fields
}

Combination strategy for merging rankings from different indices

func (*CombinationStrategy) Descriptor deprecated 

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

Deprecated: Use CombinationStrategy.ProtoReflect.Descriptor instead.

func (*CombinationStrategy) GetMeanCombination 

func (x *CombinationStrategy) GetMeanCombination() *MeanCombinationStrategy

func (*CombinationStrategy) GetRrfCombination 

func (x *CombinationStrategy) GetRrfCombination() *ReciprocalRankFusionCombinationStrategy

func (*CombinationStrategy) GetStrategy 

func (m *CombinationStrategy) GetStrategy() isCombinationStrategy_Strategy

func (*CombinationStrategy) ProtoMessage 

func (*CombinationStrategy) ProtoMessage()

func (*CombinationStrategy) ProtoReflect 

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

func (*CombinationStrategy) Reset 

func (x *CombinationStrategy) Reset()

func (*CombinationStrategy) SetMeanCombination 

func (m *CombinationStrategy) SetMeanCombination(v *MeanCombinationStrategy)

func (*CombinationStrategy) SetRrfCombination 

func (m *CombinationStrategy) SetRrfCombination(v *ReciprocalRankFusionCombinationStrategy)

func (*CombinationStrategy) SetStrategy 

func (m *CombinationStrategy) SetStrategy(v CombinationStrategy_Strategy)

func (*CombinationStrategy) String 

func (x *CombinationStrategy) String() string

type CombinationStrategy_MeanCombination 

type CombinationStrategy_MeanCombination struct {
	MeanCombination *MeanCombinationStrategy `protobuf:"bytes,1,opt,name=mean_combination,json=meanCombination,proto3,oneof"`
}

type CombinationStrategy_RrfCombination 

type CombinationStrategy_RrfCombination struct {
	RrfCombination *ReciprocalRankFusionCombinationStrategy `protobuf:"bytes,2,opt,name=rrf_combination,json=rrfCombination,proto3,oneof"`
}

type CombinationStrategy_Strategy 

type CombinationStrategy_Strategy = isCombinationStrategy_Strategy

type CreateSearchIndexRequest 

type CreateSearchIndexRequest struct {
	FolderId string `protobuf:"bytes,1,opt,name=folder_id,json=folderId,proto3" json:"folder_id,omitempty"`
	// List of file IDs to be indexed.
	FileIds []string `protobuf:"bytes,2,rep,name=file_ids,json=fileIds,proto3" json:"file_ids,omitempty"`
	// Name of the search index.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the search index.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Expiration configuration for the search index.
	ExpirationConfig *common.ExpirationConfig `protobuf:"bytes,5,opt,name=expiration_config,json=expirationConfig,proto3" json:"expiration_config,omitempty"`
	// Set of key-value pairs to label the search index.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Types that are assignable to IndexType:
	//
	//	*CreateSearchIndexRequest_TextSearchIndex
	//	*CreateSearchIndexRequest_VectorSearchIndex
	//	*CreateSearchIndexRequest_HybridSearchIndex
	IndexType isCreateSearchIndexRequest_IndexType `protobuf_oneof:"IndexType"`
	// contains filtered or unexported fields
}

Request to create a new search index.

func (*CreateSearchIndexRequest) Descriptor deprecated 

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

Deprecated: Use CreateSearchIndexRequest.ProtoReflect.Descriptor instead.

func (*CreateSearchIndexRequest) GetDescription 

func (x *CreateSearchIndexRequest) GetDescription() string

func (*CreateSearchIndexRequest) GetExpirationConfig 

func (x *CreateSearchIndexRequest) GetExpirationConfig() *common.ExpirationConfig

func (*CreateSearchIndexRequest) GetFileIds 

func (x *CreateSearchIndexRequest) GetFileIds() []string

func (*CreateSearchIndexRequest) GetFolderId 

func (x *CreateSearchIndexRequest) GetFolderId() string

func (*CreateSearchIndexRequest) GetHybridSearchIndex 

func (x *CreateSearchIndexRequest) GetHybridSearchIndex() *HybridSearchIndex

func (*CreateSearchIndexRequest) GetIndexType 

func (m *CreateSearchIndexRequest) GetIndexType() isCreateSearchIndexRequest_IndexType

func (*CreateSearchIndexRequest) GetLabels 

func (x *CreateSearchIndexRequest) GetLabels() map[string]string

func (*CreateSearchIndexRequest) GetName 

func (x *CreateSearchIndexRequest) GetName() string

func (*CreateSearchIndexRequest) GetTextSearchIndex 

func (x *CreateSearchIndexRequest) GetTextSearchIndex() *TextSearchIndex

func (*CreateSearchIndexRequest) GetVectorSearchIndex 

func (x *CreateSearchIndexRequest) GetVectorSearchIndex() *VectorSearchIndex

func (*CreateSearchIndexRequest) ProtoMessage 

func (*CreateSearchIndexRequest) ProtoMessage()

func (*CreateSearchIndexRequest) ProtoReflect 

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

func (*CreateSearchIndexRequest) Reset 

func (x *CreateSearchIndexRequest) Reset()

func (*CreateSearchIndexRequest) SetDescription 

func (m *CreateSearchIndexRequest) SetDescription(v string)

func (*CreateSearchIndexRequest) SetExpirationConfig 

func (m *CreateSearchIndexRequest) SetExpirationConfig(v *common.ExpirationConfig)

func (*CreateSearchIndexRequest) SetFileIds 

func (m *CreateSearchIndexRequest) SetFileIds(v []string)

func (*CreateSearchIndexRequest) SetFolderId 

func (m *CreateSearchIndexRequest) SetFolderId(v string)

func (*CreateSearchIndexRequest) SetHybridSearchIndex 

func (m *CreateSearchIndexRequest) SetHybridSearchIndex(v *HybridSearchIndex)

func (*CreateSearchIndexRequest) SetIndexType 

func (m *CreateSearchIndexRequest) SetIndexType(v CreateSearchIndexRequest_IndexType)

func (*CreateSearchIndexRequest) SetLabels 

func (m *CreateSearchIndexRequest) SetLabels(v map[string]string)

func (*CreateSearchIndexRequest) SetName 

func (m *CreateSearchIndexRequest) SetName(v string)

func (*CreateSearchIndexRequest) SetTextSearchIndex 

func (m *CreateSearchIndexRequest) SetTextSearchIndex(v *TextSearchIndex)

func (*CreateSearchIndexRequest) SetVectorSearchIndex 

func (m *CreateSearchIndexRequest) SetVectorSearchIndex(v *VectorSearchIndex)

func (*CreateSearchIndexRequest) String 

func (x *CreateSearchIndexRequest) String() string

type CreateSearchIndexRequest_HybridSearchIndex 

type CreateSearchIndexRequest_HybridSearchIndex struct {
	// Configuration for a hybrid (vector-based + keyword-based) search index.
	HybridSearchIndex *HybridSearchIndex `protobuf:"bytes,9,opt,name=hybrid_search_index,json=hybridSearchIndex,proto3,oneof"`
}

type CreateSearchIndexRequest_IndexType 

type CreateSearchIndexRequest_IndexType = isCreateSearchIndexRequest_IndexType

type CreateSearchIndexRequest_TextSearchIndex 

type CreateSearchIndexRequest_TextSearchIndex struct {
	// Configuration for a traditional keyword-based text search index.
	TextSearchIndex *TextSearchIndex `protobuf:"bytes,7,opt,name=text_search_index,json=textSearchIndex,proto3,oneof"`
}

type CreateSearchIndexRequest_VectorSearchIndex 

type CreateSearchIndexRequest_VectorSearchIndex struct {
	// Configuration for a vector-based search index using embeddings.
	VectorSearchIndex *VectorSearchIndex `protobuf:"bytes,8,opt,name=vector_search_index,json=vectorSearchIndex,proto3,oneof"`
}

type DeleteSearchIndexRequest 

type DeleteSearchIndexRequest struct {

	// ID of the search index to delete.
	SearchIndexId string `protobuf:"bytes,1,opt,name=search_index_id,json=searchIndexId,proto3" json:"search_index_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for deleting a search index by ID.

func (*DeleteSearchIndexRequest) Descriptor deprecated 

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

Deprecated: Use DeleteSearchIndexRequest.ProtoReflect.Descriptor instead.

func (*DeleteSearchIndexRequest) GetSearchIndexId 

func (x *DeleteSearchIndexRequest) GetSearchIndexId() string

func (*DeleteSearchIndexRequest) ProtoMessage 

func (*DeleteSearchIndexRequest) ProtoMessage()

func (*DeleteSearchIndexRequest) ProtoReflect 

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

func (*DeleteSearchIndexRequest) Reset 

func (x *DeleteSearchIndexRequest) Reset()

func (*DeleteSearchIndexRequest) SetSearchIndexId 

func (m *DeleteSearchIndexRequest) SetSearchIndexId(v string)

func (*DeleteSearchIndexRequest) String 

func (x *DeleteSearchIndexRequest) String() string

type DeleteSearchIndexResponse 

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

Response message for the delete operation.

func (*DeleteSearchIndexResponse) Descriptor deprecated 

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

Deprecated: Use DeleteSearchIndexResponse.ProtoReflect.Descriptor instead.

func (*DeleteSearchIndexResponse) ProtoMessage 

func (*DeleteSearchIndexResponse) ProtoMessage()

func (*DeleteSearchIndexResponse) ProtoReflect 

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

func (*DeleteSearchIndexResponse) Reset 

func (x *DeleteSearchIndexResponse) Reset()

func (*DeleteSearchIndexResponse) String 

func (x *DeleteSearchIndexResponse) String() string

type GetSearchIndexFileRequest 

type GetSearchIndexFileRequest struct {

	// ID of the file to retrieve.
	FileId string `protobuf:"bytes,1,opt,name=file_id,json=fileId,proto3" json:"file_id,omitempty"`
	// ID of the search index that contains the file.
	SearchIndexId string `protobuf:"bytes,2,opt,name=search_index_id,json=searchIndexId,proto3" json:"search_index_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for retrieving a file from a search index.

func (*GetSearchIndexFileRequest) Descriptor deprecated 

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

Deprecated: Use GetSearchIndexFileRequest.ProtoReflect.Descriptor instead.

func (*GetSearchIndexFileRequest) GetFileId 

func (x *GetSearchIndexFileRequest) GetFileId() string

func (*GetSearchIndexFileRequest) GetSearchIndexId 

func (x *GetSearchIndexFileRequest) GetSearchIndexId() string

func (*GetSearchIndexFileRequest) ProtoMessage 

func (*GetSearchIndexFileRequest) ProtoMessage()

func (*GetSearchIndexFileRequest) ProtoReflect 

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

func (*GetSearchIndexFileRequest) Reset 

func (x *GetSearchIndexFileRequest) Reset()

func (*GetSearchIndexFileRequest) SetFileId 

func (m *GetSearchIndexFileRequest) SetFileId(v string)

func (*GetSearchIndexFileRequest) SetSearchIndexId 

func (m *GetSearchIndexFileRequest) SetSearchIndexId(v string)

func (*GetSearchIndexFileRequest) String 

func (x *GetSearchIndexFileRequest) String() string

type GetSearchIndexRequest 

type GetSearchIndexRequest struct {

	// ID of the search index to retrieve.
	SearchIndexId string `protobuf:"bytes,1,opt,name=search_index_id,json=searchIndexId,proto3" json:"search_index_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for retrieving a search index by ID.

func (*GetSearchIndexRequest) Descriptor deprecated 

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

Deprecated: Use GetSearchIndexRequest.ProtoReflect.Descriptor instead.

func (*GetSearchIndexRequest) GetSearchIndexId 

func (x *GetSearchIndexRequest) GetSearchIndexId() string

func (*GetSearchIndexRequest) ProtoMessage 

func (*GetSearchIndexRequest) ProtoMessage()

func (*GetSearchIndexRequest) ProtoReflect 

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

func (*GetSearchIndexRequest) Reset 

func (x *GetSearchIndexRequest) Reset()

func (*GetSearchIndexRequest) SetSearchIndexId 

func (m *GetSearchIndexRequest) SetSearchIndexId(v string)

func (*GetSearchIndexRequest) String 

func (x *GetSearchIndexRequest) String() string

type HybridSearchIndex 

type HybridSearchIndex struct {

	// Configuration for a traditional keyword-based text search index.
	TextSearchIndex *TextSearchIndex `protobuf:"bytes,1,opt,name=text_search_index,json=textSearchIndex,proto3" json:"text_search_index,omitempty"`
	// Configuration for a vector-based search index.
	VectorSearchIndex *VectorSearchIndex `protobuf:"bytes,2,opt,name=vector_search_index,json=vectorSearchIndex,proto3" json:"vector_search_index,omitempty"`
	// Common chunking strategy that applies to both text and vector search indexes.
	// If provided, it overrides the individual chunking strategies in both `text_search_index` and `vector_search_index`.
	// In this case, both text and vector search will use token-based chunking, where tokens are produced by the tokenizer of the embedding model.
	ChunkingStrategy *ChunkingStrategy `protobuf:"bytes,3,opt,name=chunking_strategy,json=chunkingStrategy,proto3" json:"chunking_strategy,omitempty"`
	// Normalization strategy for relevance scores from different indices. Default is MIN_MAX_STRATEGY
	NormalizationStrategy NormalizationStrategy `` /* 194-byte string literal not displayed */
	// Combination strategy for merging rankings from different indices. Default is arithmetic mean
	CombinationStrategy *CombinationStrategy `protobuf:"bytes,5,opt,name=combination_strategy,json=combinationStrategy,proto3" json:"combination_strategy,omitempty"`
	// contains filtered or unexported fields
}

Defines the configuration for a hybrid (vector-based + keyword-based) search index. This type uses both embeddings and keyword-based search to represent documents and queries.

func (*HybridSearchIndex) Descriptor deprecated 

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

Deprecated: Use HybridSearchIndex.ProtoReflect.Descriptor instead.

func (*HybridSearchIndex) GetChunkingStrategy 

func (x *HybridSearchIndex) GetChunkingStrategy() *ChunkingStrategy

func (*HybridSearchIndex) GetCombinationStrategy 

func (x *HybridSearchIndex) GetCombinationStrategy() *CombinationStrategy

func (*HybridSearchIndex) GetNormalizationStrategy 

func (x *HybridSearchIndex) GetNormalizationStrategy() NormalizationStrategy

func (*HybridSearchIndex) GetTextSearchIndex 

func (x *HybridSearchIndex) GetTextSearchIndex() *TextSearchIndex

func (*HybridSearchIndex) GetVectorSearchIndex 

func (x *HybridSearchIndex) GetVectorSearchIndex() *VectorSearchIndex

func (*HybridSearchIndex) ProtoMessage 

func (*HybridSearchIndex) ProtoMessage()

func (*HybridSearchIndex) ProtoReflect 

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

func (*HybridSearchIndex) Reset 

func (x *HybridSearchIndex) Reset()

func (*HybridSearchIndex) SetChunkingStrategy 

func (m *HybridSearchIndex) SetChunkingStrategy(v *ChunkingStrategy)

func (*HybridSearchIndex) SetCombinationStrategy 

func (m *HybridSearchIndex) SetCombinationStrategy(v *CombinationStrategy)

func (*HybridSearchIndex) SetNormalizationStrategy 

func (m *HybridSearchIndex) SetNormalizationStrategy(v NormalizationStrategy)

func (*HybridSearchIndex) SetTextSearchIndex 

func (m *HybridSearchIndex) SetTextSearchIndex(v *TextSearchIndex)

func (*HybridSearchIndex) SetVectorSearchIndex 

func (m *HybridSearchIndex) SetVectorSearchIndex(v *VectorSearchIndex)

func (*HybridSearchIndex) String 

func (x *HybridSearchIndex) String() string

type ListSearchIndexFilesRequest 

type ListSearchIndexFilesRequest struct {

	// ID of the search index whose files will be listed.
	SearchIndexId string `protobuf:"bytes,1,opt,name=search_index_id,json=searchIndexId,proto3" json:"search_index_id,omitempty"`
	// Maximum number of files to return per page.
	PageSize int64 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Token to retrieve the next page of results.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for listing files in a specific search index.

func (*ListSearchIndexFilesRequest) Descriptor deprecated 

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

Deprecated: Use ListSearchIndexFilesRequest.ProtoReflect.Descriptor instead.

func (*ListSearchIndexFilesRequest) GetPageSize 

func (x *ListSearchIndexFilesRequest) GetPageSize() int64

func (*ListSearchIndexFilesRequest) GetPageToken 

func (x *ListSearchIndexFilesRequest) GetPageToken() string

func (*ListSearchIndexFilesRequest) GetSearchIndexId 

func (x *ListSearchIndexFilesRequest) GetSearchIndexId() string

func (*ListSearchIndexFilesRequest) ProtoMessage 

func (*ListSearchIndexFilesRequest) ProtoMessage()

func (*ListSearchIndexFilesRequest) ProtoReflect 

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

func (*ListSearchIndexFilesRequest) Reset 

func (x *ListSearchIndexFilesRequest) Reset()

func (*ListSearchIndexFilesRequest) SetPageSize 

func (m *ListSearchIndexFilesRequest) SetPageSize(v int64)

func (*ListSearchIndexFilesRequest) SetPageToken 

func (m *ListSearchIndexFilesRequest) SetPageToken(v string)

func (*ListSearchIndexFilesRequest) SetSearchIndexId 

func (m *ListSearchIndexFilesRequest) SetSearchIndexId(v string)

func (*ListSearchIndexFilesRequest) String 

func (x *ListSearchIndexFilesRequest) String() string

type ListSearchIndexFilesResponse 

type ListSearchIndexFilesResponse struct {

	// List of files in the specified search index.
	Files []*SearchIndexFile `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"`
	// Token to retrieve the next page of results.
	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 the list operation.

func (*ListSearchIndexFilesResponse) Descriptor deprecated 

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

Deprecated: Use ListSearchIndexFilesResponse.ProtoReflect.Descriptor instead.

func (*ListSearchIndexFilesResponse) GetFiles 

func (x *ListSearchIndexFilesResponse) GetFiles() []*SearchIndexFile

func (*ListSearchIndexFilesResponse) GetNextPageToken 

func (x *ListSearchIndexFilesResponse) GetNextPageToken() string

func (*ListSearchIndexFilesResponse) ProtoMessage 

func (*ListSearchIndexFilesResponse) ProtoMessage()

func (*ListSearchIndexFilesResponse) ProtoReflect 

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

func (*ListSearchIndexFilesResponse) Reset 

func (x *ListSearchIndexFilesResponse) Reset()

func (*ListSearchIndexFilesResponse) SetFiles 

func (m *ListSearchIndexFilesResponse) SetFiles(v []*SearchIndexFile)

func (*ListSearchIndexFilesResponse) SetNextPageToken 

func (m *ListSearchIndexFilesResponse) SetNextPageToken(v string)

func (*ListSearchIndexFilesResponse) String 

func (x *ListSearchIndexFilesResponse) String() string

type ListSearchIndicesRequest 

type ListSearchIndicesRequest struct {

	// Folder ID from which to list search indexes.
	FolderId string `protobuf:"bytes,1,opt,name=folder_id,json=folderId,proto3" json:"folder_id,omitempty"`
	// Maximum number of threads to return per page.
	PageSize int64 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Token to retrieve the next page of results.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for listing search indexes in a specific folder.

func (*ListSearchIndicesRequest) Descriptor deprecated 

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

Deprecated: Use ListSearchIndicesRequest.ProtoReflect.Descriptor instead.

func (*ListSearchIndicesRequest) GetFolderId 

func (x *ListSearchIndicesRequest) GetFolderId() string

func (*ListSearchIndicesRequest) GetPageSize 

func (x *ListSearchIndicesRequest) GetPageSize() int64

func (*ListSearchIndicesRequest) GetPageToken 

func (x *ListSearchIndicesRequest) GetPageToken() string

func (*ListSearchIndicesRequest) ProtoMessage 

func (*ListSearchIndicesRequest) ProtoMessage()

func (*ListSearchIndicesRequest) ProtoReflect 

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

func (*ListSearchIndicesRequest) Reset 

func (x *ListSearchIndicesRequest) Reset()

func (*ListSearchIndicesRequest) SetFolderId 

func (m *ListSearchIndicesRequest) SetFolderId(v string)

func (*ListSearchIndicesRequest) SetPageSize 

func (m *ListSearchIndicesRequest) SetPageSize(v int64)

func (*ListSearchIndicesRequest) SetPageToken 

func (m *ListSearchIndicesRequest) SetPageToken(v string)

func (*ListSearchIndicesRequest) String 

func (x *ListSearchIndicesRequest) String() string

type ListSearchIndicesResponse 

type ListSearchIndicesResponse struct {

	// List of search indexes in the specified folder.
	Indices []*SearchIndex `protobuf:"bytes,1,rep,name=indices,proto3" json:"indices,omitempty"`
	// Token to retrieve the next page of results.
	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 the list operation.

func (*ListSearchIndicesResponse) Descriptor deprecated 

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

Deprecated: Use ListSearchIndicesResponse.ProtoReflect.Descriptor instead.

func (*ListSearchIndicesResponse) GetIndices 

func (x *ListSearchIndicesResponse) GetIndices() []*SearchIndex

func (*ListSearchIndicesResponse) GetNextPageToken 

func (x *ListSearchIndicesResponse) GetNextPageToken() string

func (*ListSearchIndicesResponse) ProtoMessage 

func (*ListSearchIndicesResponse) ProtoMessage()

func (*ListSearchIndicesResponse) ProtoReflect 

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

func (*ListSearchIndicesResponse) Reset 

func (x *ListSearchIndicesResponse) Reset()

func (*ListSearchIndicesResponse) SetIndices 

func (m *ListSearchIndicesResponse) SetIndices(v []*SearchIndex)

func (*ListSearchIndicesResponse) SetNextPageToken 

func (m *ListSearchIndicesResponse) SetNextPageToken(v string)

func (*ListSearchIndicesResponse) String 

func (x *ListSearchIndicesResponse) String() string

type MeanCombinationStrategy 

type MeanCombinationStrategy struct {

	// Technique for averaging relevance scores from different indices. Default is ARITHMETIC
	MeanEvaluationTechnique MeanCombinationStrategy_MeanEvaluationTechnique `` /* 228-byte string literal not displayed */
	// Weights used for evaluating the weighted mean of relevance scores. The sum of the values must equal 1.0
	// If not provided, all scores are given equal weight
	Weights []float64 `protobuf:"fixed64,2,rep,packed,name=weights,proto3" json:"weights,omitempty"`
	// contains filtered or unexported fields
}

func (*MeanCombinationStrategy) Descriptor deprecated 

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

Deprecated: Use MeanCombinationStrategy.ProtoReflect.Descriptor instead.

func (*MeanCombinationStrategy) GetMeanEvaluationTechnique 

func (x *MeanCombinationStrategy) GetMeanEvaluationTechnique() MeanCombinationStrategy_MeanEvaluationTechnique

func (*MeanCombinationStrategy) GetWeights 

func (x *MeanCombinationStrategy) GetWeights() []float64

func (*MeanCombinationStrategy) ProtoMessage 

func (*MeanCombinationStrategy) ProtoMessage()

func (*MeanCombinationStrategy) ProtoReflect 

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

func (*MeanCombinationStrategy) Reset 

func (x *MeanCombinationStrategy) Reset()

func (*MeanCombinationStrategy) SetMeanEvaluationTechnique 

func (m *MeanCombinationStrategy) SetMeanEvaluationTechnique(v MeanCombinationStrategy_MeanEvaluationTechnique)

func (*MeanCombinationStrategy) SetWeights 

func (m *MeanCombinationStrategy) SetWeights(v []float64)

func (*MeanCombinationStrategy) String 

func (x *MeanCombinationStrategy) String() string

type MeanCombinationStrategy_MeanEvaluationTechnique 

type MeanCombinationStrategy_MeanEvaluationTechnique int32
const (
	MeanCombinationStrategy_MEAN_EVALUATION_TECHNIQUE_UNSPECIFIED MeanCombinationStrategy_MeanEvaluationTechnique = 0
	// https://en.wikipedia.org/wiki/Arithmetic_mean
	MeanCombinationStrategy_ARITHMETIC MeanCombinationStrategy_MeanEvaluationTechnique = 1
	// https://en.wikipedia.org/wiki/Geometric_mean
	MeanCombinationStrategy_GEOMETRIC MeanCombinationStrategy_MeanEvaluationTechnique = 2
	// https://en.wikipedia.org/wiki/Harmonic_mean
	MeanCombinationStrategy_HARMONIC MeanCombinationStrategy_MeanEvaluationTechnique = 3
)

func (MeanCombinationStrategy_MeanEvaluationTechnique) Descriptor 

func (MeanCombinationStrategy_MeanEvaluationTechnique) Descriptor() protoreflect.EnumDescriptor

func (MeanCombinationStrategy_MeanEvaluationTechnique) Enum 

func (x MeanCombinationStrategy_MeanEvaluationTechnique) Enum() *MeanCombinationStrategy_MeanEvaluationTechnique

func (MeanCombinationStrategy_MeanEvaluationTechnique) EnumDescriptor deprecated 

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

Deprecated: Use MeanCombinationStrategy_MeanEvaluationTechnique.Descriptor instead.

func (MeanCombinationStrategy_MeanEvaluationTechnique) Number 

func (x MeanCombinationStrategy_MeanEvaluationTechnique) Number() protoreflect.EnumNumber

func (MeanCombinationStrategy_MeanEvaluationTechnique) String 

func (x MeanCombinationStrategy_MeanEvaluationTechnique) String() string

func (MeanCombinationStrategy_MeanEvaluationTechnique) Type 

func (MeanCombinationStrategy_MeanEvaluationTechnique) Type() protoreflect.EnumType

type NgramTokenizer 

type NgramTokenizer struct {

	// Minimum length of characters in a gram. Defaults to 3
	MinGram *wrapperspb.Int64Value `protobuf:"bytes,1,opt,name=min_gram,json=minGram,proto3" json:"min_gram,omitempty"`
	// Maximum length of characters in a gram. Defaults to 4
	MaxGram *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=max_gram,json=maxGram,proto3" json:"max_gram,omitempty"`
	// contains filtered or unexported fields
}

func (*NgramTokenizer) Descriptor deprecated 

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

Deprecated: Use NgramTokenizer.ProtoReflect.Descriptor instead.

func (*NgramTokenizer) GetMaxGram 

func (x *NgramTokenizer) GetMaxGram() *wrapperspb.Int64Value

func (*NgramTokenizer) GetMinGram 

func (x *NgramTokenizer) GetMinGram() *wrapperspb.Int64Value

func (*NgramTokenizer) ProtoMessage 

func (*NgramTokenizer) ProtoMessage()

func (*NgramTokenizer) ProtoReflect 

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

func (*NgramTokenizer) Reset 

func (x *NgramTokenizer) Reset()

func (*NgramTokenizer) SetMaxGram 

func (m *NgramTokenizer) SetMaxGram(v *wrapperspb.Int64Value)

func (*NgramTokenizer) SetMinGram 

func (m *NgramTokenizer) SetMinGram(v *wrapperspb.Int64Value)

func (*NgramTokenizer) String 

func (x *NgramTokenizer) String() string

type NormalizationStrategy 

type NormalizationStrategy int32

Normalization strategy for relevance scores from different indices 

const (
	NormalizationStrategy_NORMALIZATION_STRATEGY_UNSPECIFIED NormalizationStrategy = 0
	// https://en.wikipedia.org/wiki/Feature_scaling#Rescaling_(min-max_normalization)
	NormalizationStrategy_MIN_MAX NormalizationStrategy = 1
	// https://en.wikipedia.org/wiki/Cosine_similarity#L2-normalized_Euclidean_distance
	NormalizationStrategy_L2 NormalizationStrategy = 2
)

func (NormalizationStrategy) Descriptor 

func (NormalizationStrategy) Descriptor() protoreflect.EnumDescriptor

func (NormalizationStrategy) Enum 

func (x NormalizationStrategy) Enum() *NormalizationStrategy

func (NormalizationStrategy) EnumDescriptor deprecated 

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

Deprecated: Use NormalizationStrategy.Descriptor instead.

func (NormalizationStrategy) Number 

func (x NormalizationStrategy) Number() protoreflect.EnumNumber

func (NormalizationStrategy) String 

func (x NormalizationStrategy) String() string

func (NormalizationStrategy) Type 

func (NormalizationStrategy) Type() protoreflect.EnumType

type ReciprocalRankFusionCombinationStrategy 

type ReciprocalRankFusionCombinationStrategy struct {

	// The parameter k for RRFscore. Default is 60
	K *wrapperspb.Int64Value `protobuf:"bytes,1,opt,name=k,proto3" json:"k,omitempty"`
	// contains filtered or unexported fields
}

https://plg.uwaterloo.ca/~gvcormac/cormacksigir09-rrf.pdf

func (*ReciprocalRankFusionCombinationStrategy) Descriptor deprecated 

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

Deprecated: Use ReciprocalRankFusionCombinationStrategy.ProtoReflect.Descriptor instead.

func (*ReciprocalRankFusionCombinationStrategy) GetK 

func (x *ReciprocalRankFusionCombinationStrategy) GetK() *wrapperspb.Int64Value

func (*ReciprocalRankFusionCombinationStrategy) ProtoMessage 

func (*ReciprocalRankFusionCombinationStrategy) ProtoMessage()

func (*ReciprocalRankFusionCombinationStrategy) ProtoReflect 

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

func (*ReciprocalRankFusionCombinationStrategy) Reset 

func (x *ReciprocalRankFusionCombinationStrategy) Reset()

func (*ReciprocalRankFusionCombinationStrategy) SetK 

func (m *ReciprocalRankFusionCombinationStrategy) SetK(v *wrapperspb.Int64Value)

func (*ReciprocalRankFusionCombinationStrategy) String 

func (x *ReciprocalRankFusionCombinationStrategy) String() string

type SearchIndex 

type SearchIndex struct {

	// Unique identifier of the search index.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the folder that the search index belongs to.
	FolderId string `protobuf:"bytes,2,opt,name=folder_id,json=folderId,proto3" json:"folder_id,omitempty"`
	// Name of the search index.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the search index.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Identifier of the subject who created this search index.
	CreatedBy string `protobuf:"bytes,5,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Timestamp representing when the search index was created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Identifier of the subject who last updated this search index.
	UpdatedBy string `protobuf:"bytes,7,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// Timestamp representing the last time this search index was updated.
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Configuration for the expiration of the search index, defining when and how the search index will expire.
	ExpirationConfig *common.ExpirationConfig `protobuf:"bytes,9,opt,name=expiration_config,json=expirationConfig,proto3" json:"expiration_config,omitempty"`
	// Timestamp representing when the search index will expire.
	ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// Set of key-value pairs that can be used to organize and categorize the search index.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Type of the search index. It can be either a traditional keyword-based text search or a vector-based search.
	//
	// Types that are assignable to IndexType:
	//
	//	*SearchIndex_TextSearchIndex
	//	*SearchIndex_VectorSearchIndex
	//	*SearchIndex_HybridSearchIndex
	IndexType isSearchIndex_IndexType `protobuf_oneof:"IndexType"`
	// contains filtered or unexported fields
}

Represents a search index used to store and query data, either using traditional keyword-based text search or vector-based search mechanisms.

func (*SearchIndex) Descriptor deprecated 

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

Deprecated: Use SearchIndex.ProtoReflect.Descriptor instead.

func (*SearchIndex) GetCreatedAt 

func (x *SearchIndex) GetCreatedAt() *timestamppb.Timestamp

func (*SearchIndex) GetCreatedBy 

func (x *SearchIndex) GetCreatedBy() string

func (*SearchIndex) GetDescription 

func (x *SearchIndex) GetDescription() string

func (*SearchIndex) GetExpirationConfig 

func (x *SearchIndex) GetExpirationConfig() *common.ExpirationConfig

func (*SearchIndex) GetExpiresAt 

func (x *SearchIndex) GetExpiresAt() *timestamppb.Timestamp

func (*SearchIndex) GetFolderId 

func (x *SearchIndex) GetFolderId() string

func (*SearchIndex) GetHybridSearchIndex 

func (x *SearchIndex) GetHybridSearchIndex() *HybridSearchIndex

func (*SearchIndex) GetId 

func (x *SearchIndex) GetId() string

func (*SearchIndex) GetIndexType 

func (m *SearchIndex) GetIndexType() isSearchIndex_IndexType

func (*SearchIndex) GetLabels 

func (x *SearchIndex) GetLabels() map[string]string

func (*SearchIndex) GetName 

func (x *SearchIndex) GetName() string

func (*SearchIndex) GetTextSearchIndex 

func (x *SearchIndex) GetTextSearchIndex() *TextSearchIndex

func (*SearchIndex) GetUpdatedAt 

func (x *SearchIndex) GetUpdatedAt() *timestamppb.Timestamp

func (*SearchIndex) GetUpdatedBy 

func (x *SearchIndex) GetUpdatedBy() string

func (*SearchIndex) GetVectorSearchIndex 

func (x *SearchIndex) GetVectorSearchIndex() *VectorSearchIndex

func (*SearchIndex) ProtoMessage 

func (*SearchIndex) ProtoMessage()

func (*SearchIndex) ProtoReflect 

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

func (*SearchIndex) Reset 

func (x *SearchIndex) Reset()

func (*SearchIndex) SetCreatedAt 

func (m *SearchIndex) SetCreatedAt(v *timestamppb.Timestamp)

func (*SearchIndex) SetCreatedBy 

func (m *SearchIndex) SetCreatedBy(v string)

func (*SearchIndex) SetDescription 

func (m *SearchIndex) SetDescription(v string)

func (*SearchIndex) SetExpirationConfig 

func (m *SearchIndex) SetExpirationConfig(v *common.ExpirationConfig)

func (*SearchIndex) SetExpiresAt 

func (m *SearchIndex) SetExpiresAt(v *timestamppb.Timestamp)

func (*SearchIndex) SetFolderId 

func (m *SearchIndex) SetFolderId(v string)

func (*SearchIndex) SetHybridSearchIndex 

func (m *SearchIndex) SetHybridSearchIndex(v *HybridSearchIndex)

func (*SearchIndex) SetId 

func (m *SearchIndex) SetId(v string)

func (*SearchIndex) SetIndexType 

func (m *SearchIndex) SetIndexType(v SearchIndex_IndexType)

func (*SearchIndex) SetLabels 

func (m *SearchIndex) SetLabels(v map[string]string)

func (*SearchIndex) SetName 

func (m *SearchIndex) SetName(v string)

func (*SearchIndex) SetTextSearchIndex 

func (m *SearchIndex) SetTextSearchIndex(v *TextSearchIndex)

func (*SearchIndex) SetUpdatedAt 

func (m *SearchIndex) SetUpdatedAt(v *timestamppb.Timestamp)

func (*SearchIndex) SetUpdatedBy 

func (m *SearchIndex) SetUpdatedBy(v string)

func (*SearchIndex) SetVectorSearchIndex 

func (m *SearchIndex) SetVectorSearchIndex(v *VectorSearchIndex)

func (*SearchIndex) String 

func (x *SearchIndex) String() string

type SearchIndexFile 

type SearchIndexFile struct {

	// Unique identifier of the file that was used for indexing.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the search index that contains this file.
	SearchIndexId string `protobuf:"bytes,2,opt,name=search_index_id,json=searchIndexId,proto3" json:"search_index_id,omitempty"`
	// Identifier of the subject who created the file in the search index.
	CreatedBy string `protobuf:"bytes,3,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Timestamp representing when the file was created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// contains filtered or unexported fields
}

Represents a file that has been indexed within a search index.

func (*SearchIndexFile) Descriptor deprecated 

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

Deprecated: Use SearchIndexFile.ProtoReflect.Descriptor instead.

func (*SearchIndexFile) GetCreatedAt 

func (x *SearchIndexFile) GetCreatedAt() *timestamppb.Timestamp

func (*SearchIndexFile) GetCreatedBy 

func (x *SearchIndexFile) GetCreatedBy() string

func (*SearchIndexFile) GetId 

func (x *SearchIndexFile) GetId() string

func (*SearchIndexFile) GetSearchIndexId 

func (x *SearchIndexFile) GetSearchIndexId() string

func (*SearchIndexFile) ProtoMessage 

func (*SearchIndexFile) ProtoMessage()

func (*SearchIndexFile) ProtoReflect 

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

func (*SearchIndexFile) Reset 

func (x *SearchIndexFile) Reset()

func (*SearchIndexFile) SetCreatedAt 

func (m *SearchIndexFile) SetCreatedAt(v *timestamppb.Timestamp)

func (*SearchIndexFile) SetCreatedBy 

func (m *SearchIndexFile) SetCreatedBy(v string)

func (*SearchIndexFile) SetId 

func (m *SearchIndexFile) SetId(v string)

func (*SearchIndexFile) SetSearchIndexId 

func (m *SearchIndexFile) SetSearchIndexId(v string)

func (*SearchIndexFile) String 

func (x *SearchIndexFile) String() string

type SearchIndexFileServiceClient 

type SearchIndexFileServiceClient interface {
	// Creates multiple files within a search index in [asynchronous mode](/docs/foundation-models/concepts/#working-mode).
	BatchCreate(ctx context.Context, in *BatchCreateSearchIndexFileRequest, opts ...grpc.CallOption) (*operation.Operation, error)
	// Retrieves details of a specific file that has been indexed within a search index.
	Get(ctx context.Context, in *GetSearchIndexFileRequest, opts ...grpc.CallOption) (*SearchIndexFile, error)
	// List files that are indexed within a specific search index.
	List(ctx context.Context, in *ListSearchIndexFilesRequest, opts ...grpc.CallOption) (*ListSearchIndexFilesResponse, error)
}

SearchIndexFileServiceClient is the client API for SearchIndexFileService 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.

SearchIndexFileService provides operations for managing files within search indexes.

func NewSearchIndexFileServiceClient 

func NewSearchIndexFileServiceClient(cc grpc.ClientConnInterface) SearchIndexFileServiceClient

type SearchIndexFileServiceServer 

type SearchIndexFileServiceServer interface {
	// Creates multiple files within a search index in [asynchronous mode](/docs/foundation-models/concepts/#working-mode).
	BatchCreate(context.Context, *BatchCreateSearchIndexFileRequest) (*operation.Operation, error)
	// Retrieves details of a specific file that has been indexed within a search index.
	Get(context.Context, *GetSearchIndexFileRequest) (*SearchIndexFile, error)
	// List files that are indexed within a specific search index.
	List(context.Context, *ListSearchIndexFilesRequest) (*ListSearchIndexFilesResponse, error)
}

SearchIndexFileServiceServer is the server API for SearchIndexFileService service. All implementations should embed UnimplementedSearchIndexFileServiceServer for forward compatibility.

SearchIndexFileService provides operations for managing files within search indexes.

type SearchIndexServiceClient 

type SearchIndexServiceClient interface {
	// Create a new search index in [asynchronous mode](/docs/foundation-models/concepts/#working-mode).
	Create(ctx context.Context, in *CreateSearchIndexRequest, opts ...grpc.CallOption) (*operation.Operation, error)
	// Retrieve details of a specific search index by its ID.
	Get(ctx context.Context, in *GetSearchIndexRequest, opts ...grpc.CallOption) (*SearchIndex, error)
	// Update an existing search index.
	Update(ctx context.Context, in *UpdateSearchIndexRequest, opts ...grpc.CallOption) (*SearchIndex, error)
	// Delete a search index by its ID.
	Delete(ctx context.Context, in *DeleteSearchIndexRequest, opts ...grpc.CallOption) (*DeleteSearchIndexResponse, error)
	// List search indexes in a specific folder.
	List(ctx context.Context, in *ListSearchIndicesRequest, opts ...grpc.CallOption) (*ListSearchIndicesResponse, error)
}

SearchIndexServiceClient is the client API for SearchIndexService 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.

SearchIndexService provides operations for managing search indexes.

func NewSearchIndexServiceClient 

func NewSearchIndexServiceClient(cc grpc.ClientConnInterface) SearchIndexServiceClient

type SearchIndexServiceServer 

type SearchIndexServiceServer interface {
	// Create a new search index in [asynchronous mode](/docs/foundation-models/concepts/#working-mode).
	Create(context.Context, *CreateSearchIndexRequest) (*operation.Operation, error)
	// Retrieve details of a specific search index by its ID.
	Get(context.Context, *GetSearchIndexRequest) (*SearchIndex, error)
	// Update an existing search index.
	Update(context.Context, *UpdateSearchIndexRequest) (*SearchIndex, error)
	// Delete a search index by its ID.
	Delete(context.Context, *DeleteSearchIndexRequest) (*DeleteSearchIndexResponse, error)
	// List search indexes in a specific folder.
	List(context.Context, *ListSearchIndicesRequest) (*ListSearchIndicesResponse, error)
}

SearchIndexServiceServer is the server API for SearchIndexService service. All implementations should embed UnimplementedSearchIndexServiceServer for forward compatibility.

SearchIndexService provides operations for managing search indexes.

type SearchIndex_HybridSearchIndex 

type SearchIndex_HybridSearchIndex struct {
	// Hybrid (vector-based + keyword-based) search index configuration
	// This type is used for hybrid search, where documents are indexed using both keyword-based and vector-based search mechanisms.
	HybridSearchIndex *HybridSearchIndex `protobuf:"bytes,14,opt,name=hybrid_search_index,json=hybridSearchIndex,proto3,oneof"`
}

type SearchIndex_IndexType 

type SearchIndex_IndexType = isSearchIndex_IndexType

type SearchIndex_TextSearchIndex 

type SearchIndex_TextSearchIndex struct {
	// Keyword-based text search index configuration.
	// This type of index is used for traditional text search, where documents are indexed based on their keywords.
	TextSearchIndex *TextSearchIndex `protobuf:"bytes,12,opt,name=text_search_index,json=textSearchIndex,proto3,oneof"`
}

type SearchIndex_VectorSearchIndex 

type SearchIndex_VectorSearchIndex struct {
	// Vector-based search index configuration.
	// This type is used for vector search, where documents are indexed using vector embeddings.
	VectorSearchIndex *VectorSearchIndex `protobuf:"bytes,13,opt,name=vector_search_index,json=vectorSearchIndex,proto3,oneof"`
}

type StaticChunkingStrategy 

type StaticChunkingStrategy struct {

	// The maximum number of tokens allowed in a single chunk.
	// Constraints: must be within the range [100, 2048].
	// Default value: 800
	MaxChunkSizeTokens int64 `protobuf:"varint,1,opt,name=max_chunk_size_tokens,json=maxChunkSizeTokens,proto3" json:"max_chunk_size_tokens,omitempty"`
	// The number of tokens that should overlap between consecutive chunks.
	// This allows for some context from the previous chunk to be included in the next chunk.
	// Constraints: must be less than or equal to half of `max_chunk_size_tokens`.
	// Default value: 400
	ChunkOverlapTokens int64 `protobuf:"varint,2,opt,name=chunk_overlap_tokens,json=chunkOverlapTokens,proto3" json:"chunk_overlap_tokens,omitempty"`
	// contains filtered or unexported fields
}

Defines a chunking strategy where chunks are created with a fixed maximum chunk size and an overlap between consecutive chunks.

func (*StaticChunkingStrategy) Descriptor deprecated 

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

Deprecated: Use StaticChunkingStrategy.ProtoReflect.Descriptor instead.

func (*StaticChunkingStrategy) GetChunkOverlapTokens 

func (x *StaticChunkingStrategy) GetChunkOverlapTokens() int64

func (*StaticChunkingStrategy) GetMaxChunkSizeTokens 

func (x *StaticChunkingStrategy) GetMaxChunkSizeTokens() int64

func (*StaticChunkingStrategy) ProtoMessage 

func (*StaticChunkingStrategy) ProtoMessage()

func (*StaticChunkingStrategy) ProtoReflect 

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

func (*StaticChunkingStrategy) Reset 

func (x *StaticChunkingStrategy) Reset()

func (*StaticChunkingStrategy) SetChunkOverlapTokens 

func (m *StaticChunkingStrategy) SetChunkOverlapTokens(v int64)

func (*StaticChunkingStrategy) SetMaxChunkSizeTokens 

func (m *StaticChunkingStrategy) SetMaxChunkSizeTokens(v int64)

func (*StaticChunkingStrategy) String 

func (x *StaticChunkingStrategy) String() string

type TextSearchIndex 

type TextSearchIndex struct {

	// Chunking strategy used to split text into smaller chunks before indexing.
	// In the case of text search, tokens are individual text characters.
	ChunkingStrategy *ChunkingStrategy `protobuf:"bytes,1,opt,name=chunking_strategy,json=chunkingStrategy,proto3" json:"chunking_strategy,omitempty"`
	// contains filtered or unexported fields
}

Defines the configuration for a traditional keyword-based text search index.

func (*TextSearchIndex) Descriptor deprecated 

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

Deprecated: Use TextSearchIndex.ProtoReflect.Descriptor instead.

func (*TextSearchIndex) GetChunkingStrategy 

func (x *TextSearchIndex) GetChunkingStrategy() *ChunkingStrategy

func (*TextSearchIndex) ProtoMessage 

func (*TextSearchIndex) ProtoMessage()

func (*TextSearchIndex) ProtoReflect 

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

func (*TextSearchIndex) Reset 

func (x *TextSearchIndex) Reset()

func (*TextSearchIndex) SetChunkingStrategy 

func (m *TextSearchIndex) SetChunkingStrategy(v *ChunkingStrategy)

func (*TextSearchIndex) String 

func (x *TextSearchIndex) String() string

type UnimplementedSearchIndexFileServiceServer 

type UnimplementedSearchIndexFileServiceServer struct{}

UnimplementedSearchIndexFileServiceServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedSearchIndexFileServiceServer) BatchCreate 

func (UnimplementedSearchIndexFileServiceServer) BatchCreate(context.Context, *BatchCreateSearchIndexFileRequest) (*operation.Operation, error)

func (UnimplementedSearchIndexFileServiceServer) Get 

func (UnimplementedSearchIndexFileServiceServer) Get(context.Context, *GetSearchIndexFileRequest) (*SearchIndexFile, error)

func (UnimplementedSearchIndexFileServiceServer) List 

func (UnimplementedSearchIndexFileServiceServer) List(context.Context, *ListSearchIndexFilesRequest) (*ListSearchIndexFilesResponse, error)

type UnimplementedSearchIndexServiceServer 

type UnimplementedSearchIndexServiceServer struct{}

UnimplementedSearchIndexServiceServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedSearchIndexServiceServer) Create 

func (UnimplementedSearchIndexServiceServer) Create(context.Context, *CreateSearchIndexRequest) (*operation.Operation, error)

func (UnimplementedSearchIndexServiceServer) Delete 

func (UnimplementedSearchIndexServiceServer) Delete(context.Context, *DeleteSearchIndexRequest) (*DeleteSearchIndexResponse, error)

func (UnimplementedSearchIndexServiceServer) Get 

func (UnimplementedSearchIndexServiceServer) Get(context.Context, *GetSearchIndexRequest) (*SearchIndex, error)

func (UnimplementedSearchIndexServiceServer) List 

func (UnimplementedSearchIndexServiceServer) List(context.Context, *ListSearchIndicesRequest) (*ListSearchIndicesResponse, error)

func (UnimplementedSearchIndexServiceServer) Update 

func (UnimplementedSearchIndexServiceServer) Update(context.Context, *UpdateSearchIndexRequest) (*SearchIndex, error)

type UnsafeSearchIndexFileServiceServer 

type UnsafeSearchIndexFileServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeSearchIndexFileServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SearchIndexFileServiceServer will result in compilation errors.

type UnsafeSearchIndexServiceServer 

type UnsafeSearchIndexServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeSearchIndexServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SearchIndexServiceServer will result in compilation errors.

type UpdateSearchIndexRequest 

type UpdateSearchIndexRequest struct {

	// ID of the search index to update.
	SearchIndexId string `protobuf:"bytes,1,opt,name=search_index_id,json=searchIndexId,proto3" json:"search_index_id,omitempty"`
	// Field mask specifying which fields to update.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// New name for the search index.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// New description for the search index.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// New expiration configuration for the search index.
	ExpirationConfig *common.ExpirationConfig `protobuf:"bytes,5,opt,name=expiration_config,json=expirationConfig,proto3" json:"expiration_config,omitempty"`
	// New set of labels for the search index.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for updating an existing search index.

func (*UpdateSearchIndexRequest) Descriptor deprecated 

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

Deprecated: Use UpdateSearchIndexRequest.ProtoReflect.Descriptor instead.

func (*UpdateSearchIndexRequest) GetDescription 

func (x *UpdateSearchIndexRequest) GetDescription() string

func (*UpdateSearchIndexRequest) GetExpirationConfig 

func (x *UpdateSearchIndexRequest) GetExpirationConfig() *common.ExpirationConfig

func (*UpdateSearchIndexRequest) GetLabels 

func (x *UpdateSearchIndexRequest) GetLabels() map[string]string

func (*UpdateSearchIndexRequest) GetName 

func (x *UpdateSearchIndexRequest) GetName() string

func (*UpdateSearchIndexRequest) GetSearchIndexId 

func (x *UpdateSearchIndexRequest) GetSearchIndexId() string

func (*UpdateSearchIndexRequest) GetUpdateMask 

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

func (*UpdateSearchIndexRequest) ProtoMessage 

func (*UpdateSearchIndexRequest) ProtoMessage()

func (*UpdateSearchIndexRequest) ProtoReflect 

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

func (*UpdateSearchIndexRequest) Reset 

func (x *UpdateSearchIndexRequest) Reset()

func (*UpdateSearchIndexRequest) SetDescription 

func (m *UpdateSearchIndexRequest) SetDescription(v string)

func (*UpdateSearchIndexRequest) SetExpirationConfig 

func (m *UpdateSearchIndexRequest) SetExpirationConfig(v *common.ExpirationConfig)

func (*UpdateSearchIndexRequest) SetLabels 

func (m *UpdateSearchIndexRequest) SetLabels(v map[string]string)

func (*UpdateSearchIndexRequest) SetName 

func (m *UpdateSearchIndexRequest) SetName(v string)

func (*UpdateSearchIndexRequest) SetSearchIndexId 

func (m *UpdateSearchIndexRequest) SetSearchIndexId(v string)

func (*UpdateSearchIndexRequest) SetUpdateMask 

func (m *UpdateSearchIndexRequest) SetUpdateMask(v *fieldmaskpb.FieldMask)

func (*UpdateSearchIndexRequest) String 

func (x *UpdateSearchIndexRequest) String() string

type VectorSearchIndex 

type VectorSearchIndex struct {

	// The [ID of the model](/docs/foundation-models/concepts/embeddings) to be used for obtaining document text embeddings.
	DocEmbedderUri string `protobuf:"bytes,1,opt,name=doc_embedder_uri,json=docEmbedderUri,proto3" json:"doc_embedder_uri,omitempty"`
	// The [ID of the model](/docs/foundation-models/concepts/embeddings) to be used for obtaining query text embeddings.
	QueryEmbedderUri string `protobuf:"bytes,2,opt,name=query_embedder_uri,json=queryEmbedderUri,proto3" json:"query_embedder_uri,omitempty"`
	// Chunking strategy used to split text into smaller chunks before indexing.
	// In the case of vector search, tokens are produced by the tokenizer from the embedding model.
	ChunkingStrategy *ChunkingStrategy `protobuf:"bytes,3,opt,name=chunking_strategy,json=chunkingStrategy,proto3" json:"chunking_strategy,omitempty"`
	// contains filtered or unexported fields
}

Defines the configuration for a vector-based search index. This type uses embeddings to represent documents and queries.

func (*VectorSearchIndex) Descriptor deprecated 

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

Deprecated: Use VectorSearchIndex.ProtoReflect.Descriptor instead.

func (*VectorSearchIndex) GetChunkingStrategy 

func (x *VectorSearchIndex) GetChunkingStrategy() *ChunkingStrategy

func (*VectorSearchIndex) GetDocEmbedderUri 

func (x *VectorSearchIndex) GetDocEmbedderUri() string

func (*VectorSearchIndex) GetQueryEmbedderUri 

func (x *VectorSearchIndex) GetQueryEmbedderUri() string

func (*VectorSearchIndex) ProtoMessage 

func (*VectorSearchIndex) ProtoMessage()

func (*VectorSearchIndex) ProtoReflect 

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

func (*VectorSearchIndex) Reset 

func (x *VectorSearchIndex) Reset()

func (*VectorSearchIndex) SetChunkingStrategy 

func (m *VectorSearchIndex) SetChunkingStrategy(v *ChunkingStrategy)

func (*VectorSearchIndex) SetDocEmbedderUri 

func (m *VectorSearchIndex) SetDocEmbedderUri(v string)

func (*VectorSearchIndex) SetQueryEmbedderUri 

func (m *VectorSearchIndex) SetQueryEmbedderUri(v string)

func (*VectorSearchIndex) String 

func (x *VectorSearchIndex) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.