-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsdk.py
More file actions
444 lines (394 loc) · 15.2 KB
/
Copy pathsdk.py
File metadata and controls
444 lines (394 loc) · 15.2 KB
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
from __future__ import annotations
import json
import time
import uuid
from dataclasses import dataclass
from pathlib import Path
from typing import Any, Dict, Iterable, Iterator, List, Optional
import requests
class SDKError(Exception):
"""Base SDK exception."""
class APIError(SDKError):
"""HTTP-level API error with status and response body."""
def __init__(self, status_code: int, message: str, payload: Any | None = None):
super().__init__(f"{status_code}: {message}")
self.status_code = status_code
self.message = message
self.payload = payload
@dataclass(frozen=True)
class ClientAuth:
api_key: str
def as_headers(self) -> Dict[str, str]:
return {"Authorization": f"Bearer {self.api_key}"}
class _ProjectsAPI:
def __init__(self, client: "RAGOpenAIClient"):
self._client = client
def create(self, name: str, description: str | None = None) -> Dict[str, Any]:
payload = {"name": name, "description": description}
data = self._client._request_json("POST", "/api/v1/projects", json_body=payload)
return data.get("project", data)
def ensure(self, name: str, description: str | None = None) -> Dict[str, Any]:
"""
Create a project by name, or reuse existing one with the same name.
Helpful when server project limits are reached.
"""
try:
return self.create(name=name, description=description)
except APIError as exc:
if exc.status_code != 400 or "project_limit_reached" not in str(exc.message):
raise
projects = self.list()
for project in projects:
if project.get("name") == name:
return project
raise
def list(self) -> List[Dict[str, Any]]:
data = self._client._request_json("GET", "/api/v1/projects")
return data.get("projects", [])
def get(self, project_id: str) -> Dict[str, Any]:
data = self._client._request_json("GET", f"/api/v1/projects/{project_id}")
return data.get("project", data)
def delete(self, project_id: str) -> Dict[str, Any]:
return self._client._request_json("DELETE", f"/api/v1/projects/{project_id}")
class _ChatCompletionsAPI:
def __init__(self, client: "RAGOpenAIClient"):
self._client = client
def create(
self,
*,
project_id: str,
messages: List[Dict[str, str]],
stream: bool = False,
include_sources: bool = True,
mode: str | None = None,
top_k: int | None = None,
max_llm_calls: int | None = None,
max_fact_queries: int | None = None,
use_hyde: bool | None = None,
use_fact_queries: bool | None = None,
use_retry: bool | None = None,
use_tools: bool | None = None,
agent_mode: str | None = None,
filters: Dict[str, Any] | None = None,
) -> Dict[str, Any] | Iterator[Dict[str, Any]]:
query, history = self._split_messages(messages)
payload: Dict[str, Any] = {
"project_id": project_id,
"query": query,
"history": history,
"include_sources": include_sources,
}
optional = {
"mode": mode,
"top_k": top_k,
"max_llm_calls": max_llm_calls,
"max_fact_queries": max_fact_queries,
"use_hyde": use_hyde,
"use_fact_queries": use_fact_queries,
"use_retry": use_retry,
"use_tools": use_tools,
"agent_mode": agent_mode,
"filters": filters,
}
payload.update({k: v for k, v in optional.items() if v is not None})
if stream:
return self._stream_completion(payload)
raw = self._client._request_json("POST", "/api/v1/chat", json_body=payload)
return self._to_openai_chat_response(raw)
@staticmethod
def _split_messages(messages: List[Dict[str, str]]) -> tuple[str, List[Dict[str, str]]]:
if not messages:
raise SDKError("messages must not be empty")
last = messages[-1]
role = last.get("role")
content = (last.get("content") or "").strip()
if role != "user" or not content:
raise SDKError("last message must be a non-empty user message")
history = [
{"role": m.get("role", ""), "content": m.get("content", "")}
for m in messages[:-1]
if m.get("role") in {"user", "assistant", "system"} and m.get("content")
]
return content, history
def _stream_completion(self, payload: Dict[str, Any]) -> Iterator[Dict[str, Any]]:
completion_id = f"chatcmpl-{uuid.uuid4().hex}"
created = int(time.time())
stream = self._client._request_stream("POST", "/api/v1/chat/stream", json_body=payload)
for event in self._client._iter_sse_events(stream):
event_type = event.get("type")
if event_type == "done":
yield {
"id": completion_id,
"object": "chat.completion.chunk",
"created": created,
"choices": [{"index": 0, "delta": {}, "finish_reason": "stop"}],
"rag_event": event,
}
break
delta_text = event.get("delta") or event.get("token") or event.get("content") or ""
yield {
"id": completion_id,
"object": "chat.completion.chunk",
"created": created,
"choices": [
{
"index": 0,
"delta": {"content": delta_text} if delta_text else {},
"finish_reason": None,
}
],
"rag_event": event,
}
@staticmethod
def _to_openai_chat_response(raw: Dict[str, Any]) -> Dict[str, Any]:
answer = raw.get("answer", "")
return {
"id": raw.get("trace_id", f"chatcmpl-{uuid.uuid4().hex}"),
"object": "chat.completion",
"created": int(time.time()),
"model": raw.get("mode", "rag-agent"),
"choices": [
{
"index": 0,
"message": {"role": "assistant", "content": answer},
"finish_reason": "stop",
}
],
"usage": None,
"rag": {
"sources": raw.get("sources", []),
"context": raw.get("context", []),
"partial": raw.get("partial", False),
"degraded": raw.get("degraded", []),
"agent_mode": raw.get("agent_mode", "single"),
"raw": raw,
},
}
class _ChatAPI:
def __init__(self, client: "RAGOpenAIClient"):
self.completions = _ChatCompletionsAPI(client)
def create(
self,
*,
project_id: str,
messages: List[Dict[str, str]],
stream: bool = False,
include_sources: bool = True,
mode: str | None = None,
top_k: int | None = None,
max_llm_calls: int | None = None,
max_fact_queries: int | None = None,
use_hyde: bool | None = None,
use_fact_queries: bool | None = None,
use_retry: bool | None = None,
use_tools: bool | None = None,
agent_mode: str | None = None,
filters: Dict[str, Any] | None = None,
) -> Dict[str, Any] | Iterator[Dict[str, Any]]:
"""
Preferred chat entrypoint for SDK users.
This delegates to chat-completions compatibility layer internally.
"""
return self.completions.create(
project_id=project_id,
messages=messages,
stream=stream,
include_sources=include_sources,
mode=mode,
top_k=top_k,
max_llm_calls=max_llm_calls,
max_fact_queries=max_fact_queries,
use_hyde=use_hyde,
use_fact_queries=use_fact_queries,
use_retry=use_retry,
use_tools=use_tools,
agent_mode=agent_mode,
filters=filters,
)
class _DocumentsAPI:
def __init__(self, client: "RAGOpenAIClient"):
self._client = client
def list(self, *, project_id: str, limit: int = 50, offset: int = 0) -> Dict[str, Any]:
return self._client._request_json(
"GET",
f"/api/v1/projects/{project_id}/documents?limit={limit}&offset={offset}",
)
def get(self, *, doc_id: str) -> Dict[str, Any]:
return self._client._request_json("GET", f"/api/v1/documents/{doc_id}")
def delete(self, *, doc_id: str) -> Dict[str, Any]:
return self._client._request_json("DELETE", f"/api/v1/documents/{doc_id}")
def status(self, *, doc_id: str) -> Dict[str, Any]:
return self._client._request_json("GET", f"/api/v1/documents/{doc_id}/status")
def processing_status(self, *, doc_id: str) -> Dict[str, Any]:
"""
Return normalized status flags on top of the raw `/status` event.
"""
event = self.status(doc_id=doc_id)
event_type = str(event.get("event_type", "")).lower()
imported = event_type in {"ingested", "processed", "embeddings_created", "indexed"}
vectorized = event_type in {"embeddings_created", "indexed"}
failed = event_type == "error_processing"
ready = event_type == "indexed"
return {
"doc_id": doc_id,
"event_type": event_type,
"imported": imported,
"vectorized": vectorized,
"ready": ready,
"failed": failed,
"raw": event,
}
def wait_until_ready(
self,
*,
doc_id: str,
timeout_seconds: float = 300.0,
poll_interval_seconds: float = 2.0,
) -> Dict[str, Any]:
"""
Poll document status until it is indexed, fails, or times out.
"""
deadline = time.time() + timeout_seconds
while True:
status = self.processing_status(doc_id=doc_id)
if status["ready"]:
return status
if status["failed"]:
raise SDKError(f"document processing failed: {doc_id}")
if time.time() >= deadline:
raise SDKError(f"document was not ready before timeout: {doc_id}")
time.sleep(poll_interval_seconds)
class RAGOpenAIClient:
"""
Python SDK for gate_v2 API.
Usage:
client = RAGOpenAIClient(
base_url="http://localhost:8917",
auth=ClientAuth(api_key="sk-..."),
)
project = client.projects.create(name="my-project")
resp = client.chat.completions.create(
project_id=project["project_id"],
messages=[{"role": "user", "content": "Explain RAG in 2 lines"}],
)
"""
def __init__(
self,
*,
base_url: str,
auth: ClientAuth,
timeout_seconds: float = 120.0,
):
self.base_url = base_url.rstrip("/")
self.auth = auth
self.timeout_seconds = timeout_seconds
self._session = requests.Session()
self.projects = _ProjectsAPI(self)
self.chat = _ChatAPI(self)
self.documents = _DocumentsAPI(self)
def close(self) -> None:
self._session.close()
def __enter__(self) -> "RAGOpenAIClient":
return self
def __exit__(self, exc_type, exc, tb) -> None:
self.close()
def upload_document(
self,
*,
project_id: str,
file_path: str | Path,
title: str | None = None,
description: str | None = None,
) -> Dict[str, Any]:
path = Path(file_path)
if not path.exists():
raise SDKError(f"file not found: {path}")
data = {
"title": title or path.name,
"description": description or "",
}
with path.open("rb") as fh:
files = {"file": (path.name, fh)}
return self._request_json(
"POST",
f"/api/v1/projects/{project_id}/upload",
data=data,
files=files,
)
def _request_json(
self,
method: str,
path: str,
*,
json_body: Dict[str, Any] | None = None,
data: Dict[str, Any] | None = None,
files: Dict[str, Any] | None = None,
) -> Dict[str, Any]:
headers = {"Accept": "application/json", **self.auth.as_headers()}
if json_body is not None:
headers["Content-Type"] = "application/json"
resp = self._session.request(
method=method,
url=f"{self.base_url}{path}",
headers=headers,
json=json_body,
data=data,
files=files,
timeout=self.timeout_seconds,
)
if resp.status_code >= 400:
self._raise_api_error(resp)
if not resp.content:
return {}
try:
return resp.json()
except ValueError:
raise APIError(resp.status_code, "non_json_response", payload=resp.text) from None
def _request_stream(self, method: str, path: str, *, json_body: Dict[str, Any]) -> requests.Response:
headers = {
"Accept": "text/event-stream",
"Content-Type": "application/json",
**self.auth.as_headers(),
}
resp = self._session.request(
method=method,
url=f"{self.base_url}{path}",
headers=headers,
json=json_body,
timeout=self.timeout_seconds,
stream=True,
)
if resp.status_code >= 400:
self._raise_api_error(resp)
return resp
@staticmethod
def _iter_sse_events(resp: requests.Response) -> Iterator[Dict[str, Any]]:
try:
for raw_line in resp.iter_lines(decode_unicode=True):
if not raw_line:
continue
line = raw_line.strip()
if not line.startswith("data:"):
continue
payload = line[5:].strip()
if payload in {"", "[DONE]"}:
continue
try:
yield json.loads(payload)
except json.JSONDecodeError:
yield {"type": "raw", "content": payload}
finally:
resp.close()
@staticmethod
def _raise_api_error(resp: requests.Response) -> None:
payload: Any
try:
payload = resp.json()
if isinstance(payload, dict):
message = payload.get("detail") or payload.get("error") or str(payload)
else:
message = str(payload)
except ValueError:
payload = resp.text
message = resp.text
raise APIError(resp.status_code, message, payload=payload)