All Classes

Class Description
AnswerWithSources
Model class for QA output with sources
AzureOpenAiChatCompletionsChain
OpenAiChatCompletionsChain adopted for usage of Azure OpenAI Services
AzureOpenAiCompletionsChain
OpenAiCompletionsChain adopted for usage of Azure OpenAI Services
Chain<I,​O>
Basic interface for all modular components in this repository.
CombineDocumentsChain
This Chain is used to combine multiple retrieved documents into one prompt which can then be used to target a LLM in subsequent steps.
LargeLanguageModelChain
Parent of all Chains which allow passing input to a large language model.
LuceneRetrievalChain
This RetrievalChain retrieves documents from a lucene index
MapAnswerWithSourcesChain
Splits answers with sources from a QA chain.
OpenAiChain<P extends OpenAiParameters<P>,​I extends P,​O extends OpenAiResponse<?>>
LargeLanguageModelChain for usage with the OpenAI /completions API
OpenAiChatCompletionsChain
OpenAiChain for usage with the OpenAI /chat/completions API
OpenAiChatCompletionsChoice
Model class for choices in an OpenAI /chat/completions response
OpenAiChatCompletionsParameters
Parameters for calling an OpenAI Chat Model https://platform.openai.com/docs/api-reference/chat/create
OpenAiChatCompletionsRequest
Model class for the OpenAI /chat/completions request body
OpenAiChatCompletionsResponse
Model class for the response body of an OpenAI /chat/completions request
OpenAiChatMessage
Model class for request and response messages of an OpenAI /chat/completions request
OpenAiCompletionsChain
OpenAiChain for usage with the OpenAI /completions API
OpenAiCompletionsChoice
Model class for choices in an OpenAI /completions response
OpenAiCompletionsParameters
Parameters for calling an OpenAI Completions Model https://platform.openai.com/docs/api-reference/completions/create
OpenAiCompletionsRequest
Model class for the OpenAI /completions request body
OpenAiCompletionsResponse
Model class for the response body of an OpenAI /completions request
OpenAiParameters<T extends OpenAiParameters<T>>
Contains the intersection of parameters for the /chat/completions and /completions api
OpenAiResponse<C>
Model class for the response body of an OpenAI request
PromptConstants
Utility Class which holds constants for prompt placeholders
PromptTemplates
this utility class holds templates for various prompts
ReadDocumentsFromPdfChain
Utilizes Apache PDFBox to read documents from a folder of PDFs
RetrievalChain
Chain which is utilized for retrieving documents in a QA context
SummarizeDocumentsChain
Chain that takes documents as input and summarizes them using a llm chain that is passed as a constructor param.
WriteDocumentsToLuceneDirectoryChain
Stores documents in a lucene Directory