diff --git a/docs/CNAME b/docs/CNAME
index f03ffc4..8da4ee3 100644
--- a/docs/CNAME
+++ b/docs/CNAME
@@ -1 +1 @@
-docs-hub.giskard.ai
\ No newline at end of file
+docs-hub.giskard.ai
diff --git a/docs/README.html b/docs/README.html
index 62b21ec..ab9a0db 100644
--- a/docs/README.html
+++ b/docs/README.html
@@ -81,7 +81,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="cli.html">CLI docs</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Code</span></p>
+<p class="caption" role="heading"><span class="caption-text">Code Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="sources.html">Client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sources.html#cli">CLI</a></li>
diff --git a/docs/_sources/index.md.txt b/docs/_sources/index.md.txt
index f942a5d..6e9d47c 100644
--- a/docs/_sources/index.md.txt
+++ b/docs/_sources/index.md.txt
@@ -28,12 +28,13 @@ README
 ```{toctree}
 :caption: CLI
 :maxdepth: 3
+:hidden:
 ./cli
 ```
 
 
 ```{toctree}
-:caption: Code
+:caption: Code Documentation
 :maxdepth: 2
 :hidden:
 
diff --git a/docs/cli.html b/docs/cli.html
index d4f44e2..7312b64 100644
--- a/docs/cli.html
+++ b/docs/cli.html
@@ -81,7 +81,7 @@
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">CLI docs</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Code</span></p>
+<p class="caption" role="heading"><span class="caption-text">Code Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="sources.html">Client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sources.html#cli">CLI</a></li>
diff --git a/docs/genindex.html b/docs/genindex.html
index 5e953d1..df5944f 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -112,7 +112,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="cli.html">CLI docs</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Code</span></p>
+<p class="caption" role="heading"><span class="caption-text">Code Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="sources.html">Client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sources.html#cli">CLI</a></li>
diff --git a/docs/index.html b/docs/index.html
index 4d5daf0..c7a6c31 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -80,7 +80,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="cli.html">CLI docs</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Code</span></p>
+<p class="caption" role="heading"><span class="caption-text">Code Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="sources.html">Client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sources.html#cli">CLI</a></li>
@@ -109,23 +109,7 @@ <h1>Welcome to the Giskard Hub’s client docs!<a class="headerlink" href="#welc
 upload LLM agent outputs to the Giskard Hub and execute evaluations from a notebook, script or CLI.</p>
 
 
-<div class="toctree-wrapper compound">
-<p class="caption" role="heading"><span class="caption-text">CLI</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="cli.html">CLI docs</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="cli.html#python-m-giskard-hub-cli">python -m giskard_hub.cli</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#python-m-giskard-hub-cli-datasets">datasets</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#python-m-giskard-hub-cli-evaluate">evaluate</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#python-m-giskard-hub-cli-models">models</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#python-m-giskard-hub-cli-projects">projects</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#python-m-giskard-hub-cli-results">results</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#python-m-giskard-hub-cli-update-evaluations">update-evaluations</a></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</div>
+
 
 
 </section>
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
index eea119f..f056f42 100644
--- a/docs/py-modindex.html
+++ b/docs/py-modindex.html
@@ -115,7 +115,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="cli.html">CLI docs</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Code</span></p>
+<p class="caption" role="heading"><span class="caption-text">Code Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="sources.html">Client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sources.html#cli">CLI</a></li>
diff --git a/docs/search.html b/docs/search.html
index a71bedc..c779e16 100644
--- a/docs/search.html
+++ b/docs/search.html
@@ -112,7 +112,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="cli.html">CLI docs</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Code</span></p>
+<p class="caption" role="heading"><span class="caption-text">Code Documentation</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="sources.html">Client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sources.html#cli">CLI</a></li>
diff --git a/docs/searchindex.js b/docs/searchindex.js
index e87ca20..9f76076 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["README", "cli", "index", "sources"], "filenames": ["README.md", "cli.rst", "index.md", "sources.rst"], "titles": ["Quick Start", "CLI docs", "Welcome to the Giskard Hub\u2019s client docs!", "Client"], "terms": {"initi": 0, "client": 0, "giskard_hub": [0, 2], "import": 0, "hubclient": [0, 3], "note": 0, "api": [0, 1], "kei": [0, 1, 3], "hub": [0, 1, 3], "url": [0, 1, 3], "can": 0, "also": 0, "provid": [0, 1, 2, 3], "set": 0, "env": 0, "variabl": [0, 1], "gsk_api_kei": [0, 1], "gsk_hub_url": [0, 1], "api_kei": [0, 1, 3], "hub_url": [0, 1, 3], "next": 0, "retriev": 0, "relev": 0, "object": [0, 3], "server": 0, "project": [0, 2, 3], "model": [0, 2, 3], "data": [0, 2], "get_project": [0, 3], "0": 0, "get_model": [0, 3], "id": [0, 1, 3], "get_dataset": [0, 3], "you": [0, 2], "launch": 0, "an": [0, 1, 3], "which": 0, "download": [0, 1, 2, 3], "sent": 0, "llm": [0, 2, 3], "agent": [0, 1, 2, 3], "complet": [0, 1], "type": [0, 3], "list": [0, 1, 3], "thi": 0, "contain": [0, 1, 3], "messag": [0, 3], "expect": [0, 3], "output": [0, 1, 2, 3], "polici": [0, 3], "tag": [0, 1, 3], "etc": 0, "to_complet": 0, "model_id": [0, 1, 3], "dataset_id": [0, 1, 3], "send": 0, "dummi": 0, "def": 0, "dummy_model": 0, "all_data": 0, "simul": 0, "call": [0, 3], "updat": [0, 2, 3], "set_output": [0, 3], "sorri": 0, "i": [0, 1, 3], "t": 0, "answer": [0, 3], "question": 0, "altern": 0, "could": 0, "done": 0, "like": 0, "modeloutput": [0, 3], "respons": [0, 3], "llmmessag": [0, 3], "role": [0, 3], "assist": [0, 3], "content": [0, 3], "metadata": [0, 3], "elt": 0, "push": [0, 1, 3], "element": 0, "process": [0, 2], "update_evalu": [0, 3], "either": 0, "head": 0, "inspect": 0, "result": [0, 2, 3], "detail": 0, "get": [0, 1, 2, 3], "summar": 0, "directli": 0, "develop": [0, 2], "environ": [0, 1], "extract": 0, "execution_id": [0, 1, 3], "get_result": [0, 3], "__name__": 0, "__main__": 0, "print": 0, "got": 0, "bin": 0, "bash": 0, "eu": 0, "avoid": [0, 2], "give": 0, "info": [0, 3], "everytim": 0, "export": 0, "folder_path": [0, 1, 3], "test": [0, 2, 3], "folder": [0, 1, 3], "rm": 0, "rf": 0, "mkdir": 0, "p": 0, "project_id": [0, 1, 3], "m": [0, 2], "jq": 0, "raw": 0, "path": [0, 1, 3], "local": [0, 1, 3], "mode": [0, 1, 3], "find": 0, "f": 0, "grep": 0, "json": [0, 1], "n1": 0, "xarg": 0, "follow": 0, "line": 0, "fake": 0, "chang": 0, "sed": 0, "": [0, 3], "null": 0, "cant": 0, "g": 0, "sh": 0, "execut": [0, 1, 2, 3], "initialis": [0, 3], "2b437295": 0, "dabe": 0, "4084": 0, "ba03": 0, "cdb259e3e678": 0, "http": 0, "backend": [0, 1], "localhost": 0, "single_ev": [0, 3], "transientevalu": [0, 3], "user": [0, 3], "what": 0, "color": 0, "orang": 0, "model_output": [0, 3], "green": 0, "model_descript": [0, 3], "ar": [0, 2, 3], "inform": 0, "about": [0, 3], "fruit": 0, "must": 0, "never": 0, "sai": 0, "word": 0, "polit": 0, "expected_output": [0, 3], "option": [1, 3], "command": 1, "arg": 1, "given": [1, 3], "us": [1, 3], "interact": [1, 2, 3], "base": [1, 3], "default": [1, 3], "start": [1, 2, 3], "If": [1, 3], "chosen": [1, 3], "need": [1, 3], "comput": [1, 3], "manual": [1, 3], "befor": [1, 3], "requir": [1, 2], "filter": [1, 3], "onli": 1, "subset": [1, 3], "whether": [1, 3], "from": [1, 2, 3], "true": [1, 3], "wait": [1, 3], "them": [1, 2, 3], "max": 1, "interv": 1, "max_interv": [1, 3], "number": [1, 3], "time": [1, 3], "we": [1, 3], "check": 1, "20": [1, 3], "interval_tim": [1, 3], "second": [1, 3], "again": 1, "10": [1, 3], "evaluation_path": [1, 3], "singl": [1, 3], "file": [1, 3], "The": 2, "librari": 2, "allow": [2, 3], "platform": 2, "central": 2, "valid": 2, "applic": 2, "empow": 2, "product": 2, "team": 2, "ensur": 2, "all": 2, "function": 2, "busi": 2, "legal": 2, "met": 2, "keep": 2, "close": 2, "contact": 2, "delai": 2, "deploy": 2, "timelin": 2, "python": 2, "simpl": [2, 3], "wai": 2, "scientist": 2, "manag": 2, "evalu": [2, 3], "workflow": 2, "dure": 2, "prototyp": 2, "phase": 2, "continu": 2, "integr": 2, "read": 2, "quick": 2, "guid": 2, "up": [2, 3], "run": [2, 3], "learn": 2, "how": 2, "dataset": [2, 3], "upload": 2, "notebook": 2, "script": 2, "class": 3, "str": 3, "none": 3, "sourc": 3, "handl": 3, "local_mod": 3, "bool": 3, "use_fil": 3, "fals": 3, "els": 3, "onlin": 3, "paramet": 3, "still": 3, "sinc": 3, "descript": 3, "select": 3, "return": 3, "In": 3, "case": 3, "non": 3, "dict": 3, "union": 3, "target": 3, "metric": 3, "global": 3, "int": 3, "try": 3, "stop": 3, "retri": 3, "rais": 3, "valueerror": 3, "doe": 3, "finish": 3, "end": 3, "error": 3, "to_ev": 3, "testresult": 3, "transient": 3, "convers": 3, "reason": 3, "ani": 3, "method": 3, "dataclass": 3, "skip": 3, "same": 3, "created_at": 3, "datetim": 3, "updated_at": 3, "entiti": 3, "item": 3, "full": 3, "ie": 3, "complianc": 3, "correct": 3, "name": 3, "audit": 3, "field": 3, "classmethod": 3, "from_dict": 3, "factori": 3, "ignor": 3, "both": 3, "conveni": 3, "creat": 3, "string": 3, "liter": 3, "system": 3, "pass": 3, "fail": 3, "total": 3, "supported_languag": 3, "header": 3, "miscellean": 3, "format": 3, "without": 3, "save": 3, "anyth": 3}, "objects": {"giskard_hub": [[3, 0, 0, "-", "cli"], [3, 0, 0, "-", "client"], [3, 0, 0, "-", "data"]], "giskard_hub.cli": [[3, 1, 1, "", "datasets"], [3, 1, 1, "", "evaluate"], [3, 1, 1, "", "models"], [3, 1, 1, "", "projects"], [3, 1, 1, "", "results"], [3, 1, 1, "", "update_evaluations"]], "giskard_hub.client": [[3, 2, 1, "", "HubClient"]], "giskard_hub.client.HubClient": [[3, 3, 1, "", "evaluate"], [3, 3, 1, "", "get_datasets"], [3, 3, 1, "", "get_models"], [3, 3, 1, "", "get_projects"], [3, 3, 1, "", "get_results"], [3, 3, 1, "", "single_eval"], [3, 3, 1, "", "update_evaluation"], [3, 3, 1, "", "update_evaluations"]], "giskard_hub.data": [[3, 2, 1, "", "Conversation"], [3, 2, 1, "", "Dataset"], [3, 2, 1, "", "Entity"], [3, 2, 1, "", "Evaluation"], [3, 2, 1, "", "LLMMessage"], [3, 2, 1, "", "Metric"], [3, 2, 1, "", "Model"], [3, 2, 1, "", "ModelOutput"], [3, 2, 1, "", "Project"], [3, 2, 1, "", "TestResult"], [3, 2, 1, "", "TransientEvaluation"]], "giskard_hub.data.Conversation": [[3, 4, 1, "", "expected_output"], [3, 4, 1, "", "messages"], [3, 4, 1, "", "policies"], [3, 4, 1, "", "tags"]], "giskard_hub.data.Dataset": [[3, 4, 1, "", "description"], [3, 4, 1, "", "name"], [3, 4, 1, "", "project_id"], [3, 4, 1, "", "tags"]], "giskard_hub.data.Entity": [[3, 4, 1, "", "created_at"], [3, 3, 1, "", "from_dict"], [3, 4, 1, "", "id"], [3, 4, 1, "", "updated_at"]], "giskard_hub.data.Evaluation": [[3, 4, 1, "", "conversation"], [3, 4, 1, "", "error"], [3, 4, 1, "", "execution_id"], [3, 4, 1, "", "output"], [3, 3, 1, "", "set_output"]], "giskard_hub.data.LLMMessage": [[3, 4, 1, "", "content"], [3, 4, 1, "", "role"]], "giskard_hub.data.Metric": [[3, 4, 1, "", "errored"], [3, 4, 1, "", "failed"], [3, 4, 1, "", "name"], [3, 4, 1, "", "passed"], [3, 4, 1, "", "total"]], "giskard_hub.data.Model": [[3, 4, 1, "", "description"], [3, 4, 1, "", "headers"], [3, 4, 1, "", "name"], [3, 4, 1, "", "project_id"], [3, 4, 1, "", "supported_languages"], [3, 4, 1, "", "url"]], "giskard_hub.data.ModelOutput": [[3, 4, 1, "", "metadata"], [3, 4, 1, "", "response"]], "giskard_hub.data.Project": [[3, 4, 1, "", "description"], [3, 4, 1, "", "name"]], "giskard_hub.data.TestResult": [[3, 4, 1, "", "error"], [3, 3, 1, "", "from_dict"], [3, 4, 1, "", "name"], [3, 4, 1, "", "passed"], [3, 4, 1, "", "reason"]], "giskard_hub.data.TransientEvaluation": [[3, 4, 1, "", "expected_output"], [3, 4, 1, "", "messages"], [3, 4, 1, "", "model_description"], [3, 4, 1, "", "model_output"], [3, 4, 1, "", "policies"]], "python--m-giskard_hub.cli-datasets": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-datasets-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-datasets-hub-url", "--hub-url"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-datasets-project-id", "--project-id"]], "python--m-giskard_hub.cli-evaluate": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-dataset-id", "--dataset-id"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-folder-path", "--folder-path"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-hub-url", "--hub-url"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-local-mode", "--local-mode"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-model-id", "--model-id"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-local-mode", "--no-local-mode"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-tags", "--tags"]], "python--m-giskard_hub.cli-models": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-models-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-models-hub-url", "--hub-url"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-models-project-id", "--project-id"]], "python--m-giskard_hub.cli-projects": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-projects-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-projects-hub-url", "--hub-url"]], "python--m-giskard_hub.cli-results": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-results-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-results-execution-id", "--execution-id"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-results-hub-url", "--hub-url"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-results-interval-time", "--interval-time"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-results-max-interval", "--max-interval"]], "python--m-giskard_hub.cli-update-evaluations": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-evaluation-path", "--evaluation-path"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-hub-url", "--hub-url"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:attribute", "5": "std:cmdoption"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "attribute", "Python attribute"], "5": ["std", "cmdoption", "program option"]}, "titleterms": {"quick": 0, "start": 0, "evalu": [0, 1], "from": 0, "your": 0, "jupyt": 0, "notebook": 0, "us": 0, "python": [0, 1], "script": 0, "cli": [0, 1, 2, 3], "singl": 0, "dataset": [0, 1], "entri": 0, "doc": [1, 2], "m": 1, "giskard_hub": [1, 3], "model": 1, "project": 1, "result": 1, "updat": 1, "welcom": 2, "giskard": 2, "hub": 2, "": 2, "client": [2, 3], "modul": 3, "data": 3, "structur": 3}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx": 60}, "alltitles": {"Quick Start": [[0, "quick-start"]], "Evaluating from your Jupyter notebook": [[0, "evaluating-from-your-jupyter-notebook"]], "Evaluating using a Python script": [[0, "evaluating-using-a-python-script"]], "Evaluating using CLI": [[0, "evaluating-using-cli"]], "Evaluating a single dataset entry": [[0, "evaluating-a-single-dataset-entry"]], "CLI docs": [[1, "cli-docs"]], "python -m giskard_hub.cli": [[1, "python-m-giskard-hub-cli"]], "datasets": [[1, "python-m-giskard-hub-cli-datasets"]], "evaluate": [[1, "python-m-giskard-hub-cli-evaluate"]], "models": [[1, "python-m-giskard-hub-cli-models"]], "projects": [[1, "python-m-giskard-hub-cli-projects"]], "results": [[1, "python-m-giskard-hub-cli-results"]], "update-evaluations": [[1, "python-m-giskard-hub-cli-update-evaluations"]], "Welcome to the Giskard Hub\u2019s client docs!": [[2, "welcome-to-the-giskard-hub-s-client-docs"]], "CLI": [[2, null], [3, "cli"]], "Client": [[3, "client"]], "giskard_hub.client module": [[3, "module-giskard_hub.client"]], "giskard_hub.cli module": [[3, "module-giskard_hub.cli"]], "Data structure": [[3, "data-structure"]], "giskard_hub.data module": [[3, "module-giskard_hub.data"]]}, "indexentries": {"--api-key": [[1, "cmdoption-python-m-giskard_hub.cli-datasets-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-models-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-projects-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-results-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-api-key"]], "--dataset-id": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-dataset-id"]], "--evaluation-path": [[1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-evaluation-path"]], "--execution-id": [[1, "cmdoption-python-m-giskard_hub.cli-results-execution-id"]], "--folder-path": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-folder-path"]], "--hub-url": [[1, "cmdoption-python-m-giskard_hub.cli-datasets-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-models-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-projects-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-results-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-hub-url"]], "--interval-time": [[1, "cmdoption-python-m-giskard_hub.cli-results-interval-time"]], "--local-mode": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-local-mode"]], "--max-interval": [[1, "cmdoption-python-m-giskard_hub.cli-results-max-interval"]], "--model-id": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-model-id"]], "--no-local-mode": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-local-mode"]], "--project-id": [[1, "cmdoption-python-m-giskard_hub.cli-datasets-project-id"], [1, "cmdoption-python-m-giskard_hub.cli-models-project-id"]], "--tags": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-tags"]], "python--m-giskard_hub.cli-datasets command line option": [[1, "cmdoption-python-m-giskard_hub.cli-datasets-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-datasets-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-datasets-project-id"]], "python--m-giskard_hub.cli-evaluate command line option": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-dataset-id"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-folder-path"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-local-mode"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-model-id"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-tags"]], "python--m-giskard_hub.cli-models command line option": [[1, "cmdoption-python-m-giskard_hub.cli-models-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-models-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-models-project-id"]], "python--m-giskard_hub.cli-projects command line option": [[1, "cmdoption-python-m-giskard_hub.cli-projects-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-projects-hub-url"]], "python--m-giskard_hub.cli-results command line option": [[1, "cmdoption-python-m-giskard_hub.cli-results-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-results-execution-id"], [1, "cmdoption-python-m-giskard_hub.cli-results-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-results-interval-time"], [1, "cmdoption-python-m-giskard_hub.cli-results-max-interval"]], "python--m-giskard_hub.cli-update-evaluations command line option": [[1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-evaluation-path"], [1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-hub-url"]], "conversation (class in giskard_hub.data)": [[3, "giskard_hub.data.Conversation"]], "dataset (class in giskard_hub.data)": [[3, "giskard_hub.data.Dataset"]], "entity (class in giskard_hub.data)": [[3, "giskard_hub.data.Entity"]], "evaluation (class in giskard_hub.data)": [[3, "giskard_hub.data.Evaluation"]], "hubclient (class in giskard_hub.client)": [[3, "giskard_hub.client.HubClient"]], "llmmessage (class in giskard_hub.data)": [[3, "giskard_hub.data.LLMMessage"]], "metric (class in giskard_hub.data)": [[3, "giskard_hub.data.Metric"]], "model (class in giskard_hub.data)": [[3, "giskard_hub.data.Model"]], "modeloutput (class in giskard_hub.data)": [[3, "giskard_hub.data.ModelOutput"]], "project (class in giskard_hub.data)": [[3, "giskard_hub.data.Project"]], "testresult (class in giskard_hub.data)": [[3, "giskard_hub.data.TestResult"]], "transientevaluation (class in giskard_hub.data)": [[3, "giskard_hub.data.TransientEvaluation"]], "content (giskard_hub.data.llmmessage attribute)": [[3, "giskard_hub.data.LLMMessage.content"]], "conversation (giskard_hub.data.evaluation attribute)": [[3, "giskard_hub.data.Evaluation.conversation"]], "created_at (giskard_hub.data.entity attribute)": [[3, "giskard_hub.data.Entity.created_at"]], "datasets() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.datasets"]], "description (giskard_hub.data.dataset attribute)": [[3, "giskard_hub.data.Dataset.description"]], "description (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.description"]], "description (giskard_hub.data.project attribute)": [[3, "giskard_hub.data.Project.description"]], "error (giskard_hub.data.evaluation attribute)": [[3, "giskard_hub.data.Evaluation.error"]], "error (giskard_hub.data.testresult attribute)": [[3, "giskard_hub.data.TestResult.error"]], "errored (giskard_hub.data.metric attribute)": [[3, "giskard_hub.data.Metric.errored"]], "evaluate() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.evaluate"]], "evaluate() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.evaluate"]], "execution_id (giskard_hub.data.evaluation attribute)": [[3, "giskard_hub.data.Evaluation.execution_id"]], "expected_output (giskard_hub.data.conversation attribute)": [[3, "giskard_hub.data.Conversation.expected_output"]], "expected_output (giskard_hub.data.transientevaluation attribute)": [[3, "giskard_hub.data.TransientEvaluation.expected_output"]], "failed (giskard_hub.data.metric attribute)": [[3, "giskard_hub.data.Metric.failed"]], "from_dict() (giskard_hub.data.entity class method)": [[3, "giskard_hub.data.Entity.from_dict"]], "from_dict() (giskard_hub.data.testresult class method)": [[3, "giskard_hub.data.TestResult.from_dict"]], "get_datasets() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.get_datasets"]], "get_models() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.get_models"]], "get_projects() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.get_projects"]], "get_results() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.get_results"]], "giskard_hub.cli": [[3, "module-giskard_hub.cli"]], "giskard_hub.client": [[3, "module-giskard_hub.client"]], "giskard_hub.data": [[3, "module-giskard_hub.data"]], "headers (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.headers"]], "id (giskard_hub.data.entity attribute)": [[3, "giskard_hub.data.Entity.id"]], "messages (giskard_hub.data.conversation attribute)": [[3, "giskard_hub.data.Conversation.messages"]], "messages (giskard_hub.data.transientevaluation attribute)": [[3, "giskard_hub.data.TransientEvaluation.messages"]], "metadata (giskard_hub.data.modeloutput attribute)": [[3, "giskard_hub.data.ModelOutput.metadata"]], "model_description (giskard_hub.data.transientevaluation attribute)": [[3, "giskard_hub.data.TransientEvaluation.model_description"]], "model_output (giskard_hub.data.transientevaluation attribute)": [[3, "giskard_hub.data.TransientEvaluation.model_output"]], "models() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.models"]], "module": [[3, "module-giskard_hub.cli"], [3, "module-giskard_hub.client"], [3, "module-giskard_hub.data"]], "name (giskard_hub.data.dataset attribute)": [[3, "giskard_hub.data.Dataset.name"]], "name (giskard_hub.data.metric attribute)": [[3, "giskard_hub.data.Metric.name"]], "name (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.name"]], "name (giskard_hub.data.project attribute)": [[3, "giskard_hub.data.Project.name"]], "name (giskard_hub.data.testresult attribute)": [[3, "giskard_hub.data.TestResult.name"]], "output (giskard_hub.data.evaluation attribute)": [[3, "giskard_hub.data.Evaluation.output"]], "passed (giskard_hub.data.metric attribute)": [[3, "giskard_hub.data.Metric.passed"]], "passed (giskard_hub.data.testresult attribute)": [[3, "giskard_hub.data.TestResult.passed"]], "policies (giskard_hub.data.conversation attribute)": [[3, "giskard_hub.data.Conversation.policies"]], "policies (giskard_hub.data.transientevaluation attribute)": [[3, "giskard_hub.data.TransientEvaluation.policies"]], "project_id (giskard_hub.data.dataset attribute)": [[3, "giskard_hub.data.Dataset.project_id"]], "project_id (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.project_id"]], "projects() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.projects"]], "reason (giskard_hub.data.testresult attribute)": [[3, "giskard_hub.data.TestResult.reason"]], "response (giskard_hub.data.modeloutput attribute)": [[3, "giskard_hub.data.ModelOutput.response"]], "results() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.results"]], "role (giskard_hub.data.llmmessage attribute)": [[3, "giskard_hub.data.LLMMessage.role"]], "set_output() (giskard_hub.data.evaluation method)": [[3, "giskard_hub.data.Evaluation.set_output"]], "single_eval() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.single_eval"]], "supported_languages (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.supported_languages"]], "tags (giskard_hub.data.conversation attribute)": [[3, "giskard_hub.data.Conversation.tags"]], "tags (giskard_hub.data.dataset attribute)": [[3, "giskard_hub.data.Dataset.tags"]], "total (giskard_hub.data.metric attribute)": [[3, "giskard_hub.data.Metric.total"]], "update_evaluation() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.update_evaluation"]], "update_evaluations() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.update_evaluations"]], "update_evaluations() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.update_evaluations"]], "updated_at (giskard_hub.data.entity attribute)": [[3, "giskard_hub.data.Entity.updated_at"]], "url (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.url"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["README", "cli", "index", "sources"], "filenames": ["README.md", "cli.rst", "index.md", "sources.rst"], "titles": ["Quick Start", "CLI docs", "Welcome to the Giskard Hub\u2019s client docs!", "Client"], "terms": {"initi": 0, "client": 0, "giskard_hub": [0, 2], "import": 0, "hubclient": [0, 3], "note": 0, "api": [0, 1], "kei": [0, 1, 3], "hub": [0, 1, 3], "url": [0, 1, 3], "can": 0, "also": 0, "provid": [0, 1, 2, 3], "set": 0, "env": 0, "variabl": [0, 1], "gsk_api_kei": [0, 1], "gsk_hub_url": [0, 1], "api_kei": [0, 1, 3], "hub_url": [0, 1, 3], "next": 0, "retriev": 0, "relev": 0, "object": [0, 3], "server": 0, "project": [0, 3], "model": [0, 3], "data": [0, 2], "get_project": [0, 3], "0": 0, "get_model": [0, 3], "id": [0, 1, 3], "get_dataset": [0, 3], "you": [0, 2], "launch": 0, "an": [0, 1, 3], "which": 0, "download": [0, 1, 2, 3], "sent": 0, "llm": [0, 2, 3], "agent": [0, 1, 2, 3], "complet": [0, 1], "type": [0, 3], "list": [0, 1, 3], "thi": 0, "contain": [0, 1, 3], "messag": [0, 3], "expect": [0, 3], "output": [0, 1, 2, 3], "polici": [0, 3], "tag": [0, 1, 3], "etc": 0, "to_complet": 0, "model_id": [0, 1, 3], "dataset_id": [0, 1, 3], "send": 0, "dummi": 0, "def": 0, "dummy_model": 0, "all_data": 0, "simul": 0, "call": [0, 3], "updat": [0, 3], "set_output": [0, 3], "sorri": 0, "i": [0, 1, 3], "t": 0, "answer": [0, 3], "question": 0, "altern": 0, "could": 0, "done": 0, "like": 0, "modeloutput": [0, 3], "respons": [0, 3], "llmmessag": [0, 3], "role": [0, 3], "assist": [0, 3], "content": [0, 3], "metadata": [0, 3], "elt": 0, "push": [0, 1, 3], "element": 0, "process": [0, 2], "update_evalu": [0, 3], "either": 0, "head": 0, "inspect": 0, "result": [0, 3], "detail": 0, "get": [0, 1, 2, 3], "summar": 0, "directli": 0, "develop": [0, 2], "environ": [0, 1], "extract": 0, "execution_id": [0, 1, 3], "get_result": [0, 3], "__name__": 0, "__main__": 0, "print": 0, "got": 0, "bin": 0, "bash": 0, "eu": 0, "avoid": [0, 2], "give": 0, "info": [0, 3], "everytim": 0, "export": 0, "folder_path": [0, 1, 3], "test": [0, 2, 3], "folder": [0, 1, 3], "rm": 0, "rf": 0, "mkdir": 0, "p": 0, "project_id": [0, 1, 3], "m": 0, "jq": 0, "raw": 0, "path": [0, 1, 3], "local": [0, 1, 3], "mode": [0, 1, 3], "find": 0, "f": 0, "grep": 0, "json": [0, 1], "n1": 0, "xarg": 0, "follow": 0, "line": 0, "fake": 0, "chang": 0, "sed": 0, "": [0, 3], "null": 0, "cant": 0, "g": 0, "sh": 0, "execut": [0, 1, 2, 3], "initialis": [0, 3], "2b437295": 0, "dabe": 0, "4084": 0, "ba03": 0, "cdb259e3e678": 0, "http": 0, "backend": [0, 1], "localhost": 0, "single_ev": [0, 3], "transientevalu": [0, 3], "user": [0, 3], "what": 0, "color": 0, "orang": 0, "model_output": [0, 3], "green": 0, "model_descript": [0, 3], "ar": [0, 2, 3], "inform": 0, "about": [0, 3], "fruit": 0, "must": 0, "never": 0, "sai": 0, "word": 0, "polit": 0, "expected_output": [0, 3], "option": [1, 3], "command": 1, "arg": 1, "given": [1, 3], "us": [1, 3], "interact": [1, 2, 3], "base": [1, 3], "default": [1, 3], "start": [1, 2, 3], "If": [1, 3], "chosen": [1, 3], "need": [1, 3], "comput": [1, 3], "manual": [1, 3], "befor": [1, 3], "requir": [1, 2], "filter": [1, 3], "onli": 1, "subset": [1, 3], "whether": [1, 3], "from": [1, 2, 3], "true": [1, 3], "wait": [1, 3], "them": [1, 2, 3], "max": 1, "interv": 1, "max_interv": [1, 3], "number": [1, 3], "time": [1, 3], "we": [1, 3], "check": 1, "20": [1, 3], "interval_tim": [1, 3], "second": [1, 3], "again": 1, "10": [1, 3], "evaluation_path": [1, 3], "singl": [1, 3], "file": [1, 3], "The": 2, "librari": 2, "allow": [2, 3], "platform": 2, "central": 2, "valid": 2, "applic": 2, "empow": 2, "product": 2, "team": 2, "ensur": 2, "all": 2, "function": 2, "busi": 2, "legal": 2, "met": 2, "keep": 2, "close": 2, "contact": 2, "delai": 2, "deploy": 2, "timelin": 2, "python": 2, "simpl": [2, 3], "wai": 2, "scientist": 2, "manag": 2, "evalu": [2, 3], "workflow": 2, "dure": 2, "prototyp": 2, "phase": 2, "continu": 2, "integr": 2, "read": 2, "quick": 2, "guid": 2, "up": [2, 3], "run": [2, 3], "learn": 2, "how": 2, "dataset": [2, 3], "upload": 2, "notebook": 2, "script": 2, "cli": 2, "class": 3, "str": 3, "none": 3, "sourc": 3, "handl": 3, "local_mod": 3, "bool": 3, "use_fil": 3, "fals": 3, "els": 3, "onlin": 3, "paramet": 3, "still": 3, "sinc": 3, "descript": 3, "select": 3, "return": 3, "In": 3, "case": 3, "non": 3, "dict": 3, "union": 3, "target": 3, "metric": 3, "global": 3, "int": 3, "try": 3, "stop": 3, "retri": 3, "rais": 3, "valueerror": 3, "doe": 3, "finish": 3, "end": 3, "error": 3, "to_ev": 3, "testresult": 3, "transient": 3, "convers": 3, "reason": 3, "ani": 3, "method": 3, "dataclass": 3, "skip": 3, "same": 3, "created_at": 3, "datetim": 3, "updated_at": 3, "entiti": 3, "item": 3, "full": 3, "ie": 3, "complianc": 3, "correct": 3, "name": 3, "audit": 3, "field": 3, "classmethod": 3, "from_dict": 3, "factori": 3, "ignor": 3, "both": 3, "conveni": 3, "creat": 3, "string": 3, "liter": 3, "system": 3, "pass": 3, "fail": 3, "total": 3, "supported_languag": 3, "header": 3, "miscellean": 3, "format": 3, "without": 3, "save": 3, "anyth": 3}, "objects": {"giskard_hub": [[3, 0, 0, "-", "cli"], [3, 0, 0, "-", "client"], [3, 0, 0, "-", "data"]], "giskard_hub.cli": [[3, 1, 1, "", "datasets"], [3, 1, 1, "", "evaluate"], [3, 1, 1, "", "models"], [3, 1, 1, "", "projects"], [3, 1, 1, "", "results"], [3, 1, 1, "", "update_evaluations"]], "giskard_hub.client": [[3, 2, 1, "", "HubClient"]], "giskard_hub.client.HubClient": [[3, 3, 1, "", "evaluate"], [3, 3, 1, "", "get_datasets"], [3, 3, 1, "", "get_models"], [3, 3, 1, "", "get_projects"], [3, 3, 1, "", "get_results"], [3, 3, 1, "", "single_eval"], [3, 3, 1, "", "update_evaluation"], [3, 3, 1, "", "update_evaluations"]], "giskard_hub.data": [[3, 2, 1, "", "Conversation"], [3, 2, 1, "", "Dataset"], [3, 2, 1, "", "Entity"], [3, 2, 1, "", "Evaluation"], [3, 2, 1, "", "LLMMessage"], [3, 2, 1, "", "Metric"], [3, 2, 1, "", "Model"], [3, 2, 1, "", "ModelOutput"], [3, 2, 1, "", "Project"], [3, 2, 1, "", "TestResult"], [3, 2, 1, "", "TransientEvaluation"]], "giskard_hub.data.Conversation": [[3, 4, 1, "", "expected_output"], [3, 4, 1, "", "messages"], [3, 4, 1, "", "policies"], [3, 4, 1, "", "tags"]], "giskard_hub.data.Dataset": [[3, 4, 1, "", "description"], [3, 4, 1, "", "name"], [3, 4, 1, "", "project_id"], [3, 4, 1, "", "tags"]], "giskard_hub.data.Entity": [[3, 4, 1, "", "created_at"], [3, 3, 1, "", "from_dict"], [3, 4, 1, "", "id"], [3, 4, 1, "", "updated_at"]], "giskard_hub.data.Evaluation": [[3, 4, 1, "", "conversation"], [3, 4, 1, "", "error"], [3, 4, 1, "", "execution_id"], [3, 4, 1, "", "output"], [3, 3, 1, "", "set_output"]], "giskard_hub.data.LLMMessage": [[3, 4, 1, "", "content"], [3, 4, 1, "", "role"]], "giskard_hub.data.Metric": [[3, 4, 1, "", "errored"], [3, 4, 1, "", "failed"], [3, 4, 1, "", "name"], [3, 4, 1, "", "passed"], [3, 4, 1, "", "total"]], "giskard_hub.data.Model": [[3, 4, 1, "", "description"], [3, 4, 1, "", "headers"], [3, 4, 1, "", "name"], [3, 4, 1, "", "project_id"], [3, 4, 1, "", "supported_languages"], [3, 4, 1, "", "url"]], "giskard_hub.data.ModelOutput": [[3, 4, 1, "", "metadata"], [3, 4, 1, "", "response"]], "giskard_hub.data.Project": [[3, 4, 1, "", "description"], [3, 4, 1, "", "name"]], "giskard_hub.data.TestResult": [[3, 4, 1, "", "error"], [3, 3, 1, "", "from_dict"], [3, 4, 1, "", "name"], [3, 4, 1, "", "passed"], [3, 4, 1, "", "reason"]], "giskard_hub.data.TransientEvaluation": [[3, 4, 1, "", "expected_output"], [3, 4, 1, "", "messages"], [3, 4, 1, "", "model_description"], [3, 4, 1, "", "model_output"], [3, 4, 1, "", "policies"]], "python--m-giskard_hub.cli-datasets": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-datasets-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-datasets-hub-url", "--hub-url"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-datasets-project-id", "--project-id"]], "python--m-giskard_hub.cli-evaluate": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-dataset-id", "--dataset-id"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-folder-path", "--folder-path"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-hub-url", "--hub-url"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-local-mode", "--local-mode"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-model-id", "--model-id"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-local-mode", "--no-local-mode"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-evaluate-tags", "--tags"]], "python--m-giskard_hub.cli-models": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-models-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-models-hub-url", "--hub-url"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-models-project-id", "--project-id"]], "python--m-giskard_hub.cli-projects": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-projects-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-projects-hub-url", "--hub-url"]], "python--m-giskard_hub.cli-results": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-results-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-results-execution-id", "--execution-id"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-results-hub-url", "--hub-url"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-results-interval-time", "--interval-time"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-results-max-interval", "--max-interval"]], "python--m-giskard_hub.cli-update-evaluations": [[1, 5, 1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-api-key", "--api-key"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-evaluation-path", "--evaluation-path"], [1, 5, 1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-hub-url", "--hub-url"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:attribute", "5": "std:cmdoption"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "attribute", "Python attribute"], "5": ["std", "cmdoption", "program option"]}, "titleterms": {"quick": 0, "start": 0, "evalu": [0, 1], "from": 0, "your": 0, "jupyt": 0, "notebook": 0, "us": 0, "python": [0, 1], "script": 0, "cli": [0, 1, 3], "singl": 0, "dataset": [0, 1], "entri": 0, "doc": [1, 2], "m": 1, "giskard_hub": [1, 3], "model": 1, "project": 1, "result": 1, "updat": 1, "welcom": 2, "giskard": 2, "hub": 2, "": 2, "client": [2, 3], "modul": 3, "data": 3, "structur": 3}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx": 60}, "alltitles": {"Quick Start": [[0, "quick-start"]], "Evaluating from your Jupyter notebook": [[0, "evaluating-from-your-jupyter-notebook"]], "Evaluating using a Python script": [[0, "evaluating-using-a-python-script"]], "Evaluating using CLI": [[0, "evaluating-using-cli"]], "Evaluating a single dataset entry": [[0, "evaluating-a-single-dataset-entry"]], "CLI docs": [[1, "cli-docs"]], "python -m giskard_hub.cli": [[1, "python-m-giskard-hub-cli"]], "datasets": [[1, "python-m-giskard-hub-cli-datasets"]], "evaluate": [[1, "python-m-giskard-hub-cli-evaluate"]], "models": [[1, "python-m-giskard-hub-cli-models"]], "projects": [[1, "python-m-giskard-hub-cli-projects"]], "results": [[1, "python-m-giskard-hub-cli-results"]], "update-evaluations": [[1, "python-m-giskard-hub-cli-update-evaluations"]], "Welcome to the Giskard Hub\u2019s client docs!": [[2, "welcome-to-the-giskard-hub-s-client-docs"]], "Client": [[3, "client"]], "giskard_hub.client module": [[3, "module-giskard_hub.client"]], "CLI": [[3, "cli"]], "giskard_hub.cli module": [[3, "module-giskard_hub.cli"]], "Data structure": [[3, "data-structure"]], "giskard_hub.data module": [[3, "module-giskard_hub.data"]]}, "indexentries": {"--api-key": [[1, "cmdoption-python-m-giskard_hub.cli-datasets-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-models-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-projects-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-results-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-api-key"]], "--dataset-id": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-dataset-id"]], "--evaluation-path": [[1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-evaluation-path"]], "--execution-id": [[1, "cmdoption-python-m-giskard_hub.cli-results-execution-id"]], "--folder-path": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-folder-path"]], "--hub-url": [[1, "cmdoption-python-m-giskard_hub.cli-datasets-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-models-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-projects-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-results-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-hub-url"]], "--interval-time": [[1, "cmdoption-python-m-giskard_hub.cli-results-interval-time"]], "--local-mode": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-local-mode"]], "--max-interval": [[1, "cmdoption-python-m-giskard_hub.cli-results-max-interval"]], "--model-id": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-model-id"]], "--no-local-mode": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-local-mode"]], "--project-id": [[1, "cmdoption-python-m-giskard_hub.cli-datasets-project-id"], [1, "cmdoption-python-m-giskard_hub.cli-models-project-id"]], "--tags": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-tags"]], "python--m-giskard_hub.cli-datasets command line option": [[1, "cmdoption-python-m-giskard_hub.cli-datasets-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-datasets-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-datasets-project-id"]], "python--m-giskard_hub.cli-evaluate command line option": [[1, "cmdoption-python-m-giskard_hub.cli-evaluate-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-dataset-id"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-folder-path"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-local-mode"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-model-id"], [1, "cmdoption-python-m-giskard_hub.cli-evaluate-tags"]], "python--m-giskard_hub.cli-models command line option": [[1, "cmdoption-python-m-giskard_hub.cli-models-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-models-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-models-project-id"]], "python--m-giskard_hub.cli-projects command line option": [[1, "cmdoption-python-m-giskard_hub.cli-projects-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-projects-hub-url"]], "python--m-giskard_hub.cli-results command line option": [[1, "cmdoption-python-m-giskard_hub.cli-results-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-results-execution-id"], [1, "cmdoption-python-m-giskard_hub.cli-results-hub-url"], [1, "cmdoption-python-m-giskard_hub.cli-results-interval-time"], [1, "cmdoption-python-m-giskard_hub.cli-results-max-interval"]], "python--m-giskard_hub.cli-update-evaluations command line option": [[1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-api-key"], [1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-evaluation-path"], [1, "cmdoption-python-m-giskard_hub.cli-update-evaluations-hub-url"]], "conversation (class in giskard_hub.data)": [[3, "giskard_hub.data.Conversation"]], "dataset (class in giskard_hub.data)": [[3, "giskard_hub.data.Dataset"]], "entity (class in giskard_hub.data)": [[3, "giskard_hub.data.Entity"]], "evaluation (class in giskard_hub.data)": [[3, "giskard_hub.data.Evaluation"]], "hubclient (class in giskard_hub.client)": [[3, "giskard_hub.client.HubClient"]], "llmmessage (class in giskard_hub.data)": [[3, "giskard_hub.data.LLMMessage"]], "metric (class in giskard_hub.data)": [[3, "giskard_hub.data.Metric"]], "model (class in giskard_hub.data)": [[3, "giskard_hub.data.Model"]], "modeloutput (class in giskard_hub.data)": [[3, "giskard_hub.data.ModelOutput"]], "project (class in giskard_hub.data)": [[3, "giskard_hub.data.Project"]], "testresult (class in giskard_hub.data)": [[3, "giskard_hub.data.TestResult"]], "transientevaluation (class in giskard_hub.data)": [[3, "giskard_hub.data.TransientEvaluation"]], "content (giskard_hub.data.llmmessage attribute)": [[3, "giskard_hub.data.LLMMessage.content"]], "conversation (giskard_hub.data.evaluation attribute)": [[3, "giskard_hub.data.Evaluation.conversation"]], "created_at (giskard_hub.data.entity attribute)": [[3, "giskard_hub.data.Entity.created_at"]], "datasets() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.datasets"]], "description (giskard_hub.data.dataset attribute)": [[3, "giskard_hub.data.Dataset.description"]], "description (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.description"]], "description (giskard_hub.data.project attribute)": [[3, "giskard_hub.data.Project.description"]], "error (giskard_hub.data.evaluation attribute)": [[3, "giskard_hub.data.Evaluation.error"]], "error (giskard_hub.data.testresult attribute)": [[3, "giskard_hub.data.TestResult.error"]], "errored (giskard_hub.data.metric attribute)": [[3, "giskard_hub.data.Metric.errored"]], "evaluate() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.evaluate"]], "evaluate() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.evaluate"]], "execution_id (giskard_hub.data.evaluation attribute)": [[3, "giskard_hub.data.Evaluation.execution_id"]], "expected_output (giskard_hub.data.conversation attribute)": [[3, "giskard_hub.data.Conversation.expected_output"]], "expected_output (giskard_hub.data.transientevaluation attribute)": [[3, "giskard_hub.data.TransientEvaluation.expected_output"]], "failed (giskard_hub.data.metric attribute)": [[3, "giskard_hub.data.Metric.failed"]], "from_dict() (giskard_hub.data.entity class method)": [[3, "giskard_hub.data.Entity.from_dict"]], "from_dict() (giskard_hub.data.testresult class method)": [[3, "giskard_hub.data.TestResult.from_dict"]], "get_datasets() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.get_datasets"]], "get_models() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.get_models"]], "get_projects() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.get_projects"]], "get_results() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.get_results"]], "giskard_hub.cli": [[3, "module-giskard_hub.cli"]], "giskard_hub.client": [[3, "module-giskard_hub.client"]], "giskard_hub.data": [[3, "module-giskard_hub.data"]], "headers (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.headers"]], "id (giskard_hub.data.entity attribute)": [[3, "giskard_hub.data.Entity.id"]], "messages (giskard_hub.data.conversation attribute)": [[3, "giskard_hub.data.Conversation.messages"]], "messages (giskard_hub.data.transientevaluation attribute)": [[3, "giskard_hub.data.TransientEvaluation.messages"]], "metadata (giskard_hub.data.modeloutput attribute)": [[3, "giskard_hub.data.ModelOutput.metadata"]], "model_description (giskard_hub.data.transientevaluation attribute)": [[3, "giskard_hub.data.TransientEvaluation.model_description"]], "model_output (giskard_hub.data.transientevaluation attribute)": [[3, "giskard_hub.data.TransientEvaluation.model_output"]], "models() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.models"]], "module": [[3, "module-giskard_hub.cli"], [3, "module-giskard_hub.client"], [3, "module-giskard_hub.data"]], "name (giskard_hub.data.dataset attribute)": [[3, "giskard_hub.data.Dataset.name"]], "name (giskard_hub.data.metric attribute)": [[3, "giskard_hub.data.Metric.name"]], "name (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.name"]], "name (giskard_hub.data.project attribute)": [[3, "giskard_hub.data.Project.name"]], "name (giskard_hub.data.testresult attribute)": [[3, "giskard_hub.data.TestResult.name"]], "output (giskard_hub.data.evaluation attribute)": [[3, "giskard_hub.data.Evaluation.output"]], "passed (giskard_hub.data.metric attribute)": [[3, "giskard_hub.data.Metric.passed"]], "passed (giskard_hub.data.testresult attribute)": [[3, "giskard_hub.data.TestResult.passed"]], "policies (giskard_hub.data.conversation attribute)": [[3, "giskard_hub.data.Conversation.policies"]], "policies (giskard_hub.data.transientevaluation attribute)": [[3, "giskard_hub.data.TransientEvaluation.policies"]], "project_id (giskard_hub.data.dataset attribute)": [[3, "giskard_hub.data.Dataset.project_id"]], "project_id (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.project_id"]], "projects() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.projects"]], "reason (giskard_hub.data.testresult attribute)": [[3, "giskard_hub.data.TestResult.reason"]], "response (giskard_hub.data.modeloutput attribute)": [[3, "giskard_hub.data.ModelOutput.response"]], "results() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.results"]], "role (giskard_hub.data.llmmessage attribute)": [[3, "giskard_hub.data.LLMMessage.role"]], "set_output() (giskard_hub.data.evaluation method)": [[3, "giskard_hub.data.Evaluation.set_output"]], "single_eval() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.single_eval"]], "supported_languages (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.supported_languages"]], "tags (giskard_hub.data.conversation attribute)": [[3, "giskard_hub.data.Conversation.tags"]], "tags (giskard_hub.data.dataset attribute)": [[3, "giskard_hub.data.Dataset.tags"]], "total (giskard_hub.data.metric attribute)": [[3, "giskard_hub.data.Metric.total"]], "update_evaluation() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.update_evaluation"]], "update_evaluations() (giskard_hub.client.hubclient method)": [[3, "giskard_hub.client.HubClient.update_evaluations"]], "update_evaluations() (in module giskard_hub.cli)": [[3, "giskard_hub.cli.update_evaluations"]], "updated_at (giskard_hub.data.entity attribute)": [[3, "giskard_hub.data.Entity.updated_at"]], "url (giskard_hub.data.model attribute)": [[3, "giskard_hub.data.Model.url"]]}})
\ No newline at end of file
diff --git a/docs/sources.html b/docs/sources.html
index b7fb0ae..8afebaa 100644
--- a/docs/sources.html
+++ b/docs/sources.html
@@ -80,7 +80,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="cli.html">CLI docs</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Code</span></p>
+<p class="caption" role="heading"><span class="caption-text">Code Documentation</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="#cli">CLI</a></li>