File size: 10,278 Bytes
bde2f3a | 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 | # rugmunch.RagApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**bulk_api_v1_rag_v2_bulk_ingest_post**](RagApi.md#bulk_api_v1_rag_v2_bulk_ingest_post) | **POST** /api/v1/rag/v2/bulk-ingest | Bulk
[**feedback_api_v1_rag_v2_feedback_post**](RagApi.md#feedback_api_v1_rag_v2_feedback_post) | **POST** /api/v1/rag/v2/feedback | Feedback
[**ingest_api_v1_rag_v2_ingest_post**](RagApi.md#ingest_api_v1_rag_v2_ingest_post) | **POST** /api/v1/rag/v2/ingest | Ingest
[**search_api_v1_rag_v2_search_post**](RagApi.md#search_api_v1_rag_v2_search_post) | **POST** /api/v1/rag/v2/search | Search
[**stats_api_v1_rag_v2_stats_get**](RagApi.md#stats_api_v1_rag_v2_stats_get) | **GET** /api/v1/rag/v2/stats | Stats
# **bulk_api_v1_rag_v2_bulk_ingest_post**
> Dict[str, object] bulk_api_v1_rag_v2_bulk_ingest_post(bulk_ingest_request)
Bulk
Ingest many items into a collection sequentially (max 500 per call).
### Example
```python
import rugmunch
from rugmunch.models.bulk_ingest_request import BulkIngestRequest
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.RagApi(api_client)
bulk_ingest_request = rugmunch.BulkIngestRequest() # BulkIngestRequest |
try:
# Bulk
api_response = api_instance.bulk_api_v1_rag_v2_bulk_ingest_post(bulk_ingest_request)
print("The response of RagApi->bulk_api_v1_rag_v2_bulk_ingest_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RagApi->bulk_api_v1_rag_v2_bulk_ingest_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**bulk_ingest_request** | [**BulkIngestRequest**](BulkIngestRequest.md)| |
### Return type
**Dict[str, object]**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **feedback_api_v1_rag_v2_feedback_post**
> IngestResult feedback_api_v1_rag_v2_feedback_post(feedback_record)
Feedback
Record scanner → RAG feedback. Ingests known scam into known_scams collection.
### Example
```python
import rugmunch
from rugmunch.models.feedback_record import FeedbackRecord
from rugmunch.models.ingest_result import IngestResult
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.RagApi(api_client)
feedback_record = rugmunch.FeedbackRecord() # FeedbackRecord |
try:
# Feedback
api_response = api_instance.feedback_api_v1_rag_v2_feedback_post(feedback_record)
print("The response of RagApi->feedback_api_v1_rag_v2_feedback_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RagApi->feedback_api_v1_rag_v2_feedback_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**feedback_record** | [**FeedbackRecord**](FeedbackRecord.md)| |
### Return type
[**IngestResult**](IngestResult.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **ingest_api_v1_rag_v2_ingest_post**
> IngestResult ingest_api_v1_rag_v2_ingest_post(ingest_request)
Ingest
Ingest a document into the RAG system.
### Example
```python
import rugmunch
from rugmunch.models.ingest_request import IngestRequest
from rugmunch.models.ingest_result import IngestResult
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.RagApi(api_client)
ingest_request = rugmunch.IngestRequest() # IngestRequest |
try:
# Ingest
api_response = api_instance.ingest_api_v1_rag_v2_ingest_post(ingest_request)
print("The response of RagApi->ingest_api_v1_rag_v2_ingest_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RagApi->ingest_api_v1_rag_v2_ingest_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ingest_request** | [**IngestRequest**](IngestRequest.md)| |
### Return type
[**IngestResult**](IngestResult.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **search_api_v1_rag_v2_search_post**
> SearchResponse search_api_v1_rag_v2_search_post(search_request)
Search
RAG search. Returns Pydantic response with hits + scores.
### Example
```python
import rugmunch
from rugmunch.models.search_request import SearchRequest
from rugmunch.models.search_response import SearchResponse
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.RagApi(api_client)
search_request = rugmunch.SearchRequest() # SearchRequest |
try:
# Search
api_response = api_instance.search_api_v1_rag_v2_search_post(search_request)
print("The response of RagApi->search_api_v1_rag_v2_search_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RagApi->search_api_v1_rag_v2_search_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**search_request** | [**SearchRequest**](SearchRequest.md)| |
### Return type
[**SearchResponse**](SearchResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **stats_api_v1_rag_v2_stats_get**
> Dict[str, object] stats_api_v1_rag_v2_stats_get()
Stats
Per-collection vector counts + active embedder backend.
### Example
```python
import rugmunch
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.RagApi(api_client)
try:
# Stats
api_response = api_instance.stats_api_v1_rag_v2_stats_get()
print("The response of RagApi->stats_api_v1_rag_v2_stats_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RagApi->stats_api_v1_rag_v2_stats_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
**Dict[str, object]**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|