Keyword Table Retrieversο
Query for KeywordTableIndex.
- class llama_index.indices.keyword_table.retrievers.BaseKeywordTableRetriever(index: BaseKeywordTableIndex, keyword_extract_template: Optional[BasePromptTemplate] = None, query_keyword_extract_template: Optional[BasePromptTemplate] = None, max_keywords_per_query: int = 10, num_chunks_per_query: int = 10, callback_manager: Optional[CallbackManager] = None, **kwargs: Any)ο
Base Keyword Table Retriever.
Arguments are shared among subclasses.
- Parameters
keyword_extract_template (Optional[BasePromptTemplate]) β A Keyword Extraction Prompt (see Prompt Templates).
query_keyword_extract_template (Optional[BasePromptTemplate]) β A Query Keyword Extraction Prompt (see Prompt Templates).
refine_template (Optional[BasePromptTemplate]) β A Refinement Prompt (see Prompt Templates).
text_qa_template (Optional[BasePromptTemplate]) β A Question Answering Prompt (see Prompt Templates).
max_keywords_per_query (int) β Maximum number of keywords to extract from query.
num_chunks_per_query (int) β Maximum number of text chunks to query.
- get_prompts() Dict[str, BasePromptTemplate] ο
Get a prompt.
- get_service_context() Optional[ServiceContext] ο
Attempts to resolve a service context. Short-circuits at self.service_context, self._service_context, or self._index.service_context.
- retrieve(str_or_query_bundle: Union[str, QueryBundle]) List[NodeWithScore] ο
Retrieve nodes given query.
- Parameters
str_or_query_bundle (QueryType) β Either a query string or a QueryBundle object.
- update_prompts(prompts_dict: Dict[str, BasePromptTemplate]) None ο
Update prompts.
Other prompts will remain in place.
- class llama_index.indices.keyword_table.retrievers.KeywordTableGPTRetriever(index: BaseKeywordTableIndex, keyword_extract_template: Optional[BasePromptTemplate] = None, query_keyword_extract_template: Optional[BasePromptTemplate] = None, max_keywords_per_query: int = 10, num_chunks_per_query: int = 10, callback_manager: Optional[CallbackManager] = None, **kwargs: Any)ο
Keyword Table Index GPT Retriever.
Extracts keywords using GPT. Set when using retriever_mode=βdefaultβ.
See BaseGPTKeywordTableQuery for arguments.
- get_prompts() Dict[str, BasePromptTemplate] ο
Get a prompt.
- get_service_context() Optional[ServiceContext] ο
Attempts to resolve a service context. Short-circuits at self.service_context, self._service_context, or self._index.service_context.
- retrieve(str_or_query_bundle: Union[str, QueryBundle]) List[NodeWithScore] ο
Retrieve nodes given query.
- Parameters
str_or_query_bundle (QueryType) β Either a query string or a QueryBundle object.
- update_prompts(prompts_dict: Dict[str, BasePromptTemplate]) None ο
Update prompts.
Other prompts will remain in place.
- class llama_index.indices.keyword_table.retrievers.KeywordTableRAKERetriever(index: BaseKeywordTableIndex, keyword_extract_template: Optional[BasePromptTemplate] = None, query_keyword_extract_template: Optional[BasePromptTemplate] = None, max_keywords_per_query: int = 10, num_chunks_per_query: int = 10, callback_manager: Optional[CallbackManager] = None, **kwargs: Any)ο
Keyword Table Index RAKE Retriever.
Extracts keywords using RAKE keyword extractor. Set when retriever_mode=βrakeβ.
See BaseGPTKeywordTableQuery for arguments.
- get_prompts() Dict[str, BasePromptTemplate] ο
Get a prompt.
- get_service_context() Optional[ServiceContext] ο
Attempts to resolve a service context. Short-circuits at self.service_context, self._service_context, or self._index.service_context.
- retrieve(str_or_query_bundle: Union[str, QueryBundle]) List[NodeWithScore] ο
Retrieve nodes given query.
- Parameters
str_or_query_bundle (QueryType) β Either a query string or a QueryBundle object.
- update_prompts(prompts_dict: Dict[str, BasePromptTemplate]) None ο
Update prompts.
Other prompts will remain in place.
- class llama_index.indices.keyword_table.retrievers.KeywordTableSimpleRetriever(index: BaseKeywordTableIndex, keyword_extract_template: Optional[BasePromptTemplate] = None, query_keyword_extract_template: Optional[BasePromptTemplate] = None, max_keywords_per_query: int = 10, num_chunks_per_query: int = 10, callback_manager: Optional[CallbackManager] = None, **kwargs: Any)ο
Keyword Table Index Simple Retriever.
Extracts keywords using simple regex-based keyword extractor. Set when retriever_mode=βsimpleβ.
See BaseGPTKeywordTableQuery for arguments.
- get_prompts() Dict[str, BasePromptTemplate] ο
Get a prompt.
- get_service_context() Optional[ServiceContext] ο
Attempts to resolve a service context. Short-circuits at self.service_context, self._service_context, or self._index.service_context.
- retrieve(str_or_query_bundle: Union[str, QueryBundle]) List[NodeWithScore] ο
Retrieve nodes given query.
- Parameters
str_or_query_bundle (QueryType) β Either a query string or a QueryBundle object.
- update_prompts(prompts_dict: Dict[str, BasePromptTemplate]) None ο
Update prompts.
Other prompts will remain in place.