Index

A

append() (ragrank.dataset.base.Dataset method) (ragrank.dataset.Dataset method)

B

BaseLLM (class in ragrank.llm) (class in ragrank.llm.base)

BaseMetric (class in ragrank.metric) (class in ragrank.metric.base)

C

ColumnMap (class in ragrank.dataset) (class in ragrank.dataset.reader) config (ragrank.metric.CustomInstruct attribute) context (ragrank.dataset.base.DataNode attribute) (ragrank.dataset.base.Dataset attribute) (ragrank.dataset.ColumnMap attribute) (ragrank.dataset.DataNode attribute) (ragrank.dataset.Dataset attribute) (ragrank.dataset.reader.ColumnMap attribute)

CustomInstruct (class in ragrank.metric) CustomMetric (class in ragrank.metric)

D

DataNode (class in ragrank.dataset) (class in ragrank.dataset.base) datanode (ragrank.metric.base.MetricResult attribute) (ragrank.metric.MetricResult attribute) Dataset (class in ragrank.dataset) (class in ragrank.dataset.base)

dataset (ragrank.evaluation.EvalResult attribute) (ragrank.evaluation.outputs.EvalResult attribute) default_llm() (in module ragrank.llm) (in module ragrank.llm.base)

E

eval_cell() (in module ragrank.utils.common) EvalResult (class in ragrank.evaluation) (class in ragrank.evaluation.outputs) evaluate() (in module ragrank) (in module ragrank.evaluation) (in module ragrank.evaluation.base)

examples (ragrank.metric.InstructConfig attribute) (ragrank.prompt.base.Prompt attribute) (ragrank.prompt.Prompt attribute)

F

finish_reason (ragrank.llm.base.LLMResult attribute) (ragrank.llm.LLMResult attribute) from_csv() (in module ragrank.dataset) (in module ragrank.dataset.reader) from_dataframe() (in module ragrank.dataset) (in module ragrank.dataset.reader)

from_dict() (in module ragrank.dataset) (in module ragrank.dataset.reader) from_hfdataset() (in module ragrank.dataset) (in module ragrank.dataset.reader)

G

generate() (ragrank.llm.base.BaseLLM method), [1] (ragrank.llm.BaseLLM method), [1] generate_text() (ragrank.integrations.langchain.langchain_llm_wrapper.LangchainLLMWrapper method), [1] (ragrank.integrations.langchain.LangchainLLMWrapper method), [1] (ragrank.integrations.llama_index.llamaindex_llm_wrapper.LlamaindexLLMWrapper method), [1] (ragrank.integrations.llama_index.LlamaindexLLMWrapper method), [1] (ragrank.integrations.openai.openai_llm.OpenaiLLM method), [1] (ragrank.integrations.openai.OpenaiLLM method), [1] (ragrank.llm.base.BaseLLM method), [1] (ragrank.llm.BaseLLM method), [1]

get_env_var() (in module ragrank.utils.llm) get_examples() (ragrank.prompt.base.Prompt method) (ragrank.prompt.Prompt method)

I

input_fields (ragrank.metric.InstructConfig attribute) input_keys (ragrank.prompt.base.Prompt attribute) (ragrank.prompt.Prompt attribute)

InstructConfig (class in ragrank.metric) instructions (ragrank.metric.InstructConfig attribute) (ragrank.prompt.base.Prompt attribute) (ragrank.prompt.Prompt attribute)

L

LangchainLLMWrapper (class in ragrank.integrations.langchain) (class in ragrank.integrations.langchain.langchain_llm_wrapper) LlamaindexLLMWrapper (class in ragrank.integrations.llama_index) (class in ragrank.integrations.llama_index.llamaindex_llm_wrapper) llm (ragrank.evaluation.EvalResult attribute) (ragrank.evaluation.outputs.EvalResult attribute) (ragrank.integrations.langchain.langchain_llm_wrapper.LangchainLLMWrapper attribute) (ragrank.integrations.langchain.LangchainLLMWrapper attribute) (ragrank.integrations.llama_index.llamaindex_llm_wrapper.LlamaindexLLMWrapper attribute) (ragrank.integrations.llama_index.LlamaindexLLMWrapper attribute) (ragrank.llm.base.LLMResult attribute) (ragrank.llm.LLMResult attribute) (ragrank.metric.base.BaseMetric attribute) (ragrank.metric.BaseMetric attribute) (ragrank.metric.CustomInstruct attribute) (ragrank.metric.CustomMetric attribute)

llm_config (ragrank.llm.base.BaseLLM attribute) (ragrank.llm.base.LLMResult attribute) (ragrank.llm.BaseLLM attribute) (ragrank.llm.LLMResult attribute) llm_name (ragrank.integrations.langchain.langchain_llm_wrapper.LangchainLLMWrapper property) (ragrank.integrations.langchain.LangchainLLMWrapper property) (ragrank.integrations.llama_index.llamaindex_llm_wrapper.LlamaindexLLMWrapper property) (ragrank.integrations.llama_index.LlamaindexLLMWrapper property) LLMConfig (class in ragrank.llm) (class in ragrank.llm.base) LLMResult (class in ragrank.llm) (class in ragrank.llm.base) load() (ragrank.metric.base.BaseMetric method) (ragrank.metric.BaseMetric method) (ragrank.prompt.base.Prompt method) (ragrank.prompt.Prompt method)

M

max_tokens (ragrank.llm.base.LLMConfig attribute) (ragrank.llm.LLMConfig attribute) metric_name (ragrank.metric.CustomMetric property) metric_score() (ragrank.metric.CustomMetric method) metric_type (ragrank.metric.base.BaseMetric attribute) (ragrank.metric.BaseMetric attribute) (ragrank.metric.InstructConfig attribute) MetricResult (class in ragrank.metric) (class in ragrank.metric.base) metrics (ragrank.evaluation.EvalResult attribute) (ragrank.evaluation.outputs.EvalResult attribute) (ragrank.metric.base.MetricResult attribute) (ragrank.metric.MetricResult attribute) MetricType (class in ragrank.metric.base) model_computed_fields (ragrank.dataset.base.DataNode attribute) (ragrank.dataset.base.Dataset attribute) (ragrank.dataset.ColumnMap attribute) (ragrank.dataset.DataNode attribute) (ragrank.dataset.Dataset attribute) (ragrank.dataset.reader.ColumnMap attribute) (ragrank.evaluation.EvalResult attribute) (ragrank.evaluation.outputs.EvalResult attribute) (ragrank.integrations.langchain.langchain_llm_wrapper.LangchainLLMWrapper attribute) (ragrank.integrations.langchain.LangchainLLMWrapper attribute) (ragrank.integrations.llama_index.llamaindex_llm_wrapper.LlamaindexLLMWrapper attribute) (ragrank.integrations.llama_index.LlamaindexLLMWrapper attribute) (ragrank.integrations.openai.openai_llm.OpenaiLLM attribute) (ragrank.integrations.openai.OpenaiLLM attribute) (ragrank.llm.base.BaseLLM attribute) (ragrank.llm.base.LLMConfig attribute) (ragrank.llm.base.LLMResult attribute) (ragrank.llm.BaseLLM attribute) (ragrank.llm.LLMConfig attribute) (ragrank.llm.LLMResult attribute) (ragrank.metric.base.BaseMetric attribute) (ragrank.metric.base.MetricResult attribute) (ragrank.metric.BaseMetric attribute) (ragrank.metric.CustomInstruct attribute) (ragrank.metric.CustomMetric attribute) (ragrank.metric.InstructConfig attribute) (ragrank.metric.MetricResult attribute) (ragrank.prompt.base.Prompt attribute) (ragrank.prompt.Prompt attribute) model_config (ragrank.dataset.base.DataNode attribute) (ragrank.dataset.base.Dataset attribute) (ragrank.dataset.ColumnMap attribute) (ragrank.dataset.DataNode attribute) (ragrank.dataset.Dataset attribute) (ragrank.dataset.reader.ColumnMap attribute) (ragrank.evaluation.EvalResult attribute) (ragrank.evaluation.outputs.EvalResult attribute) (ragrank.integrations.langchain.langchain_llm_wrapper.LangchainLLMWrapper attribute) (ragrank.integrations.langchain.LangchainLLMWrapper attribute) (ragrank.integrations.llama_index.llamaindex_llm_wrapper.LlamaindexLLMWrapper attribute) (ragrank.integrations.llama_index.LlamaindexLLMWrapper attribute) (ragrank.integrations.openai.openai_llm.OpenaiLLM attribute) (ragrank.integrations.openai.OpenaiLLM attribute) (ragrank.llm.base.BaseLLM attribute) (ragrank.llm.base.LLMConfig attribute) (ragrank.llm.base.LLMResult attribute) (ragrank.llm.BaseLLM attribute) (ragrank.llm.LLMConfig attribute) (ragrank.llm.LLMResult attribute) (ragrank.metric.base.BaseMetric attribute) (ragrank.metric.base.MetricResult attribute) (ragrank.metric.BaseMetric attribute) (ragrank.metric.CustomInstruct attribute) (ragrank.metric.CustomMetric attribute) (ragrank.metric.InstructConfig attribute) (ragrank.metric.MetricResult attribute) (ragrank.prompt.base.Prompt attribute) (ragrank.prompt.Prompt attribute)

model_fields (ragrank.dataset.base.DataNode attribute) (ragrank.dataset.base.Dataset attribute) (ragrank.dataset.ColumnMap attribute) (ragrank.dataset.DataNode attribute) (ragrank.dataset.Dataset attribute) (ragrank.dataset.reader.ColumnMap attribute) (ragrank.evaluation.EvalResult attribute) (ragrank.evaluation.outputs.EvalResult attribute) (ragrank.integrations.langchain.langchain_llm_wrapper.LangchainLLMWrapper attribute) (ragrank.integrations.langchain.LangchainLLMWrapper attribute) (ragrank.integrations.llama_index.llamaindex_llm_wrapper.LlamaindexLLMWrapper attribute) (ragrank.integrations.llama_index.LlamaindexLLMWrapper attribute) (ragrank.integrations.openai.openai_llm.OpenaiLLM attribute) (ragrank.integrations.openai.OpenaiLLM attribute) (ragrank.llm.base.BaseLLM attribute) (ragrank.llm.base.LLMConfig attribute) (ragrank.llm.base.LLMResult attribute) (ragrank.llm.BaseLLM attribute) (ragrank.llm.LLMConfig attribute) (ragrank.llm.LLMResult attribute) (ragrank.metric.base.BaseMetric attribute) (ragrank.metric.base.MetricResult attribute) (ragrank.metric.BaseMetric attribute) (ragrank.metric.CustomInstruct attribute) (ragrank.metric.CustomMetric attribute) (ragrank.metric.InstructConfig attribute) (ragrank.metric.MetricResult attribute) (ragrank.prompt.base.Prompt attribute) (ragrank.prompt.Prompt attribute) model_post_init() (ragrank.metric.CustomInstruct method) module ragrank.bridge ragrank.bridge.pydantic ragrank.dataset ragrank.dataset.base ragrank.dataset.reader ragrank.evaluation ragrank.evaluation.base ragrank.evaluation.outputs ragrank.integrations ragrank.integrations.langchain ragrank.integrations.langchain.langchain_llm_wrapper ragrank.integrations.llama_index ragrank.integrations.llama_index.llamaindex_llm_wrapper ragrank.integrations.openai ragrank.integrations.openai.openai_llm ragrank.llm ragrank.llm.base ragrank.metric ragrank.metric.base ragrank.prompt ragrank.prompt.base ragrank.utils ragrank.utils.common ragrank.utils.llm

N

name (ragrank.integrations.langchain.langchain_llm_wrapper.LangchainLLMWrapper property) (ragrank.integrations.langchain.LangchainLLMWrapper property) (ragrank.integrations.llama_index.llamaindex_llm_wrapper.LlamaindexLLMWrapper property) (ragrank.integrations.llama_index.LlamaindexLLMWrapper property) (ragrank.integrations.openai.openai_llm.OpenaiLLM attribute) (ragrank.integrations.openai.openai_llm.OpenaiLLM property) (ragrank.integrations.openai.OpenaiLLM attribute) (ragrank.integrations.openai.OpenaiLLM property) (ragrank.llm.base.BaseLLM property) (ragrank.llm.BaseLLM property) (ragrank.metric.base.BaseMetric property) (ragrank.metric.BaseMetric property) (ragrank.metric.CustomInstruct property) (ragrank.metric.CustomMetric property) (ragrank.metric.InstructConfig attribute) (ragrank.prompt.base.Prompt attribute) (ragrank.prompt.Prompt attribute)

name() (ragrank.metric.CustomInstruct method) (ragrank.metric.CustomMetric method)

O

OpenaiLLM (class in ragrank.integrations.openai) (class in ragrank.integrations.openai.openai_llm)

output_field (ragrank.metric.InstructConfig attribute) output_key (ragrank.prompt.base.Prompt attribute) (ragrank.prompt.Prompt attribute)

P

process_time (ragrank.metric.base.MetricResult attribute) (ragrank.metric.MetricResult attribute) Prompt (class in ragrank.prompt) (class in ragrank.prompt.base)

prompt (ragrank.metric.base.BaseMetric attribute) (ragrank.metric.BaseMetric attribute) (ragrank.metric.CustomInstruct attribute) (ragrank.metric.CustomMetric attribute) prompt_str (ragrank.integrations.langchain.langchain_llm_wrapper.RagrankPromptValue attribute)

Q

question (ragrank.dataset.base.DataNode attribute) (ragrank.dataset.base.Dataset attribute) (ragrank.dataset.ColumnMap attribute) (ragrank.dataset.DataNode attribute) (ragrank.dataset.Dataset attribute) (ragrank.dataset.reader.ColumnMap attribute)

R

ragrank.bridge module ragrank.bridge.pydantic module ragrank.dataset module ragrank.dataset.base module ragrank.dataset.reader module ragrank.evaluation module ragrank.evaluation.base module ragrank.evaluation.outputs module ragrank.integrations module ragrank.integrations.langchain module ragrank.integrations.langchain.langchain_llm_wrapper module ragrank.integrations.llama_index module ragrank.integrations.llama_index.llamaindex_llm_wrapper module ragrank.integrations.openai module ragrank.integrations.openai.openai_llm module ragrank.llm module

ragrank.llm.base module ragrank.metric module ragrank.metric.base module ragrank.prompt module ragrank.prompt.base module ragrank.utils module ragrank.utils.common module ragrank.utils.llm module RagrankPromptValue (class in ragrank.integrations.langchain.langchain_llm_wrapper) reasons (ragrank.metric.base.MetricResult attribute) (ragrank.metric.MetricResult attribute) response (ragrank.dataset.base.DataNode attribute) (ragrank.dataset.base.Dataset attribute) (ragrank.dataset.ColumnMap attribute) (ragrank.dataset.DataNode attribute) (ragrank.dataset.Dataset attribute) (ragrank.dataset.reader.ColumnMap attribute) (ragrank.llm.base.LLMResult attribute) (ragrank.llm.LLMResult attribute) response_time (ragrank.evaluation.EvalResult attribute) (ragrank.evaluation.outputs.EvalResult attribute) (ragrank.llm.base.LLMResult attribute) (ragrank.llm.LLMResult attribute) response_tokens (ragrank.llm.base.LLMResult attribute) (ragrank.llm.LLMResult attribute)

S

save() (ragrank.metric.base.BaseMetric method) (ragrank.metric.BaseMetric method) (ragrank.prompt.base.Prompt method) (ragrank.prompt.Prompt method) score() (ragrank.metric.base.BaseMetric method) (ragrank.metric.BaseMetric method) (ragrank.metric.CustomInstruct method) (ragrank.metric.CustomMetric method) scores (ragrank.evaluation.EvalResult attribute) (ragrank.evaluation.outputs.EvalResult attribute) (ragrank.metric.base.MetricResult attribute) (ragrank.metric.MetricResult attribute)

seed (ragrank.llm.base.LLMConfig attribute) (ragrank.llm.LLMConfig attribute) send_request() (in module ragrank.utils.common) set_config() (ragrank.llm.base.BaseLLM method), [1] (ragrank.llm.BaseLLM method), [1] stop (ragrank.llm.base.LLMConfig attribute) (ragrank.llm.LLMConfig attribute)

T

temperature (ragrank.llm.base.LLMConfig attribute) (ragrank.llm.LLMConfig attribute) to_csv() (ragrank.dataset.base.Dataset method) (ragrank.dataset.Dataset method) to_dataframe() (ragrank.dataset.base.Dataset method) (ragrank.dataset.Dataset method) (ragrank.evaluation.EvalResult method) (ragrank.evaluation.outputs.EvalResult method) to_dataset() (ragrank.dataset.base.DataNode method) (ragrank.dataset.DataNode method)

to_dict() (ragrank.dataset.base.Dataset method) (ragrank.dataset.Dataset method) (ragrank.evaluation.EvalResult method) (ragrank.evaluation.outputs.EvalResult method) to_messages() (ragrank.integrations.langchain.langchain_llm_wrapper.RagrankPromptValue method) to_prompt() (ragrank.metric.InstructConfig method), [1] to_string() (ragrank.integrations.langchain.langchain_llm_wrapper.RagrankPromptValue method) (ragrank.prompt.base.Prompt method) (ragrank.prompt.Prompt method) top_p (ragrank.llm.base.LLMConfig attribute) (ragrank.llm.LLMConfig attribute)

V

validate_prompt() (ragrank.prompt.base.Prompt method) (ragrank.prompt.Prompt method) validator() (ragrank.dataset.base.Dataset method) (ragrank.dataset.Dataset method) (ragrank.evaluation.EvalResult method) (ragrank.evaluation.outputs.EvalResult method) (ragrank.integrations.langchain.langchain_llm_wrapper.LangchainLLMWrapper class method) (ragrank.integrations.langchain.LangchainLLMWrapper class method) (ragrank.integrations.llama_index.llamaindex_llm_wrapper.LlamaindexLLMWrapper class method) (ragrank.integrations.llama_index.LlamaindexLLMWrapper class method)

W

with_progress() (ragrank.dataset.base.Dataset method) (ragrank.dataset.Dataset method)