ragit 0.4.5

git-like rag pipeline
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

import json
import os
import requests
from server import (
    create_repo,
    create_user,
    get_api_key,
    spawn_ragit_server,
)
from typing import Optional
from utils import cargo_run, goto_root, mk_and_cd_tmp_dir

def server_chat(test_model: str):
    goto_root()
    server_process = None

    try:
        server_process = spawn_ragit_server()
        mk_and_cd_tmp_dir()

        # step 1: init sample 1 (rustc)
        cargo_run(["clone", "https://ragit.baehyunsol.com/sample/rustc", "sample1"])
        os.chdir("sample1")

        # There's a small quirk here:
        # `ragit-server` and local knowledge-base are looking at different `models.json` files.
        # The test runs on the server but `config --set model` alters the local knowledge-base.
        # It does so in order to get api key from the local knowledge-base.
        cargo_run(["config", "--set", "model", test_model])
        exact_model_name = cargo_run(["ls-models", "--selected", "--name-only"], stdout=True).strip()

        create_user(id="test-user", password="secure-password")
        server_api_key = get_api_key(id="test-user", password="secure-password")
        model_api_key = get_model_api_key()
        create_repo(user="test-user", repo="sample1", api_key=server_api_key)

        # set default model of server
        register_model(
            user="test-user",
            model_name=exact_model_name,
            model_api_key=model_api_key,
            server_api_key=server_api_key,
        )

        cargo_run(["push", "--configs", "--remote=http://127.0.0.1:41127/test-user/sample1"])
        os.chdir("..")

        # step 2: init sample 2 (empty knowledge-base)
        os.mkdir("sample2")
        os.chdir("sample2")
        cargo_run(["init"])
        cargo_run(["config", "--set", "model", test_model])
        create_repo(user="test-user", repo="sample2", api_key=server_api_key)
        cargo_run(["push", "--configs", "--remote=http://127.0.0.1:41127/test-user/sample2"])
        os.chdir("..")

        # step 3: let's ask questions!
        chat_id1 = requests.post("http://127.0.0.1:41127/test-user/sample1/chat-list").text
        chat_id2 = requests.post("http://127.0.0.1:41127/test-user/sample2/chat-list").text
        responses1 = []
        responses2 = []

        chat_list = requests.get("http://127.0.0.1:41127/test-user/sample1/chat-list").json()
        assert len(chat_list) == 1
        assert str(chat_list[0]["id"]) == chat_id1

        # TODO: what's the difference between multipart/form and body/form? I'm noob to this...
        responses1.append(requests.post(f"http://127.0.0.1:41127/test-user/sample1/chat/{chat_id1}", files={"query": "How does the rust compiler implement type system?"}).json())
        responses2.append(requests.post(f"http://127.0.0.1:41127/test-user/sample2/chat/{chat_id2}", files={"query": "How does the rust compiler implement type system?"}).json())

        responses1.append(requests.post(f"http://127.0.0.1:41127/test-user/sample1/chat/{chat_id1}", data={"query": "What do you mean by MIR?"}).json())
        responses2.append(requests.post(f"http://127.0.0.1:41127/test-user/sample2/chat/{chat_id2}", data={"query": "What do you mean by MIR?"}).json())

        responses1.append(requests.post(f"http://127.0.0.1:41127/test-user/sample1/chat/{chat_id1}", files={"query": "Thanks!"}).json())
        responses2.append(requests.post(f"http://127.0.0.1:41127/test-user/sample2/chat/{chat_id2}", files={"query": "Thanks!"}).json())

        history1 = requests.get(f"http://127.0.0.1:41127/test-user/sample1/chat/{chat_id1}").json()["history"]
        history2 = requests.get(f"http://127.0.0.1:41127/test-user/sample2/chat/{chat_id2}").json()["history"]

        chat_list = requests.get("http://127.0.0.1:41127/test-user/sample1/chat-list").json()
        assert len(chat_list) == 1
        assert str(chat_list[0]["id"]) == chat_id1

        for response in responses2:
            assert len(response["chunk_uids"]) == 0

        assert [(h["response"], h["multi_turn_schema"]) for h in history1] == [(r["response"], r["multi_turn_schema"]) for r in responses1]
        assert [(h["response"], h["multi_turn_schema"]) for h in history2] == [(r["response"], r["multi_turn_schema"]) for r in responses2]

        # build-search-index is idempotent
        for _ in range(3):
            assert requests.post("http://127.0.0.1:41127/test-user/sample1/build-search-index").status_code == 200
            assert requests.post("http://127.0.0.1:41127/test-user/sample2/build-search-index").status_code == 200

    finally:
        if server_process is not None:
            server_process.kill()

# It assumes that `rag config --set model _` is already run.
def get_model_api_key() -> Optional[str]:
    # `rag ls-models` do not dump these models
    if cargo_run(["config", "--get", "model"], stdout=True).strip() in ["dummy", "stdin", "error"]:
        return None

    with open(os.path.join(".ragit", "models.json"), "r") as f:
        models = json.load(f)

    model_full_name = json.loads(cargo_run(["ls-models", "--json", "--selected"], stdout=True).strip())[0]["name"]
    model = [model for model in models if model["name"] == model_full_name][0]

    if (api_key := model.get("api_key")) is not None:
        return api_key

    elif (api_env_var := model.get("api_env_var")) is not None:
        if (api_key := os.environ.get(api_env_var)) is not None:
            return api_key

        else:
            raise Exception(f"API key is not set. Please set the {api_env_var} environment variable.")

    # some models may not require an API key
    else:
        return None

# There's a small quirk here:
# ragit-server and local knowledge-base are looking at different `models.json` files.
# The same model might have (slightly) different names.
# What's even worse is that `model_name` is given by the test runner, who doesn't know about
# `models.json` at all. So it first tries to guess what the actual name of the model is.
def register_model(
    user: str,
    model_name: str,
    model_api_key: Optional[str],
    server_api_key: str,
) -> str:
    models = requests.get(f"http://127.0.0.1:41127/ai-model-list").json()
    models = [model for model in models if model_name in model["name"] or model_name in model["api_name"]]

    if len(models) == 0:
        raise Exception(f"No model named {model_name} in the server.")

    if len(models) > 1:
        raise Exception(f"Model name {model_name} is ambiguous: {models}")

    model_id = models[0]["id"]

    # I run it 3 times because I want to make sure that this api
    # not only registers a model but also updates a model.
    for i in range(3):
        response = requests.put(
            f"http://127.0.0.1:41127/user-list/{user}/ai-model-list",
            json={ "model_id": model_id, "default_model": i == 2, "api_key": model_api_key },
            headers={ "x-api-key": server_api_key },
        )

    assert response.status_code == 200, f"Failed to set default model: {response.text}"
    return model_name

def put_model_api_key(user: str, model_name: str, model_api_key: str, server_api_key: str):
    response = requests.put(
        f"http://127.0.0.1:41127/user-list/{user}/ai-model-list",
        json={ "model": model_name, "api_key": model_api_key },
        headers={ "x-api-key": server_api_key },
    )
    assert response.status_code == 200, f"Failed to set API key: {response.text}"