From 0e9aa6a706442d0c71284cfc5f4b650927b67336 Mon Sep 17 00:00:00 2001 From: nicola-corbellini Date: Mon, 22 Jul 2024 04:12:17 +0000 Subject: [PATCH] deploy: 02d0946134df5937e8848d4d5d9219b09f057ab2 --- .nojekyll | 0 404.html | 1042 ++ API_Documentation/SUMMARY/index.html | 1086 ++ API_Documentation/api/embedder_api/index.html | 5525 ++++++ .../api/large_language_model_api/index.html | 5525 ++++++ API_Documentation/api/memory_api/index.html | 12426 ++++++++++++++ API_Documentation/api/plugins_api/index.html | 14011 ++++++++++++++++ .../api/rabbit_hole_api/index.html | 7078 ++++++++ API_Documentation/api/settings_api/index.html | 8473 ++++++++++ API_Documentation/api/status_api/index.html | 2593 +++ API_Documentation/api_client/index.html | 5951 +++++++ API_Documentation/api_response/index.html | 1286 ++ API_Documentation/cat_client/index.html | 1802 ++ API_Documentation/config/index.html | 1280 ++ API_Documentation/configuration/index.html | 4566 +++++ API_Documentation/exceptions/index.html | 2242 +++ .../models/body_upload_url/index.html | 1693 ++ .../models/http_validation_error/index.html | 1709 ++ .../models/location_inner/index.html | 1758 ++ .../models/setting_body/index.html | 1725 ++ .../models/validation_error/index.html | 1721 ++ API_Documentation/models/value/index.html | 1758 ++ API_Documentation/rest/index.html | 2219 +++ assets/_mkdocstrings.css | 119 + assets/cheshire-cat-logo.svg | 14 + assets/favicon.ico | Bin 0 -> 15086 bytes assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.fe8b6f2b.min.js | 29 + assets/javascripts/bundle.fe8b6f2b.min.js.map | 7 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.el.min.js | 1 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.he.min.js | 1 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.hy.min.js | 1 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.kn.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + assets/javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.te.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 ++++++++ .../workers/search.b8dbb3d2.min.js | 42 + .../workers/search.b8dbb3d2.min.js.map | 7 + assets/stylesheets/main.76a95c52.min.css | 1 + assets/stylesheets/main.76a95c52.min.css.map | 1 + assets/stylesheets/palette.06af60db.min.css | 1 + .../stylesheets/palette.06af60db.min.css.map | 1 + getting_started/examples/index.html | 1121 ++ getting_started/installation/index.html | 1103 ++ index.html | 1068 ++ objects.inv | Bin 0 -> 2291 bytes search/search_index.json | 1 + sitemap.xml | 3 + sitemap.xml.gz | Bin 0 -> 127 bytes 76 files changed, 98188 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 API_Documentation/SUMMARY/index.html create mode 100644 API_Documentation/api/embedder_api/index.html create mode 100644 API_Documentation/api/large_language_model_api/index.html create mode 100644 API_Documentation/api/memory_api/index.html create mode 100644 API_Documentation/api/plugins_api/index.html create mode 100644 API_Documentation/api/rabbit_hole_api/index.html create mode 100644 API_Documentation/api/settings_api/index.html create mode 100644 API_Documentation/api/status_api/index.html create mode 100644 API_Documentation/api_client/index.html create mode 100644 API_Documentation/api_response/index.html create mode 100644 API_Documentation/cat_client/index.html create mode 100644 API_Documentation/config/index.html create mode 100644 API_Documentation/configuration/index.html create mode 100644 API_Documentation/exceptions/index.html create mode 100644 API_Documentation/models/body_upload_url/index.html create mode 100644 API_Documentation/models/http_validation_error/index.html create mode 100644 API_Documentation/models/location_inner/index.html create mode 100644 API_Documentation/models/setting_body/index.html create mode 100644 API_Documentation/models/validation_error/index.html create mode 100644 API_Documentation/models/value/index.html create mode 100644 API_Documentation/rest/index.html create mode 100644 assets/_mkdocstrings.css create mode 100644 assets/cheshire-cat-logo.svg create mode 100644 assets/favicon.ico create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.fe8b6f2b.min.js create mode 100644 assets/javascripts/bundle.fe8b6f2b.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js.map create mode 100644 assets/stylesheets/main.76a95c52.min.css create mode 100644 assets/stylesheets/main.76a95c52.min.css.map create mode 100644 assets/stylesheets/palette.06af60db.min.css create mode 100644 assets/stylesheets/palette.06af60db.min.css.map create mode 100644 getting_started/examples/index.html create mode 100644 getting_started/installation/index.html create mode 100644 index.html create mode 100644 objects.inv create mode 100644 search/search_index.json create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..9410a3f --- /dev/null +++ b/404.html @@ -0,0 +1,1042 @@ + + + + + + + + + + + + + + + + + + + The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/SUMMARY/index.html b/API_Documentation/SUMMARY/index.html new file mode 100644 index 0000000..557ca75 --- /dev/null +++ b/API_Documentation/SUMMARY/index.html @@ -0,0 +1,1086 @@ + + + + + + + + + + + + + + + + + + + SUMMARY - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/api/embedder_api/index.html b/API_Documentation/api/embedder_api/index.html new file mode 100644 index 0000000..a2e73be --- /dev/null +++ b/API_Documentation/api/embedder_api/index.html @@ -0,0 +1,5525 @@ + + + + + + + + + + + + + + + + + + + + + + + embedder_api - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

embedder_api

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ EmbedderApi + + +

+ + +
+ + +

NOTE: This class is auto generated by OpenAPI Generator +Ref: https://openapi-generator.tech

+

Do not edit the class manually.

+ +
+ Source code in cheshire_cat_api/api/embedder_api.py + 
 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
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
+512
+513
+514
+515
+516
+517
+518
+519
+520
+521
+522
+523
+524
+525
+526
+527
+528
+529
+530
+531
+532
+533
+534
+535
+536
+537
+538
+539
+540
+541
+542
+543
+544
+545
+546
+547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
+769
+770
+771
+772
+773
+774
+775
+776
+777
+778
+779
+780
+781
+782
+783
+784
+785
+786
+787
+788
+789
+790
+791
+792
+793
+794
+795
+796
+797
+798
+799
+800
+801
+802
+803
+804
+805
+806
+807
+808
+809
+810
+811
+812
+813
+814
+815
+816
+817
+818
+819
+820
+821
+822
+823
+824
+825
+826
+827
+828
+829
+830
+831
+832
+833
+834
+835
+836
+837
+838
+839
+840
+841
+842
+843
+844
+845
+846
class EmbedderApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_embedder_settings(
+        self,
+        language_embedder_name: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Embedder Settings
+
+        Get settings and schema of the specified Embedder
+
+        :param language_embedder_name: (required)
+        :type language_embedder_name: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_embedder_settings_serialize(
+            language_embedder_name=language_embedder_name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_embedder_settings_with_http_info(
+        self,
+        language_embedder_name: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Embedder Settings
+
+        Get settings and schema of the specified Embedder
+
+        :param language_embedder_name: (required)
+        :type language_embedder_name: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_embedder_settings_serialize(
+            language_embedder_name=language_embedder_name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_embedder_settings_without_preload_content(
+        self,
+        language_embedder_name: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Embedder Settings
+
+        Get settings and schema of the specified Embedder
+
+        :param language_embedder_name: (required)
+        :type language_embedder_name: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_embedder_settings_serialize(
+            language_embedder_name=language_embedder_name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_embedder_settings_serialize(
+        self,
+        language_embedder_name,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if language_embedder_name is not None:
+            _path_params['languageEmbedderName'] = language_embedder_name
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/embedder/settings/{languageEmbedderName}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_embedders_settings(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Embedders Settings
+
+        Get the list of the Embedders
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_embedders_settings_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_embedders_settings_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Embedders Settings
+
+        Get the list of the Embedders
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_embedders_settings_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_embedders_settings_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Embedders Settings
+
+        Get the list of the Embedders
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_embedders_settings_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_embedders_settings_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/embedder/settings/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def upsert_embedder_setting(
+        self,
+        language_embedder_name: StrictStr,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Upsert Embedder Setting
+
+        Upsert the Embedder setting
+
+        :param language_embedder_name: (required)
+        :type language_embedder_name: str
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upsert_embedder_setting_serialize(
+            language_embedder_name=language_embedder_name,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def upsert_embedder_setting_with_http_info(
+        self,
+        language_embedder_name: StrictStr,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Upsert Embedder Setting
+
+        Upsert the Embedder setting
+
+        :param language_embedder_name: (required)
+        :type language_embedder_name: str
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upsert_embedder_setting_serialize(
+            language_embedder_name=language_embedder_name,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def upsert_embedder_setting_without_preload_content(
+        self,
+        language_embedder_name: StrictStr,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Upsert Embedder Setting
+
+        Upsert the Embedder setting
+
+        :param language_embedder_name: (required)
+        :type language_embedder_name: str
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upsert_embedder_setting_serialize(
+            language_embedder_name=language_embedder_name,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _upsert_embedder_setting_serialize(
+        self,
+        language_embedder_name,
+        body,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if language_embedder_name is not None:
+            _path_params['languageEmbedderName'] = language_embedder_name
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if body is not None:
+            _body_params = body
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='PUT',
+            resource_path='/embedder/settings/{languageEmbedderName}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ get_embedder_settings(language_embedder_name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Embedder Settings

+

Get settings and schema of the specified Embedder

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_embedder_name + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/embedder_api.py + 
 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
@validate_call
+def get_embedder_settings(
+    self,
+    language_embedder_name: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Embedder Settings
+
+    Get settings and schema of the specified Embedder
+
+    :param language_embedder_name: (required)
+    :type language_embedder_name: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_embedder_settings_serialize(
+        language_embedder_name=language_embedder_name,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_embedder_settings_with_http_info(language_embedder_name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Embedder Settings

+

Get settings and schema of the specified Embedder

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_embedder_name + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/embedder_api.py + 
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
@validate_call
+def get_embedder_settings_with_http_info(
+    self,
+    language_embedder_name: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Embedder Settings
+
+    Get settings and schema of the specified Embedder
+
+    :param language_embedder_name: (required)
+    :type language_embedder_name: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_embedder_settings_serialize(
+        language_embedder_name=language_embedder_name,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_embedder_settings_without_preload_content(language_embedder_name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Embedder Settings

+

Get settings and schema of the specified Embedder

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_embedder_name + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/embedder_api.py + 
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
@validate_call
+def get_embedder_settings_without_preload_content(
+    self,
+    language_embedder_name: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Embedder Settings
+
+    Get settings and schema of the specified Embedder
+
+    :param language_embedder_name: (required)
+    :type language_embedder_name: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_embedder_settings_serialize(
+        language_embedder_name=language_embedder_name,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ get_embedders_settings(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Embedders Settings

+

Get the list of the Embedders

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/embedder_api.py + 
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
@validate_call
+def get_embedders_settings(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Embedders Settings
+
+    Get the list of the Embedders
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_embedders_settings_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_embedders_settings_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Embedders Settings

+

Get the list of the Embedders

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/embedder_api.py + 
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
@validate_call
+def get_embedders_settings_with_http_info(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Embedders Settings
+
+    Get the list of the Embedders
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_embedders_settings_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_embedders_settings_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Embedders Settings

+

Get the list of the Embedders

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/embedder_api.py + 
441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
@validate_call
+def get_embedders_settings_without_preload_content(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Embedders Settings
+
+    Get the list of the Embedders
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_embedders_settings_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ upsert_embedder_setting(language_embedder_name, body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upsert Embedder Setting

+

Upsert the Embedder setting

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_embedder_name + StrictStr + +
+

(required)

+
+ 		+ required +
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/embedder_api.py + 
559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
@validate_call
+def upsert_embedder_setting(
+    self,
+    language_embedder_name: StrictStr,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Upsert Embedder Setting
+
+    Upsert the Embedder setting
+
+    :param language_embedder_name: (required)
+    :type language_embedder_name: str
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upsert_embedder_setting_serialize(
+        language_embedder_name=language_embedder_name,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ upsert_embedder_setting_with_http_info(language_embedder_name, body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upsert Embedder Setting

+

Upsert the Embedder setting

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_embedder_name + StrictStr + +
+

(required)

+
+ 		+ required +
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/embedder_api.py + 
632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
@validate_call
+def upsert_embedder_setting_with_http_info(
+    self,
+    language_embedder_name: StrictStr,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Upsert Embedder Setting
+
+    Upsert the Embedder setting
+
+    :param language_embedder_name: (required)
+    :type language_embedder_name: str
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upsert_embedder_setting_serialize(
+        language_embedder_name=language_embedder_name,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ upsert_embedder_setting_without_preload_content(language_embedder_name, body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upsert Embedder Setting

+

Upsert the Embedder setting

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_embedder_name + StrictStr + +
+

(required)

+
+ 		+ required +
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/embedder_api.py + 
705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
+769
+770
+771
@validate_call
+def upsert_embedder_setting_without_preload_content(
+    self,
+    language_embedder_name: StrictStr,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Upsert Embedder Setting
+
+    Upsert the Embedder setting
+
+    :param language_embedder_name: (required)
+    :type language_embedder_name: str
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upsert_embedder_setting_serialize(
+        language_embedder_name=language_embedder_name,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/api/large_language_model_api/index.html b/API_Documentation/api/large_language_model_api/index.html new file mode 100644 index 0000000..caf523d --- /dev/null +++ b/API_Documentation/api/large_language_model_api/index.html @@ -0,0 +1,5525 @@ + + + + + + + + + + + + + + + + + + + + + + + large_language_model_api - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

large_language_model_api

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ LargeLanguageModelApi + + +

+ + +
+ + +

NOTE: This class is auto generated by OpenAPI Generator +Ref: https://openapi-generator.tech

+

Do not edit the class manually.

+ +
+ Source code in cheshire_cat_api/api/large_language_model_api.py + 
 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
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
+512
+513
+514
+515
+516
+517
+518
+519
+520
+521
+522
+523
+524
+525
+526
+527
+528
+529
+530
+531
+532
+533
+534
+535
+536
+537
+538
+539
+540
+541
+542
+543
+544
+545
+546
+547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
+769
+770
+771
+772
+773
+774
+775
+776
+777
+778
+779
+780
+781
+782
+783
+784
+785
+786
+787
+788
+789
+790
+791
+792
+793
+794
+795
+796
+797
+798
+799
+800
+801
+802
+803
+804
+805
+806
+807
+808
+809
+810
+811
+812
+813
+814
+815
+816
+817
+818
+819
+820
+821
+822
+823
+824
+825
+826
+827
+828
+829
+830
+831
+832
+833
+834
+835
+836
+837
+838
+839
+840
+841
+842
+843
+844
+845
+846
class LargeLanguageModelApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_llm_settings(
+        self,
+        language_model_name: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Llm Settings
+
+        Get settings and schema of the specified Large Language Model
+
+        :param language_model_name: (required)
+        :type language_model_name: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_llm_settings_serialize(
+            language_model_name=language_model_name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_llm_settings_with_http_info(
+        self,
+        language_model_name: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Llm Settings
+
+        Get settings and schema of the specified Large Language Model
+
+        :param language_model_name: (required)
+        :type language_model_name: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_llm_settings_serialize(
+            language_model_name=language_model_name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_llm_settings_without_preload_content(
+        self,
+        language_model_name: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Llm Settings
+
+        Get settings and schema of the specified Large Language Model
+
+        :param language_model_name: (required)
+        :type language_model_name: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_llm_settings_serialize(
+            language_model_name=language_model_name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_llm_settings_serialize(
+        self,
+        language_model_name,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if language_model_name is not None:
+            _path_params['languageModelName'] = language_model_name
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/llm/settings/{languageModelName}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_llms_settings(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Llms Settings
+
+        Get the list of the Large Language Models
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_llms_settings_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_llms_settings_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Llms Settings
+
+        Get the list of the Large Language Models
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_llms_settings_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_llms_settings_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Llms Settings
+
+        Get the list of the Large Language Models
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_llms_settings_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_llms_settings_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/llm/settings/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def upsert_llm_setting(
+        self,
+        language_model_name: StrictStr,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Upsert Llm Setting
+
+        Upsert the Large Language Model setting
+
+        :param language_model_name: (required)
+        :type language_model_name: str
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upsert_llm_setting_serialize(
+            language_model_name=language_model_name,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def upsert_llm_setting_with_http_info(
+        self,
+        language_model_name: StrictStr,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Upsert Llm Setting
+
+        Upsert the Large Language Model setting
+
+        :param language_model_name: (required)
+        :type language_model_name: str
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upsert_llm_setting_serialize(
+            language_model_name=language_model_name,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def upsert_llm_setting_without_preload_content(
+        self,
+        language_model_name: StrictStr,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Upsert Llm Setting
+
+        Upsert the Large Language Model setting
+
+        :param language_model_name: (required)
+        :type language_model_name: str
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upsert_llm_setting_serialize(
+            language_model_name=language_model_name,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _upsert_llm_setting_serialize(
+        self,
+        language_model_name,
+        body,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if language_model_name is not None:
+            _path_params['languageModelName'] = language_model_name
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if body is not None:
+            _body_params = body
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='PUT',
+            resource_path='/llm/settings/{languageModelName}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ get_llm_settings(language_model_name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Llm Settings

+

Get settings and schema of the specified Large Language Model

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_model_name + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/large_language_model_api.py + 
 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
@validate_call
+def get_llm_settings(
+    self,
+    language_model_name: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Llm Settings
+
+    Get settings and schema of the specified Large Language Model
+
+    :param language_model_name: (required)
+    :type language_model_name: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_llm_settings_serialize(
+        language_model_name=language_model_name,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_llm_settings_with_http_info(language_model_name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Llm Settings

+

Get settings and schema of the specified Large Language Model

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_model_name + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/large_language_model_api.py + 
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
@validate_call
+def get_llm_settings_with_http_info(
+    self,
+    language_model_name: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Llm Settings
+
+    Get settings and schema of the specified Large Language Model
+
+    :param language_model_name: (required)
+    :type language_model_name: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_llm_settings_serialize(
+        language_model_name=language_model_name,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_llm_settings_without_preload_content(language_model_name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Llm Settings

+

Get settings and schema of the specified Large Language Model

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_model_name + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/large_language_model_api.py + 
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
@validate_call
+def get_llm_settings_without_preload_content(
+    self,
+    language_model_name: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Llm Settings
+
+    Get settings and schema of the specified Large Language Model
+
+    :param language_model_name: (required)
+    :type language_model_name: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_llm_settings_serialize(
+        language_model_name=language_model_name,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ get_llms_settings(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Llms Settings

+

Get the list of the Large Language Models

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/large_language_model_api.py + 
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
@validate_call
+def get_llms_settings(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Llms Settings
+
+    Get the list of the Large Language Models
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_llms_settings_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_llms_settings_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Llms Settings

+

Get the list of the Large Language Models

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/large_language_model_api.py + 
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
@validate_call
+def get_llms_settings_with_http_info(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Llms Settings
+
+    Get the list of the Large Language Models
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_llms_settings_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_llms_settings_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Llms Settings

+

Get the list of the Large Language Models

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/large_language_model_api.py + 
441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
@validate_call
+def get_llms_settings_without_preload_content(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Llms Settings
+
+    Get the list of the Large Language Models
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_llms_settings_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ upsert_llm_setting(language_model_name, body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upsert Llm Setting

+

Upsert the Large Language Model setting

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_model_name + StrictStr + +
+

(required)

+
+ 		+ required +
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/large_language_model_api.py + 
559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
@validate_call
+def upsert_llm_setting(
+    self,
+    language_model_name: StrictStr,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Upsert Llm Setting
+
+    Upsert the Large Language Model setting
+
+    :param language_model_name: (required)
+    :type language_model_name: str
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upsert_llm_setting_serialize(
+        language_model_name=language_model_name,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ upsert_llm_setting_with_http_info(language_model_name, body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upsert Llm Setting

+

Upsert the Large Language Model setting

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_model_name + StrictStr + +
+

(required)

+
+ 		+ required +
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/large_language_model_api.py + 
632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
@validate_call
+def upsert_llm_setting_with_http_info(
+    self,
+    language_model_name: StrictStr,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Upsert Llm Setting
+
+    Upsert the Large Language Model setting
+
+    :param language_model_name: (required)
+    :type language_model_name: str
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upsert_llm_setting_serialize(
+        language_model_name=language_model_name,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ upsert_llm_setting_without_preload_content(language_model_name, body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upsert Llm Setting

+

Upsert the Large Language Model setting

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
language_model_name + StrictStr + +
+

(required)

+
+ 		+ required +
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/large_language_model_api.py + 
705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
+769
+770
+771
@validate_call
+def upsert_llm_setting_without_preload_content(
+    self,
+    language_model_name: StrictStr,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Upsert Llm Setting
+
+    Upsert the Large Language Model setting
+
+    :param language_model_name: (required)
+    :type language_model_name: str
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upsert_llm_setting_serialize(
+        language_model_name=language_model_name,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/api/memory_api/index.html b/API_Documentation/api/memory_api/index.html new file mode 100644 index 0000000..a5cf073 --- /dev/null +++ b/API_Documentation/api/memory_api/index.html @@ -0,0 +1,12426 @@ + + + + + + + + + + + + + + + + + + + + + + + memory_api - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

memory_api

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ MemoryApi + + +

+ + +
+ + +

NOTE: This class is auto generated by OpenAPI Generator +Ref: https://openapi-generator.tech

+

Do not edit the class manually.

+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
  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
+ 445
+ 446
+ 447
+ 448
+ 449
+ 450
+ 451
+ 452
+ 453
+ 454
+ 455
+ 456
+ 457
+ 458
+ 459
+ 460
+ 461
+ 462
+ 463
+ 464
+ 465
+ 466
+ 467
+ 468
+ 469
+ 470
+ 471
+ 472
+ 473
+ 474
+ 475
+ 476
+ 477
+ 478
+ 479
+ 480
+ 481
+ 482
+ 483
+ 484
+ 485
+ 486
+ 487
+ 488
+ 489
+ 490
+ 491
+ 492
+ 493
+ 494
+ 495
+ 496
+ 497
+ 498
+ 499
+ 500
+ 501
+ 502
+ 503
+ 504
+ 505
+ 506
+ 507
+ 508
+ 509
+ 510
+ 511
+ 512
+ 513
+ 514
+ 515
+ 516
+ 517
+ 518
+ 519
+ 520
+ 521
+ 522
+ 523
+ 524
+ 525
+ 526
+ 527
+ 528
+ 529
+ 530
+ 531
+ 532
+ 533
+ 534
+ 535
+ 536
+ 537
+ 538
+ 539
+ 540
+ 541
+ 542
+ 543
+ 544
+ 545
+ 546
+ 547
+ 548
+ 549
+ 550
+ 551
+ 552
+ 553
+ 554
+ 555
+ 556
+ 557
+ 558
+ 559
+ 560
+ 561
+ 562
+ 563
+ 564
+ 565
+ 566
+ 567
+ 568
+ 569
+ 570
+ 571
+ 572
+ 573
+ 574
+ 575
+ 576
+ 577
+ 578
+ 579
+ 580
+ 581
+ 582
+ 583
+ 584
+ 585
+ 586
+ 587
+ 588
+ 589
+ 590
+ 591
+ 592
+ 593
+ 594
+ 595
+ 596
+ 597
+ 598
+ 599
+ 600
+ 601
+ 602
+ 603
+ 604
+ 605
+ 606
+ 607
+ 608
+ 609
+ 610
+ 611
+ 612
+ 613
+ 614
+ 615
+ 616
+ 617
+ 618
+ 619
+ 620
+ 621
+ 622
+ 623
+ 624
+ 625
+ 626
+ 627
+ 628
+ 629
+ 630
+ 631
+ 632
+ 633
+ 634
+ 635
+ 636
+ 637
+ 638
+ 639
+ 640
+ 641
+ 642
+ 643
+ 644
+ 645
+ 646
+ 647
+ 648
+ 649
+ 650
+ 651
+ 652
+ 653
+ 654
+ 655
+ 656
+ 657
+ 658
+ 659
+ 660
+ 661
+ 662
+ 663
+ 664
+ 665
+ 666
+ 667
+ 668
+ 669
+ 670
+ 671
+ 672
+ 673
+ 674
+ 675
+ 676
+ 677
+ 678
+ 679
+ 680
+ 681
+ 682
+ 683
+ 684
+ 685
+ 686
+ 687
+ 688
+ 689
+ 690
+ 691
+ 692
+ 693
+ 694
+ 695
+ 696
+ 697
+ 698
+ 699
+ 700
+ 701
+ 702
+ 703
+ 704
+ 705
+ 706
+ 707
+ 708
+ 709
+ 710
+ 711
+ 712
+ 713
+ 714
+ 715
+ 716
+ 717
+ 718
+ 719
+ 720
+ 721
+ 722
+ 723
+ 724
+ 725
+ 726
+ 727
+ 728
+ 729
+ 730
+ 731
+ 732
+ 733
+ 734
+ 735
+ 736
+ 737
+ 738
+ 739
+ 740
+ 741
+ 742
+ 743
+ 744
+ 745
+ 746
+ 747
+ 748
+ 749
+ 750
+ 751
+ 752
+ 753
+ 754
+ 755
+ 756
+ 757
+ 758
+ 759
+ 760
+ 761
+ 762
+ 763
+ 764
+ 765
+ 766
+ 767
+ 768
+ 769
+ 770
+ 771
+ 772
+ 773
+ 774
+ 775
+ 776
+ 777
+ 778
+ 779
+ 780
+ 781
+ 782
+ 783
+ 784
+ 785
+ 786
+ 787
+ 788
+ 789
+ 790
+ 791
+ 792
+ 793
+ 794
+ 795
+ 796
+ 797
+ 798
+ 799
+ 800
+ 801
+ 802
+ 803
+ 804
+ 805
+ 806
+ 807
+ 808
+ 809
+ 810
+ 811
+ 812
+ 813
+ 814
+ 815
+ 816
+ 817
+ 818
+ 819
+ 820
+ 821
+ 822
+ 823
+ 824
+ 825
+ 826
+ 827
+ 828
+ 829
+ 830
+ 831
+ 832
+ 833
+ 834
+ 835
+ 836
+ 837
+ 838
+ 839
+ 840
+ 841
+ 842
+ 843
+ 844
+ 845
+ 846
+ 847
+ 848
+ 849
+ 850
+ 851
+ 852
+ 853
+ 854
+ 855
+ 856
+ 857
+ 858
+ 859
+ 860
+ 861
+ 862
+ 863
+ 864
+ 865
+ 866
+ 867
+ 868
+ 869
+ 870
+ 871
+ 872
+ 873
+ 874
+ 875
+ 876
+ 877
+ 878
+ 879
+ 880
+ 881
+ 882
+ 883
+ 884
+ 885
+ 886
+ 887
+ 888
+ 889
+ 890
+ 891
+ 892
+ 893
+ 894
+ 895
+ 896
+ 897
+ 898
+ 899
+ 900
+ 901
+ 902
+ 903
+ 904
+ 905
+ 906
+ 907
+ 908
+ 909
+ 910
+ 911
+ 912
+ 913
+ 914
+ 915
+ 916
+ 917
+ 918
+ 919
+ 920
+ 921
+ 922
+ 923
+ 924
+ 925
+ 926
+ 927
+ 928
+ 929
+ 930
+ 931
+ 932
+ 933
+ 934
+ 935
+ 936
+ 937
+ 938
+ 939
+ 940
+ 941
+ 942
+ 943
+ 944
+ 945
+ 946
+ 947
+ 948
+ 949
+ 950
+ 951
+ 952
+ 953
+ 954
+ 955
+ 956
+ 957
+ 958
+ 959
+ 960
+ 961
+ 962
+ 963
+ 964
+ 965
+ 966
+ 967
+ 968
+ 969
+ 970
+ 971
+ 972
+ 973
+ 974
+ 975
+ 976
+ 977
+ 978
+ 979
+ 980
+ 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
+1061
+1062
+1063
+1064
+1065
+1066
+1067
+1068
+1069
+1070
+1071
+1072
+1073
+1074
+1075
+1076
+1077
+1078
+1079
+1080
+1081
+1082
+1083
+1084
+1085
+1086
+1087
+1088
+1089
+1090
+1091
+1092
+1093
+1094
+1095
+1096
+1097
+1098
+1099
+1100
+1101
+1102
+1103
+1104
+1105
+1106
+1107
+1108
+1109
+1110
+1111
+1112
+1113
+1114
+1115
+1116
+1117
+1118
+1119
+1120
+1121
+1122
+1123
+1124
+1125
+1126
+1127
+1128
+1129
+1130
+1131
+1132
+1133
+1134
+1135
+1136
+1137
+1138
+1139
+1140
+1141
+1142
+1143
+1144
+1145
+1146
+1147
+1148
+1149
+1150
+1151
+1152
+1153
+1154
+1155
+1156
+1157
+1158
+1159
+1160
+1161
+1162
+1163
+1164
+1165
+1166
+1167
+1168
+1169
+1170
+1171
+1172
+1173
+1174
+1175
+1176
+1177
+1178
+1179
+1180
+1181
+1182
+1183
+1184
+1185
+1186
+1187
+1188
+1189
+1190
+1191
+1192
+1193
+1194
+1195
+1196
+1197
+1198
+1199
+1200
+1201
+1202
+1203
+1204
+1205
+1206
+1207
+1208
+1209
+1210
+1211
+1212
+1213
+1214
+1215
+1216
+1217
+1218
+1219
+1220
+1221
+1222
+1223
+1224
+1225
+1226
+1227
+1228
+1229
+1230
+1231
+1232
+1233
+1234
+1235
+1236
+1237
+1238
+1239
+1240
+1241
+1242
+1243
+1244
+1245
+1246
+1247
+1248
+1249
+1250
+1251
+1252
+1253
+1254
+1255
+1256
+1257
+1258
+1259
+1260
+1261
+1262
+1263
+1264
+1265
+1266
+1267
+1268
+1269
+1270
+1271
+1272
+1273
+1274
+1275
+1276
+1277
+1278
+1279
+1280
+1281
+1282
+1283
+1284
+1285
+1286
+1287
+1288
+1289
+1290
+1291
+1292
+1293
+1294
+1295
+1296
+1297
+1298
+1299
+1300
+1301
+1302
+1303
+1304
+1305
+1306
+1307
+1308
+1309
+1310
+1311
+1312
+1313
+1314
+1315
+1316
+1317
+1318
+1319
+1320
+1321
+1322
+1323
+1324
+1325
+1326
+1327
+1328
+1329
+1330
+1331
+1332
+1333
+1334
+1335
+1336
+1337
+1338
+1339
+1340
+1341
+1342
+1343
+1344
+1345
+1346
+1347
+1348
+1349
+1350
+1351
+1352
+1353
+1354
+1355
+1356
+1357
+1358
+1359
+1360
+1361
+1362
+1363
+1364
+1365
+1366
+1367
+1368
+1369
+1370
+1371
+1372
+1373
+1374
+1375
+1376
+1377
+1378
+1379
+1380
+1381
+1382
+1383
+1384
+1385
+1386
+1387
+1388
+1389
+1390
+1391
+1392
+1393
+1394
+1395
+1396
+1397
+1398
+1399
+1400
+1401
+1402
+1403
+1404
+1405
+1406
+1407
+1408
+1409
+1410
+1411
+1412
+1413
+1414
+1415
+1416
+1417
+1418
+1419
+1420
+1421
+1422
+1423
+1424
+1425
+1426
+1427
+1428
+1429
+1430
+1431
+1432
+1433
+1434
+1435
+1436
+1437
+1438
+1439
+1440
+1441
+1442
+1443
+1444
+1445
+1446
+1447
+1448
+1449
+1450
+1451
+1452
+1453
+1454
+1455
+1456
+1457
+1458
+1459
+1460
+1461
+1462
+1463
+1464
+1465
+1466
+1467
+1468
+1469
+1470
+1471
+1472
+1473
+1474
+1475
+1476
+1477
+1478
+1479
+1480
+1481
+1482
+1483
+1484
+1485
+1486
+1487
+1488
+1489
+1490
+1491
+1492
+1493
+1494
+1495
+1496
+1497
+1498
+1499
+1500
+1501
+1502
+1503
+1504
+1505
+1506
+1507
+1508
+1509
+1510
+1511
+1512
+1513
+1514
+1515
+1516
+1517
+1518
+1519
+1520
+1521
+1522
+1523
+1524
+1525
+1526
+1527
+1528
+1529
+1530
+1531
+1532
+1533
+1534
+1535
+1536
+1537
+1538
+1539
+1540
+1541
+1542
+1543
+1544
+1545
+1546
+1547
+1548
+1549
+1550
+1551
+1552
+1553
+1554
+1555
+1556
+1557
+1558
+1559
+1560
+1561
+1562
+1563
+1564
+1565
+1566
+1567
+1568
+1569
+1570
+1571
+1572
+1573
+1574
+1575
+1576
+1577
+1578
+1579
+1580
+1581
+1582
+1583
+1584
+1585
+1586
+1587
+1588
+1589
+1590
+1591
+1592
+1593
+1594
+1595
+1596
+1597
+1598
+1599
+1600
+1601
+1602
+1603
+1604
+1605
+1606
+1607
+1608
+1609
+1610
+1611
+1612
+1613
+1614
+1615
+1616
+1617
+1618
+1619
+1620
+1621
+1622
+1623
+1624
+1625
+1626
+1627
+1628
+1629
+1630
+1631
+1632
+1633
+1634
+1635
+1636
+1637
+1638
+1639
+1640
+1641
+1642
+1643
+1644
+1645
+1646
+1647
+1648
+1649
+1650
+1651
+1652
+1653
+1654
+1655
+1656
+1657
+1658
+1659
+1660
+1661
+1662
+1663
+1664
+1665
+1666
+1667
+1668
+1669
+1670
+1671
+1672
+1673
+1674
+1675
+1676
+1677
+1678
+1679
+1680
+1681
+1682
+1683
+1684
+1685
+1686
+1687
+1688
+1689
+1690
+1691
+1692
+1693
+1694
+1695
+1696
+1697
+1698
+1699
+1700
+1701
+1702
+1703
+1704
+1705
+1706
+1707
+1708
+1709
+1710
+1711
+1712
+1713
+1714
+1715
+1716
+1717
+1718
+1719
+1720
+1721
+1722
+1723
+1724
+1725
+1726
+1727
+1728
+1729
+1730
+1731
+1732
+1733
+1734
+1735
+1736
+1737
+1738
+1739
+1740
+1741
+1742
+1743
+1744
+1745
+1746
+1747
+1748
+1749
+1750
+1751
+1752
+1753
+1754
+1755
+1756
+1757
+1758
+1759
+1760
+1761
+1762
+1763
+1764
+1765
+1766
+1767
+1768
+1769
+1770
+1771
+1772
+1773
+1774
+1775
+1776
+1777
+1778
+1779
+1780
+1781
+1782
+1783
+1784
+1785
+1786
+1787
+1788
+1789
+1790
+1791
+1792
+1793
+1794
+1795
+1796
+1797
+1798
+1799
+1800
+1801
+1802
+1803
+1804
+1805
+1806
+1807
+1808
+1809
+1810
+1811
+1812
+1813
+1814
+1815
+1816
+1817
+1818
+1819
+1820
+1821
+1822
+1823
+1824
+1825
+1826
+1827
+1828
+1829
+1830
+1831
+1832
+1833
+1834
+1835
+1836
+1837
+1838
+1839
+1840
+1841
+1842
+1843
+1844
+1845
+1846
+1847
+1848
+1849
+1850
+1851
+1852
+1853
+1854
+1855
+1856
+1857
+1858
+1859
+1860
+1861
+1862
+1863
+1864
+1865
+1866
+1867
+1868
+1869
+1870
+1871
+1872
+1873
+1874
+1875
+1876
+1877
+1878
+1879
+1880
+1881
+1882
+1883
+1884
+1885
+1886
+1887
+1888
+1889
+1890
+1891
+1892
+1893
+1894
+1895
+1896
+1897
+1898
+1899
+1900
+1901
+1902
+1903
+1904
+1905
+1906
+1907
+1908
+1909
+1910
+1911
+1912
+1913
+1914
+1915
+1916
+1917
+1918
+1919
+1920
+1921
+1922
+1923
+1924
+1925
+1926
+1927
+1928
+1929
+1930
+1931
+1932
+1933
+1934
+1935
+1936
+1937
+1938
+1939
+1940
+1941
+1942
+1943
+1944
+1945
+1946
+1947
+1948
+1949
+1950
+1951
+1952
+1953
+1954
+1955
+1956
+1957
+1958
+1959
+1960
+1961
+1962
+1963
+1964
+1965
+1966
+1967
+1968
+1969
+1970
+1971
+1972
+1973
+1974
+1975
+1976
+1977
+1978
+1979
+1980
+1981
+1982
+1983
+1984
+1985
+1986
+1987
+1988
+1989
+1990
+1991
+1992
+1993
+1994
+1995
+1996
+1997
+1998
+1999
+2000
+2001
+2002
+2003
+2004
+2005
+2006
+2007
+2008
+2009
+2010
+2011
+2012
+2013
+2014
+2015
+2016
+2017
+2018
+2019
+2020
+2021
+2022
+2023
+2024
+2025
+2026
+2027
+2028
+2029
+2030
+2031
+2032
+2033
+2034
+2035
+2036
+2037
+2038
+2039
+2040
+2041
+2042
+2043
+2044
+2045
+2046
+2047
+2048
+2049
+2050
+2051
+2052
+2053
+2054
+2055
+2056
+2057
+2058
+2059
+2060
+2061
+2062
+2063
+2064
+2065
+2066
+2067
+2068
+2069
+2070
+2071
+2072
+2073
+2074
+2075
+2076
+2077
+2078
+2079
+2080
+2081
+2082
+2083
+2084
+2085
+2086
+2087
+2088
+2089
+2090
+2091
+2092
+2093
+2094
+2095
+2096
+2097
+2098
+2099
+2100
+2101
+2102
+2103
+2104
+2105
+2106
+2107
+2108
+2109
+2110
+2111
+2112
+2113
+2114
+2115
+2116
+2117
+2118
+2119
+2120
+2121
+2122
+2123
+2124
+2125
+2126
+2127
+2128
+2129
+2130
+2131
+2132
+2133
+2134
+2135
+2136
+2137
+2138
+2139
+2140
+2141
+2142
+2143
+2144
+2145
+2146
+2147
+2148
class MemoryApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_collections(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Collections
+
+        Get list of available collections
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_collections_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_collections_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Collections
+
+        Get list of available collections
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_collections_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_collections_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Collections
+
+        Get list of available collections
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_collections_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_collections_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/memory/collections/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_conversation_history(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Conversation History
+
+        Get the specified user's conversation history from working memory
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_conversation_history_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_conversation_history_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Conversation History
+
+        Get the specified user's conversation history from working memory
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_conversation_history_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_conversation_history_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Conversation History
+
+        Get the specified user's conversation history from working memory
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_conversation_history_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_conversation_history_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/memory/conversation_history/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def recall_memories_from_text(
+        self,
+        text: Annotated[StrictStr, Field(description="Find memories similar to this text.")],
+        k: Annotated[Optional[StrictInt], Field(description="How many memories to return.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Recall Memories From Text
+
+        Search k memories similar to given text.
+
+        :param text: Find memories similar to this text. (required)
+        :type text: str
+        :param k: How many memories to return.
+        :type k: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._recall_memories_from_text_serialize(
+            text=text,
+            k=k,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def recall_memories_from_text_with_http_info(
+        self,
+        text: Annotated[StrictStr, Field(description="Find memories similar to this text.")],
+        k: Annotated[Optional[StrictInt], Field(description="How many memories to return.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Recall Memories From Text
+
+        Search k memories similar to given text.
+
+        :param text: Find memories similar to this text. (required)
+        :type text: str
+        :param k: How many memories to return.
+        :type k: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._recall_memories_from_text_serialize(
+            text=text,
+            k=k,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def recall_memories_from_text_without_preload_content(
+        self,
+        text: Annotated[StrictStr, Field(description="Find memories similar to this text.")],
+        k: Annotated[Optional[StrictInt], Field(description="How many memories to return.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Recall Memories From Text
+
+        Search k memories similar to given text.
+
+        :param text: Find memories similar to this text. (required)
+        :type text: str
+        :param k: How many memories to return.
+        :type k: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._recall_memories_from_text_serialize(
+            text=text,
+            k=k,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _recall_memories_from_text_serialize(
+        self,
+        text,
+        k,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if text is not None:
+
+            _query_params.append(('text', text))
+
+        if k is not None:
+
+            _query_params.append(('k', k))
+
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/memory/recall/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def wipe_collections(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Wipe Collections
+
+        Delete and create all collections
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_collections_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def wipe_collections_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Wipe Collections
+
+        Delete and create all collections
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_collections_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def wipe_collections_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Wipe Collections
+
+        Delete and create all collections
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_collections_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _wipe_collections_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='DELETE',
+            resource_path='/memory/collections/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def wipe_conversation_history(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Wipe Conversation History
+
+        Delete the specified user's conversation history from working memory
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_conversation_history_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def wipe_conversation_history_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Wipe Conversation History
+
+        Delete the specified user's conversation history from working memory
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_conversation_history_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def wipe_conversation_history_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Wipe Conversation History
+
+        Delete the specified user's conversation history from working memory
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_conversation_history_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _wipe_conversation_history_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='DELETE',
+            resource_path='/memory/conversation_history/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def wipe_memory_point(
+        self,
+        collection_id: StrictStr,
+        memory_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Wipe Memory Point
+
+        Delete a specific point in memory
+
+        :param collection_id: (required)
+        :type collection_id: str
+        :param memory_id: (required)
+        :type memory_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_memory_point_serialize(
+            collection_id=collection_id,
+            memory_id=memory_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def wipe_memory_point_with_http_info(
+        self,
+        collection_id: StrictStr,
+        memory_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Wipe Memory Point
+
+        Delete a specific point in memory
+
+        :param collection_id: (required)
+        :type collection_id: str
+        :param memory_id: (required)
+        :type memory_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_memory_point_serialize(
+            collection_id=collection_id,
+            memory_id=memory_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def wipe_memory_point_without_preload_content(
+        self,
+        collection_id: StrictStr,
+        memory_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Wipe Memory Point
+
+        Delete a specific point in memory
+
+        :param collection_id: (required)
+        :type collection_id: str
+        :param memory_id: (required)
+        :type memory_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_memory_point_serialize(
+            collection_id=collection_id,
+            memory_id=memory_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _wipe_memory_point_serialize(
+        self,
+        collection_id,
+        memory_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if collection_id is not None:
+            _path_params['collection_id'] = collection_id
+        if memory_id is not None:
+            _path_params['memory_id'] = memory_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='DELETE',
+            resource_path='/memory/collections/{collection_id}/points/{memory_id}/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def wipe_memory_points_by_metadata(
+        self,
+        collection_id: StrictStr,
+        body: Optional[Dict[str, Any]] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Wipe Memory Points By Metadata
+
+        Delete points in memory by filter
+
+        :param collection_id: (required)
+        :type collection_id: str
+        :param body:
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_memory_points_by_metadata_serialize(
+            collection_id=collection_id,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def wipe_memory_points_by_metadata_with_http_info(
+        self,
+        collection_id: StrictStr,
+        body: Optional[Dict[str, Any]] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Wipe Memory Points By Metadata
+
+        Delete points in memory by filter
+
+        :param collection_id: (required)
+        :type collection_id: str
+        :param body:
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_memory_points_by_metadata_serialize(
+            collection_id=collection_id,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def wipe_memory_points_by_metadata_without_preload_content(
+        self,
+        collection_id: StrictStr,
+        body: Optional[Dict[str, Any]] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Wipe Memory Points By Metadata
+
+        Delete points in memory by filter
+
+        :param collection_id: (required)
+        :type collection_id: str
+        :param body:
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_memory_points_by_metadata_serialize(
+            collection_id=collection_id,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _wipe_memory_points_by_metadata_serialize(
+        self,
+        collection_id,
+        body,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if collection_id is not None:
+            _path_params['collection_id'] = collection_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if body is not None:
+            _body_params = body
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='DELETE',
+            resource_path='/memory/collections/{collection_id}/points',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def wipe_single_collection(
+        self,
+        collection_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Wipe Single Collection
+
+        Delete and recreate a collection
+
+        :param collection_id: (required)
+        :type collection_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_single_collection_serialize(
+            collection_id=collection_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def wipe_single_collection_with_http_info(
+        self,
+        collection_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Wipe Single Collection
+
+        Delete and recreate a collection
+
+        :param collection_id: (required)
+        :type collection_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_single_collection_serialize(
+            collection_id=collection_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def wipe_single_collection_without_preload_content(
+        self,
+        collection_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Wipe Single Collection
+
+        Delete and recreate a collection
+
+        :param collection_id: (required)
+        :type collection_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._wipe_single_collection_serialize(
+            collection_id=collection_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _wipe_single_collection_serialize(
+        self,
+        collection_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if collection_id is not None:
+            _path_params['collection_id'] = collection_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='DELETE',
+            resource_path='/memory/collections/{collection_id}/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ get_collections(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Collections

+

Get list of available collections

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
 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
@validate_call
+def get_collections(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Collections
+
+    Get list of available collections
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_collections_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_collections_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Collections

+

Get list of available collections

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
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
@validate_call
+def get_collections_with_http_info(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Collections
+
+    Get list of available collections
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_collections_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_collections_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Collections

+

Get list of available collections

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
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
@validate_call
+def get_collections_without_preload_content(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Collections
+
+    Get list of available collections
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_collections_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ get_conversation_history(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Conversation History

+

Get the specified user's conversation history from working memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
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
@validate_call
+def get_conversation_history(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Conversation History
+
+    Get the specified user's conversation history from working memory
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_conversation_history_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_conversation_history_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Conversation History

+

Get the specified user's conversation history from working memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
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
@validate_call
+def get_conversation_history_with_http_info(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Conversation History
+
+    Get the specified user's conversation history from working memory
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_conversation_history_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_conversation_history_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Conversation History

+

Get the specified user's conversation history from working memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
425
+426
+427
+428
+429
+430
+431
+432
+433
+434
+435
+436
+437
+438
+439
+440
+441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
@validate_call
+def get_conversation_history_without_preload_content(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Conversation History
+
+    Get the specified user's conversation history from working memory
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_conversation_history_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ recall_memories_from_text(text, k=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Recall Memories From Text

+

Search k memories similar to given text.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
text + Annotated[StrictStr, Field(description='Find memories similar to this text.')] + +
+

Find memories similar to this text. (required)

+
+ 		+ required +
k + Annotated[Optional[StrictInt], Field(description='How many memories to return.')] + +
+

How many memories to return.

+
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
543
+544
+545
+546
+547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
@validate_call
+def recall_memories_from_text(
+    self,
+    text: Annotated[StrictStr, Field(description="Find memories similar to this text.")],
+    k: Annotated[Optional[StrictInt], Field(description="How many memories to return.")] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Recall Memories From Text
+
+    Search k memories similar to given text.
+
+    :param text: Find memories similar to this text. (required)
+    :type text: str
+    :param k: How many memories to return.
+    :type k: int
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._recall_memories_from_text_serialize(
+        text=text,
+        k=k,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ recall_memories_from_text_with_http_info(text, k=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Recall Memories From Text

+

Search k memories similar to given text.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
text + Annotated[StrictStr, Field(description='Find memories similar to this text.')] + +
+

Find memories similar to this text. (required)

+
+ 		+ required +
k + Annotated[Optional[StrictInt], Field(description='How many memories to return.')] + +
+

How many memories to return.

+
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
@validate_call
+def recall_memories_from_text_with_http_info(
+    self,
+    text: Annotated[StrictStr, Field(description="Find memories similar to this text.")],
+    k: Annotated[Optional[StrictInt], Field(description="How many memories to return.")] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Recall Memories From Text
+
+    Search k memories similar to given text.
+
+    :param text: Find memories similar to this text. (required)
+    :type text: str
+    :param k: How many memories to return.
+    :type k: int
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._recall_memories_from_text_serialize(
+        text=text,
+        k=k,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ recall_memories_from_text_without_preload_content(text, k=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Recall Memories From Text

+

Search k memories similar to given text.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
text + Annotated[StrictStr, Field(description='Find memories similar to this text.')] + +
+

Find memories similar to this text. (required)

+
+ 		+ required +
k + Annotated[Optional[StrictInt], Field(description='How many memories to return.')] + +
+

How many memories to return.

+
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
@validate_call
+def recall_memories_from_text_without_preload_content(
+    self,
+    text: Annotated[StrictStr, Field(description="Find memories similar to this text.")],
+    k: Annotated[Optional[StrictInt], Field(description="How many memories to return.")] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Recall Memories From Text
+
+    Search k memories similar to given text.
+
+    :param text: Find memories similar to this text. (required)
+    :type text: str
+    :param k: How many memories to return.
+    :type k: int
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._recall_memories_from_text_serialize(
+        text=text,
+        k=k,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ wipe_collections(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Collections

+

Delete and create all collections

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
826
+827
+828
+829
+830
+831
+832
+833
+834
+835
+836
+837
+838
+839
+840
+841
+842
+843
+844
+845
+846
+847
+848
+849
+850
+851
+852
+853
+854
+855
+856
+857
+858
+859
+860
+861
+862
+863
+864
+865
+866
+867
+868
+869
+870
+871
+872
+873
+874
+875
+876
+877
+878
+879
+880
+881
+882
+883
+884
+885
+886
+887
@validate_call
+def wipe_collections(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Wipe Collections
+
+    Delete and create all collections
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_collections_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ wipe_collections_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Collections

+

Delete and create all collections

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
890
+891
+892
+893
+894
+895
+896
+897
+898
+899
+900
+901
+902
+903
+904
+905
+906
+907
+908
+909
+910
+911
+912
+913
+914
+915
+916
+917
+918
+919
+920
+921
+922
+923
+924
+925
+926
+927
+928
+929
+930
+931
+932
+933
+934
+935
+936
+937
+938
+939
+940
+941
+942
+943
+944
+945
+946
+947
+948
+949
+950
+951
@validate_call
+def wipe_collections_with_http_info(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Wipe Collections
+
+    Delete and create all collections
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_collections_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ wipe_collections_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Collections

+

Delete and create all collections

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
 954
+ 955
+ 956
+ 957
+ 958
+ 959
+ 960
+ 961
+ 962
+ 963
+ 964
+ 965
+ 966
+ 967
+ 968
+ 969
+ 970
+ 971
+ 972
+ 973
+ 974
+ 975
+ 976
+ 977
+ 978
+ 979
+ 980
+ 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
@validate_call
+def wipe_collections_without_preload_content(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Wipe Collections
+
+    Delete and create all collections
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_collections_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ wipe_conversation_history(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Conversation History

+

Delete the specified user's conversation history from working memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1072
+1073
+1074
+1075
+1076
+1077
+1078
+1079
+1080
+1081
+1082
+1083
+1084
+1085
+1086
+1087
+1088
+1089
+1090
+1091
+1092
+1093
+1094
+1095
+1096
+1097
+1098
+1099
+1100
+1101
+1102
+1103
+1104
+1105
+1106
+1107
+1108
+1109
+1110
+1111
+1112
+1113
+1114
+1115
+1116
+1117
+1118
+1119
+1120
+1121
+1122
+1123
+1124
+1125
+1126
+1127
+1128
+1129
+1130
+1131
+1132
+1133
@validate_call
+def wipe_conversation_history(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Wipe Conversation History
+
+    Delete the specified user's conversation history from working memory
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_conversation_history_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ wipe_conversation_history_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Conversation History

+

Delete the specified user's conversation history from working memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1136
+1137
+1138
+1139
+1140
+1141
+1142
+1143
+1144
+1145
+1146
+1147
+1148
+1149
+1150
+1151
+1152
+1153
+1154
+1155
+1156
+1157
+1158
+1159
+1160
+1161
+1162
+1163
+1164
+1165
+1166
+1167
+1168
+1169
+1170
+1171
+1172
+1173
+1174
+1175
+1176
+1177
+1178
+1179
+1180
+1181
+1182
+1183
+1184
+1185
+1186
+1187
+1188
+1189
+1190
+1191
+1192
+1193
+1194
+1195
+1196
+1197
@validate_call
+def wipe_conversation_history_with_http_info(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Wipe Conversation History
+
+    Delete the specified user's conversation history from working memory
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_conversation_history_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ wipe_conversation_history_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Conversation History

+

Delete the specified user's conversation history from working memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1200
+1201
+1202
+1203
+1204
+1205
+1206
+1207
+1208
+1209
+1210
+1211
+1212
+1213
+1214
+1215
+1216
+1217
+1218
+1219
+1220
+1221
+1222
+1223
+1224
+1225
+1226
+1227
+1228
+1229
+1230
+1231
+1232
+1233
+1234
+1235
+1236
+1237
+1238
+1239
+1240
+1241
+1242
+1243
+1244
+1245
+1246
+1247
+1248
+1249
+1250
+1251
+1252
+1253
+1254
+1255
+1256
+1257
@validate_call
+def wipe_conversation_history_without_preload_content(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Wipe Conversation History
+
+    Delete the specified user's conversation history from working memory
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_conversation_history_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ wipe_memory_point(collection_id, memory_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Memory Point

+

Delete a specific point in memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_id + StrictStr + +
+

(required)

+
+ 		+ required +
memory_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1318
+1319
+1320
+1321
+1322
+1323
+1324
+1325
+1326
+1327
+1328
+1329
+1330
+1331
+1332
+1333
+1334
+1335
+1336
+1337
+1338
+1339
+1340
+1341
+1342
+1343
+1344
+1345
+1346
+1347
+1348
+1349
+1350
+1351
+1352
+1353
+1354
+1355
+1356
+1357
+1358
+1359
+1360
+1361
+1362
+1363
+1364
+1365
+1366
+1367
+1368
+1369
+1370
+1371
+1372
+1373
+1374
+1375
+1376
+1377
+1378
+1379
+1380
+1381
+1382
+1383
+1384
+1385
+1386
+1387
+1388
@validate_call
+def wipe_memory_point(
+    self,
+    collection_id: StrictStr,
+    memory_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Wipe Memory Point
+
+    Delete a specific point in memory
+
+    :param collection_id: (required)
+    :type collection_id: str
+    :param memory_id: (required)
+    :type memory_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_memory_point_serialize(
+        collection_id=collection_id,
+        memory_id=memory_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ wipe_memory_point_with_http_info(collection_id, memory_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Memory Point

+

Delete a specific point in memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_id + StrictStr + +
+

(required)

+
+ 		+ required +
memory_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1391
+1392
+1393
+1394
+1395
+1396
+1397
+1398
+1399
+1400
+1401
+1402
+1403
+1404
+1405
+1406
+1407
+1408
+1409
+1410
+1411
+1412
+1413
+1414
+1415
+1416
+1417
+1418
+1419
+1420
+1421
+1422
+1423
+1424
+1425
+1426
+1427
+1428
+1429
+1430
+1431
+1432
+1433
+1434
+1435
+1436
+1437
+1438
+1439
+1440
+1441
+1442
+1443
+1444
+1445
+1446
+1447
+1448
+1449
+1450
+1451
+1452
+1453
+1454
+1455
+1456
+1457
+1458
+1459
+1460
+1461
@validate_call
+def wipe_memory_point_with_http_info(
+    self,
+    collection_id: StrictStr,
+    memory_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Wipe Memory Point
+
+    Delete a specific point in memory
+
+    :param collection_id: (required)
+    :type collection_id: str
+    :param memory_id: (required)
+    :type memory_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_memory_point_serialize(
+        collection_id=collection_id,
+        memory_id=memory_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ wipe_memory_point_without_preload_content(collection_id, memory_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Memory Point

+

Delete a specific point in memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_id + StrictStr + +
+

(required)

+
+ 		+ required +
memory_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1464
+1465
+1466
+1467
+1468
+1469
+1470
+1471
+1472
+1473
+1474
+1475
+1476
+1477
+1478
+1479
+1480
+1481
+1482
+1483
+1484
+1485
+1486
+1487
+1488
+1489
+1490
+1491
+1492
+1493
+1494
+1495
+1496
+1497
+1498
+1499
+1500
+1501
+1502
+1503
+1504
+1505
+1506
+1507
+1508
+1509
+1510
+1511
+1512
+1513
+1514
+1515
+1516
+1517
+1518
+1519
+1520
+1521
+1522
+1523
+1524
+1525
+1526
+1527
+1528
+1529
+1530
@validate_call
+def wipe_memory_point_without_preload_content(
+    self,
+    collection_id: StrictStr,
+    memory_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Wipe Memory Point
+
+    Delete a specific point in memory
+
+    :param collection_id: (required)
+    :type collection_id: str
+    :param memory_id: (required)
+    :type memory_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_memory_point_serialize(
+        collection_id=collection_id,
+        memory_id=memory_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ wipe_memory_points_by_metadata(collection_id, body=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Memory Points By Metadata

+

Delete points in memory by filter

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_id + StrictStr + +
+

(required)

+
+ 		+ required +
body + Optional[Dict[str, Any]] + +
+ +
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1597
+1598
+1599
+1600
+1601
+1602
+1603
+1604
+1605
+1606
+1607
+1608
+1609
+1610
+1611
+1612
+1613
+1614
+1615
+1616
+1617
+1618
+1619
+1620
+1621
+1622
+1623
+1624
+1625
+1626
+1627
+1628
+1629
+1630
+1631
+1632
+1633
+1634
+1635
+1636
+1637
+1638
+1639
+1640
+1641
+1642
+1643
+1644
+1645
+1646
+1647
+1648
+1649
+1650
+1651
+1652
+1653
+1654
+1655
+1656
+1657
+1658
+1659
+1660
+1661
+1662
+1663
+1664
+1665
+1666
+1667
@validate_call
+def wipe_memory_points_by_metadata(
+    self,
+    collection_id: StrictStr,
+    body: Optional[Dict[str, Any]] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Wipe Memory Points By Metadata
+
+    Delete points in memory by filter
+
+    :param collection_id: (required)
+    :type collection_id: str
+    :param body:
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_memory_points_by_metadata_serialize(
+        collection_id=collection_id,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ wipe_memory_points_by_metadata_with_http_info(collection_id, body=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Memory Points By Metadata

+

Delete points in memory by filter

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_id + StrictStr + +
+

(required)

+
+ 		+ required +
body + Optional[Dict[str, Any]] + +
+ +
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1670
+1671
+1672
+1673
+1674
+1675
+1676
+1677
+1678
+1679
+1680
+1681
+1682
+1683
+1684
+1685
+1686
+1687
+1688
+1689
+1690
+1691
+1692
+1693
+1694
+1695
+1696
+1697
+1698
+1699
+1700
+1701
+1702
+1703
+1704
+1705
+1706
+1707
+1708
+1709
+1710
+1711
+1712
+1713
+1714
+1715
+1716
+1717
+1718
+1719
+1720
+1721
+1722
+1723
+1724
+1725
+1726
+1727
+1728
+1729
+1730
+1731
+1732
+1733
+1734
+1735
+1736
+1737
+1738
+1739
+1740
@validate_call
+def wipe_memory_points_by_metadata_with_http_info(
+    self,
+    collection_id: StrictStr,
+    body: Optional[Dict[str, Any]] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Wipe Memory Points By Metadata
+
+    Delete points in memory by filter
+
+    :param collection_id: (required)
+    :type collection_id: str
+    :param body:
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_memory_points_by_metadata_serialize(
+        collection_id=collection_id,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ wipe_memory_points_by_metadata_without_preload_content(collection_id, body=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Memory Points By Metadata

+

Delete points in memory by filter

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_id + StrictStr + +
+

(required)

+
+ 		+ required +
body + Optional[Dict[str, Any]] + +
+ +
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1743
+1744
+1745
+1746
+1747
+1748
+1749
+1750
+1751
+1752
+1753
+1754
+1755
+1756
+1757
+1758
+1759
+1760
+1761
+1762
+1763
+1764
+1765
+1766
+1767
+1768
+1769
+1770
+1771
+1772
+1773
+1774
+1775
+1776
+1777
+1778
+1779
+1780
+1781
+1782
+1783
+1784
+1785
+1786
+1787
+1788
+1789
+1790
+1791
+1792
+1793
+1794
+1795
+1796
+1797
+1798
+1799
+1800
+1801
+1802
+1803
+1804
+1805
+1806
+1807
+1808
+1809
@validate_call
+def wipe_memory_points_by_metadata_without_preload_content(
+    self,
+    collection_id: StrictStr,
+    body: Optional[Dict[str, Any]] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Wipe Memory Points By Metadata
+
+    Delete points in memory by filter
+
+    :param collection_id: (required)
+    :type collection_id: str
+    :param body:
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_memory_points_by_metadata_serialize(
+        collection_id=collection_id,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ wipe_single_collection(collection_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Single Collection

+

Delete and recreate a collection

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1889
+1890
+1891
+1892
+1893
+1894
+1895
+1896
+1897
+1898
+1899
+1900
+1901
+1902
+1903
+1904
+1905
+1906
+1907
+1908
+1909
+1910
+1911
+1912
+1913
+1914
+1915
+1916
+1917
+1918
+1919
+1920
+1921
+1922
+1923
+1924
+1925
+1926
+1927
+1928
+1929
+1930
+1931
+1932
+1933
+1934
+1935
+1936
+1937
+1938
+1939
+1940
+1941
+1942
+1943
+1944
+1945
+1946
+1947
+1948
+1949
+1950
+1951
+1952
+1953
+1954
+1955
@validate_call
+def wipe_single_collection(
+    self,
+    collection_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Wipe Single Collection
+
+    Delete and recreate a collection
+
+    :param collection_id: (required)
+    :type collection_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_single_collection_serialize(
+        collection_id=collection_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ wipe_single_collection_with_http_info(collection_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Single Collection

+

Delete and recreate a collection

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
1958
+1959
+1960
+1961
+1962
+1963
+1964
+1965
+1966
+1967
+1968
+1969
+1970
+1971
+1972
+1973
+1974
+1975
+1976
+1977
+1978
+1979
+1980
+1981
+1982
+1983
+1984
+1985
+1986
+1987
+1988
+1989
+1990
+1991
+1992
+1993
+1994
+1995
+1996
+1997
+1998
+1999
+2000
+2001
+2002
+2003
+2004
+2005
+2006
+2007
+2008
+2009
+2010
+2011
+2012
+2013
+2014
+2015
+2016
+2017
+2018
+2019
+2020
+2021
+2022
+2023
+2024
@validate_call
+def wipe_single_collection_with_http_info(
+    self,
+    collection_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Wipe Single Collection
+
+    Delete and recreate a collection
+
+    :param collection_id: (required)
+    :type collection_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_single_collection_serialize(
+        collection_id=collection_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ wipe_single_collection_without_preload_content(collection_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Wipe Single Collection

+

Delete and recreate a collection

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/memory_api.py + 
2027
+2028
+2029
+2030
+2031
+2032
+2033
+2034
+2035
+2036
+2037
+2038
+2039
+2040
+2041
+2042
+2043
+2044
+2045
+2046
+2047
+2048
+2049
+2050
+2051
+2052
+2053
+2054
+2055
+2056
+2057
+2058
+2059
+2060
+2061
+2062
+2063
+2064
+2065
+2066
+2067
+2068
+2069
+2070
+2071
+2072
+2073
+2074
+2075
+2076
+2077
+2078
+2079
+2080
+2081
+2082
+2083
+2084
+2085
+2086
+2087
+2088
+2089
@validate_call
+def wipe_single_collection_without_preload_content(
+    self,
+    collection_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Wipe Single Collection
+
+    Delete and recreate a collection
+
+    :param collection_id: (required)
+    :type collection_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._wipe_single_collection_serialize(
+        collection_id=collection_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/api/plugins_api/index.html b/API_Documentation/api/plugins_api/index.html new file mode 100644 index 0000000..8f3df87 --- /dev/null +++ b/API_Documentation/api/plugins_api/index.html @@ -0,0 +1,14011 @@ + + + + + + + + + + + + + + + + + + + + + + + plugins_api - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

plugins_api

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ PluginsApi + + +

+ + +
+ + +

NOTE: This class is auto generated by OpenAPI Generator +Ref: https://openapi-generator.tech

+

Do not edit the class manually.

+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
  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
+ 445
+ 446
+ 447
+ 448
+ 449
+ 450
+ 451
+ 452
+ 453
+ 454
+ 455
+ 456
+ 457
+ 458
+ 459
+ 460
+ 461
+ 462
+ 463
+ 464
+ 465
+ 466
+ 467
+ 468
+ 469
+ 470
+ 471
+ 472
+ 473
+ 474
+ 475
+ 476
+ 477
+ 478
+ 479
+ 480
+ 481
+ 482
+ 483
+ 484
+ 485
+ 486
+ 487
+ 488
+ 489
+ 490
+ 491
+ 492
+ 493
+ 494
+ 495
+ 496
+ 497
+ 498
+ 499
+ 500
+ 501
+ 502
+ 503
+ 504
+ 505
+ 506
+ 507
+ 508
+ 509
+ 510
+ 511
+ 512
+ 513
+ 514
+ 515
+ 516
+ 517
+ 518
+ 519
+ 520
+ 521
+ 522
+ 523
+ 524
+ 525
+ 526
+ 527
+ 528
+ 529
+ 530
+ 531
+ 532
+ 533
+ 534
+ 535
+ 536
+ 537
+ 538
+ 539
+ 540
+ 541
+ 542
+ 543
+ 544
+ 545
+ 546
+ 547
+ 548
+ 549
+ 550
+ 551
+ 552
+ 553
+ 554
+ 555
+ 556
+ 557
+ 558
+ 559
+ 560
+ 561
+ 562
+ 563
+ 564
+ 565
+ 566
+ 567
+ 568
+ 569
+ 570
+ 571
+ 572
+ 573
+ 574
+ 575
+ 576
+ 577
+ 578
+ 579
+ 580
+ 581
+ 582
+ 583
+ 584
+ 585
+ 586
+ 587
+ 588
+ 589
+ 590
+ 591
+ 592
+ 593
+ 594
+ 595
+ 596
+ 597
+ 598
+ 599
+ 600
+ 601
+ 602
+ 603
+ 604
+ 605
+ 606
+ 607
+ 608
+ 609
+ 610
+ 611
+ 612
+ 613
+ 614
+ 615
+ 616
+ 617
+ 618
+ 619
+ 620
+ 621
+ 622
+ 623
+ 624
+ 625
+ 626
+ 627
+ 628
+ 629
+ 630
+ 631
+ 632
+ 633
+ 634
+ 635
+ 636
+ 637
+ 638
+ 639
+ 640
+ 641
+ 642
+ 643
+ 644
+ 645
+ 646
+ 647
+ 648
+ 649
+ 650
+ 651
+ 652
+ 653
+ 654
+ 655
+ 656
+ 657
+ 658
+ 659
+ 660
+ 661
+ 662
+ 663
+ 664
+ 665
+ 666
+ 667
+ 668
+ 669
+ 670
+ 671
+ 672
+ 673
+ 674
+ 675
+ 676
+ 677
+ 678
+ 679
+ 680
+ 681
+ 682
+ 683
+ 684
+ 685
+ 686
+ 687
+ 688
+ 689
+ 690
+ 691
+ 692
+ 693
+ 694
+ 695
+ 696
+ 697
+ 698
+ 699
+ 700
+ 701
+ 702
+ 703
+ 704
+ 705
+ 706
+ 707
+ 708
+ 709
+ 710
+ 711
+ 712
+ 713
+ 714
+ 715
+ 716
+ 717
+ 718
+ 719
+ 720
+ 721
+ 722
+ 723
+ 724
+ 725
+ 726
+ 727
+ 728
+ 729
+ 730
+ 731
+ 732
+ 733
+ 734
+ 735
+ 736
+ 737
+ 738
+ 739
+ 740
+ 741
+ 742
+ 743
+ 744
+ 745
+ 746
+ 747
+ 748
+ 749
+ 750
+ 751
+ 752
+ 753
+ 754
+ 755
+ 756
+ 757
+ 758
+ 759
+ 760
+ 761
+ 762
+ 763
+ 764
+ 765
+ 766
+ 767
+ 768
+ 769
+ 770
+ 771
+ 772
+ 773
+ 774
+ 775
+ 776
+ 777
+ 778
+ 779
+ 780
+ 781
+ 782
+ 783
+ 784
+ 785
+ 786
+ 787
+ 788
+ 789
+ 790
+ 791
+ 792
+ 793
+ 794
+ 795
+ 796
+ 797
+ 798
+ 799
+ 800
+ 801
+ 802
+ 803
+ 804
+ 805
+ 806
+ 807
+ 808
+ 809
+ 810
+ 811
+ 812
+ 813
+ 814
+ 815
+ 816
+ 817
+ 818
+ 819
+ 820
+ 821
+ 822
+ 823
+ 824
+ 825
+ 826
+ 827
+ 828
+ 829
+ 830
+ 831
+ 832
+ 833
+ 834
+ 835
+ 836
+ 837
+ 838
+ 839
+ 840
+ 841
+ 842
+ 843
+ 844
+ 845
+ 846
+ 847
+ 848
+ 849
+ 850
+ 851
+ 852
+ 853
+ 854
+ 855
+ 856
+ 857
+ 858
+ 859
+ 860
+ 861
+ 862
+ 863
+ 864
+ 865
+ 866
+ 867
+ 868
+ 869
+ 870
+ 871
+ 872
+ 873
+ 874
+ 875
+ 876
+ 877
+ 878
+ 879
+ 880
+ 881
+ 882
+ 883
+ 884
+ 885
+ 886
+ 887
+ 888
+ 889
+ 890
+ 891
+ 892
+ 893
+ 894
+ 895
+ 896
+ 897
+ 898
+ 899
+ 900
+ 901
+ 902
+ 903
+ 904
+ 905
+ 906
+ 907
+ 908
+ 909
+ 910
+ 911
+ 912
+ 913
+ 914
+ 915
+ 916
+ 917
+ 918
+ 919
+ 920
+ 921
+ 922
+ 923
+ 924
+ 925
+ 926
+ 927
+ 928
+ 929
+ 930
+ 931
+ 932
+ 933
+ 934
+ 935
+ 936
+ 937
+ 938
+ 939
+ 940
+ 941
+ 942
+ 943
+ 944
+ 945
+ 946
+ 947
+ 948
+ 949
+ 950
+ 951
+ 952
+ 953
+ 954
+ 955
+ 956
+ 957
+ 958
+ 959
+ 960
+ 961
+ 962
+ 963
+ 964
+ 965
+ 966
+ 967
+ 968
+ 969
+ 970
+ 971
+ 972
+ 973
+ 974
+ 975
+ 976
+ 977
+ 978
+ 979
+ 980
+ 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
+1061
+1062
+1063
+1064
+1065
+1066
+1067
+1068
+1069
+1070
+1071
+1072
+1073
+1074
+1075
+1076
+1077
+1078
+1079
+1080
+1081
+1082
+1083
+1084
+1085
+1086
+1087
+1088
+1089
+1090
+1091
+1092
+1093
+1094
+1095
+1096
+1097
+1098
+1099
+1100
+1101
+1102
+1103
+1104
+1105
+1106
+1107
+1108
+1109
+1110
+1111
+1112
+1113
+1114
+1115
+1116
+1117
+1118
+1119
+1120
+1121
+1122
+1123
+1124
+1125
+1126
+1127
+1128
+1129
+1130
+1131
+1132
+1133
+1134
+1135
+1136
+1137
+1138
+1139
+1140
+1141
+1142
+1143
+1144
+1145
+1146
+1147
+1148
+1149
+1150
+1151
+1152
+1153
+1154
+1155
+1156
+1157
+1158
+1159
+1160
+1161
+1162
+1163
+1164
+1165
+1166
+1167
+1168
+1169
+1170
+1171
+1172
+1173
+1174
+1175
+1176
+1177
+1178
+1179
+1180
+1181
+1182
+1183
+1184
+1185
+1186
+1187
+1188
+1189
+1190
+1191
+1192
+1193
+1194
+1195
+1196
+1197
+1198
+1199
+1200
+1201
+1202
+1203
+1204
+1205
+1206
+1207
+1208
+1209
+1210
+1211
+1212
+1213
+1214
+1215
+1216
+1217
+1218
+1219
+1220
+1221
+1222
+1223
+1224
+1225
+1226
+1227
+1228
+1229
+1230
+1231
+1232
+1233
+1234
+1235
+1236
+1237
+1238
+1239
+1240
+1241
+1242
+1243
+1244
+1245
+1246
+1247
+1248
+1249
+1250
+1251
+1252
+1253
+1254
+1255
+1256
+1257
+1258
+1259
+1260
+1261
+1262
+1263
+1264
+1265
+1266
+1267
+1268
+1269
+1270
+1271
+1272
+1273
+1274
+1275
+1276
+1277
+1278
+1279
+1280
+1281
+1282
+1283
+1284
+1285
+1286
+1287
+1288
+1289
+1290
+1291
+1292
+1293
+1294
+1295
+1296
+1297
+1298
+1299
+1300
+1301
+1302
+1303
+1304
+1305
+1306
+1307
+1308
+1309
+1310
+1311
+1312
+1313
+1314
+1315
+1316
+1317
+1318
+1319
+1320
+1321
+1322
+1323
+1324
+1325
+1326
+1327
+1328
+1329
+1330
+1331
+1332
+1333
+1334
+1335
+1336
+1337
+1338
+1339
+1340
+1341
+1342
+1343
+1344
+1345
+1346
+1347
+1348
+1349
+1350
+1351
+1352
+1353
+1354
+1355
+1356
+1357
+1358
+1359
+1360
+1361
+1362
+1363
+1364
+1365
+1366
+1367
+1368
+1369
+1370
+1371
+1372
+1373
+1374
+1375
+1376
+1377
+1378
+1379
+1380
+1381
+1382
+1383
+1384
+1385
+1386
+1387
+1388
+1389
+1390
+1391
+1392
+1393
+1394
+1395
+1396
+1397
+1398
+1399
+1400
+1401
+1402
+1403
+1404
+1405
+1406
+1407
+1408
+1409
+1410
+1411
+1412
+1413
+1414
+1415
+1416
+1417
+1418
+1419
+1420
+1421
+1422
+1423
+1424
+1425
+1426
+1427
+1428
+1429
+1430
+1431
+1432
+1433
+1434
+1435
+1436
+1437
+1438
+1439
+1440
+1441
+1442
+1443
+1444
+1445
+1446
+1447
+1448
+1449
+1450
+1451
+1452
+1453
+1454
+1455
+1456
+1457
+1458
+1459
+1460
+1461
+1462
+1463
+1464
+1465
+1466
+1467
+1468
+1469
+1470
+1471
+1472
+1473
+1474
+1475
+1476
+1477
+1478
+1479
+1480
+1481
+1482
+1483
+1484
+1485
+1486
+1487
+1488
+1489
+1490
+1491
+1492
+1493
+1494
+1495
+1496
+1497
+1498
+1499
+1500
+1501
+1502
+1503
+1504
+1505
+1506
+1507
+1508
+1509
+1510
+1511
+1512
+1513
+1514
+1515
+1516
+1517
+1518
+1519
+1520
+1521
+1522
+1523
+1524
+1525
+1526
+1527
+1528
+1529
+1530
+1531
+1532
+1533
+1534
+1535
+1536
+1537
+1538
+1539
+1540
+1541
+1542
+1543
+1544
+1545
+1546
+1547
+1548
+1549
+1550
+1551
+1552
+1553
+1554
+1555
+1556
+1557
+1558
+1559
+1560
+1561
+1562
+1563
+1564
+1565
+1566
+1567
+1568
+1569
+1570
+1571
+1572
+1573
+1574
+1575
+1576
+1577
+1578
+1579
+1580
+1581
+1582
+1583
+1584
+1585
+1586
+1587
+1588
+1589
+1590
+1591
+1592
+1593
+1594
+1595
+1596
+1597
+1598
+1599
+1600
+1601
+1602
+1603
+1604
+1605
+1606
+1607
+1608
+1609
+1610
+1611
+1612
+1613
+1614
+1615
+1616
+1617
+1618
+1619
+1620
+1621
+1622
+1623
+1624
+1625
+1626
+1627
+1628
+1629
+1630
+1631
+1632
+1633
+1634
+1635
+1636
+1637
+1638
+1639
+1640
+1641
+1642
+1643
+1644
+1645
+1646
+1647
+1648
+1649
+1650
+1651
+1652
+1653
+1654
+1655
+1656
+1657
+1658
+1659
+1660
+1661
+1662
+1663
+1664
+1665
+1666
+1667
+1668
+1669
+1670
+1671
+1672
+1673
+1674
+1675
+1676
+1677
+1678
+1679
+1680
+1681
+1682
+1683
+1684
+1685
+1686
+1687
+1688
+1689
+1690
+1691
+1692
+1693
+1694
+1695
+1696
+1697
+1698
+1699
+1700
+1701
+1702
+1703
+1704
+1705
+1706
+1707
+1708
+1709
+1710
+1711
+1712
+1713
+1714
+1715
+1716
+1717
+1718
+1719
+1720
+1721
+1722
+1723
+1724
+1725
+1726
+1727
+1728
+1729
+1730
+1731
+1732
+1733
+1734
+1735
+1736
+1737
+1738
+1739
+1740
+1741
+1742
+1743
+1744
+1745
+1746
+1747
+1748
+1749
+1750
+1751
+1752
+1753
+1754
+1755
+1756
+1757
+1758
+1759
+1760
+1761
+1762
+1763
+1764
+1765
+1766
+1767
+1768
+1769
+1770
+1771
+1772
+1773
+1774
+1775
+1776
+1777
+1778
+1779
+1780
+1781
+1782
+1783
+1784
+1785
+1786
+1787
+1788
+1789
+1790
+1791
+1792
+1793
+1794
+1795
+1796
+1797
+1798
+1799
+1800
+1801
+1802
+1803
+1804
+1805
+1806
+1807
+1808
+1809
+1810
+1811
+1812
+1813
+1814
+1815
+1816
+1817
+1818
+1819
+1820
+1821
+1822
+1823
+1824
+1825
+1826
+1827
+1828
+1829
+1830
+1831
+1832
+1833
+1834
+1835
+1836
+1837
+1838
+1839
+1840
+1841
+1842
+1843
+1844
+1845
+1846
+1847
+1848
+1849
+1850
+1851
+1852
+1853
+1854
+1855
+1856
+1857
+1858
+1859
+1860
+1861
+1862
+1863
+1864
+1865
+1866
+1867
+1868
+1869
+1870
+1871
+1872
+1873
+1874
+1875
+1876
+1877
+1878
+1879
+1880
+1881
+1882
+1883
+1884
+1885
+1886
+1887
+1888
+1889
+1890
+1891
+1892
+1893
+1894
+1895
+1896
+1897
+1898
+1899
+1900
+1901
+1902
+1903
+1904
+1905
+1906
+1907
+1908
+1909
+1910
+1911
+1912
+1913
+1914
+1915
+1916
+1917
+1918
+1919
+1920
+1921
+1922
+1923
+1924
+1925
+1926
+1927
+1928
+1929
+1930
+1931
+1932
+1933
+1934
+1935
+1936
+1937
+1938
+1939
+1940
+1941
+1942
+1943
+1944
+1945
+1946
+1947
+1948
+1949
+1950
+1951
+1952
+1953
+1954
+1955
+1956
+1957
+1958
+1959
+1960
+1961
+1962
+1963
+1964
+1965
+1966
+1967
+1968
+1969
+1970
+1971
+1972
+1973
+1974
+1975
+1976
+1977
+1978
+1979
+1980
+1981
+1982
+1983
+1984
+1985
+1986
+1987
+1988
+1989
+1990
+1991
+1992
+1993
+1994
+1995
+1996
+1997
+1998
+1999
+2000
+2001
+2002
+2003
+2004
+2005
+2006
+2007
+2008
+2009
+2010
+2011
+2012
+2013
+2014
+2015
+2016
+2017
+2018
+2019
+2020
+2021
+2022
+2023
+2024
+2025
+2026
+2027
+2028
+2029
+2030
+2031
+2032
+2033
+2034
+2035
+2036
+2037
+2038
+2039
+2040
+2041
+2042
+2043
+2044
+2045
+2046
+2047
+2048
+2049
+2050
+2051
+2052
+2053
+2054
+2055
+2056
+2057
+2058
+2059
+2060
+2061
+2062
+2063
+2064
+2065
+2066
+2067
+2068
+2069
+2070
+2071
+2072
+2073
+2074
+2075
+2076
+2077
+2078
+2079
+2080
+2081
+2082
+2083
+2084
+2085
+2086
+2087
+2088
+2089
+2090
+2091
+2092
+2093
+2094
+2095
+2096
+2097
+2098
+2099
+2100
+2101
+2102
+2103
+2104
+2105
+2106
+2107
+2108
+2109
+2110
+2111
+2112
+2113
+2114
+2115
+2116
+2117
+2118
+2119
+2120
+2121
+2122
+2123
+2124
+2125
+2126
+2127
+2128
+2129
+2130
+2131
+2132
+2133
+2134
+2135
+2136
+2137
+2138
+2139
+2140
+2141
+2142
+2143
+2144
+2145
+2146
+2147
+2148
+2149
+2150
+2151
+2152
+2153
+2154
+2155
+2156
+2157
+2158
+2159
+2160
+2161
+2162
+2163
+2164
+2165
+2166
+2167
+2168
+2169
+2170
+2171
+2172
+2173
+2174
+2175
+2176
+2177
+2178
+2179
+2180
+2181
+2182
+2183
+2184
+2185
+2186
+2187
+2188
+2189
+2190
+2191
+2192
+2193
+2194
+2195
+2196
+2197
+2198
+2199
+2200
+2201
+2202
+2203
+2204
+2205
+2206
+2207
+2208
+2209
+2210
+2211
+2212
+2213
+2214
+2215
+2216
+2217
+2218
+2219
+2220
+2221
+2222
+2223
+2224
+2225
+2226
+2227
+2228
+2229
+2230
+2231
+2232
+2233
+2234
+2235
+2236
+2237
+2238
+2239
+2240
+2241
+2242
+2243
+2244
+2245
+2246
+2247
+2248
+2249
+2250
+2251
+2252
+2253
+2254
+2255
+2256
+2257
+2258
+2259
+2260
+2261
+2262
+2263
+2264
+2265
+2266
+2267
+2268
+2269
+2270
+2271
+2272
+2273
+2274
+2275
+2276
+2277
+2278
+2279
+2280
+2281
+2282
+2283
+2284
+2285
+2286
+2287
+2288
+2289
+2290
+2291
+2292
+2293
+2294
+2295
+2296
+2297
+2298
+2299
+2300
+2301
+2302
+2303
+2304
+2305
+2306
+2307
+2308
+2309
+2310
+2311
+2312
+2313
+2314
+2315
+2316
+2317
+2318
+2319
+2320
+2321
+2322
+2323
+2324
+2325
+2326
+2327
+2328
+2329
+2330
+2331
+2332
+2333
+2334
+2335
+2336
+2337
+2338
+2339
+2340
+2341
+2342
+2343
+2344
+2345
+2346
+2347
+2348
+2349
+2350
+2351
+2352
+2353
+2354
+2355
+2356
+2357
+2358
+2359
+2360
+2361
+2362
+2363
+2364
+2365
+2366
+2367
+2368
+2369
+2370
+2371
+2372
+2373
+2374
+2375
+2376
+2377
+2378
+2379
+2380
+2381
+2382
+2383
+2384
+2385
+2386
+2387
+2388
+2389
+2390
+2391
+2392
+2393
+2394
+2395
+2396
+2397
+2398
+2399
+2400
+2401
+2402
+2403
+2404
+2405
+2406
+2407
+2408
+2409
+2410
+2411
+2412
+2413
+2414
+2415
+2416
+2417
+2418
+2419
+2420
+2421
+2422
+2423
+2424
+2425
+2426
+2427
+2428
+2429
+2430
+2431
+2432
+2433
+2434
+2435
+2436
+2437
+2438
+2439
+2440
+2441
+2442
+2443
+2444
+2445
+2446
+2447
+2448
+2449
+2450
+2451
+2452
+2453
+2454
+2455
+2456
+2457
+2458
class PluginsApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def delete_plugin(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Delete Plugin
+
+        Physically remove plugin.
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._delete_plugin_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def delete_plugin_with_http_info(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Delete Plugin
+
+        Physically remove plugin.
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._delete_plugin_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def delete_plugin_without_preload_content(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Delete Plugin
+
+        Physically remove plugin.
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._delete_plugin_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _delete_plugin_serialize(
+        self,
+        plugin_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if plugin_id is not None:
+            _path_params['plugin_id'] = plugin_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='DELETE',
+            resource_path='/plugins/{plugin_id}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_available_plugins(
+        self,
+        query: Optional[StrictStr] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Available Plugins
+
+        List available plugins
+
+        :param query:
+        :type query: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_available_plugins_serialize(
+            query=query,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_available_plugins_with_http_info(
+        self,
+        query: Optional[StrictStr] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Available Plugins
+
+        List available plugins
+
+        :param query:
+        :type query: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_available_plugins_serialize(
+            query=query,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_available_plugins_without_preload_content(
+        self,
+        query: Optional[StrictStr] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Available Plugins
+
+        List available plugins
+
+        :param query:
+        :type query: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_available_plugins_serialize(
+            query=query,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_available_plugins_serialize(
+        self,
+        query,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if query is not None:
+
+            _query_params.append(('query', query))
+
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/plugins/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_plugin_details(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Plugin Details
+
+        Returns information on a single plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plugin_details_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_plugin_details_with_http_info(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Plugin Details
+
+        Returns information on a single plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plugin_details_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_plugin_details_without_preload_content(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Plugin Details
+
+        Returns information on a single plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plugin_details_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_plugin_details_serialize(
+        self,
+        plugin_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if plugin_id is not None:
+            _path_params['plugin_id'] = plugin_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/plugins/{plugin_id}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_plugin_settings(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Plugin Settings
+
+        Returns the settings of a specific plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plugin_settings_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_plugin_settings_with_http_info(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Plugin Settings
+
+        Returns the settings of a specific plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plugin_settings_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_plugin_settings_without_preload_content(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Plugin Settings
+
+        Returns the settings of a specific plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plugin_settings_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_plugin_settings_serialize(
+        self,
+        plugin_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if plugin_id is not None:
+            _path_params['plugin_id'] = plugin_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/plugins/settings/{plugin_id}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_plugins_settings(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Plugins Settings
+
+        Returns the settings of all the plugins
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plugins_settings_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_plugins_settings_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Plugins Settings
+
+        Returns the settings of all the plugins
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plugins_settings_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_plugins_settings_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Plugins Settings
+
+        Returns the settings of all the plugins
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plugins_settings_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_plugins_settings_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/plugins/settings/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def install_plugin(
+        self,
+        file: Union[StrictBytes, StrictStr],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Install Plugin
+
+        Install a new plugin from a zip file
+
+        :param file: (required)
+        :type file: bytearray
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._install_plugin_serialize(
+            file=file,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def install_plugin_with_http_info(
+        self,
+        file: Union[StrictBytes, StrictStr],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Install Plugin
+
+        Install a new plugin from a zip file
+
+        :param file: (required)
+        :type file: bytearray
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._install_plugin_serialize(
+            file=file,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def install_plugin_without_preload_content(
+        self,
+        file: Union[StrictBytes, StrictStr],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Install Plugin
+
+        Install a new plugin from a zip file
+
+        :param file: (required)
+        :type file: bytearray
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._install_plugin_serialize(
+            file=file,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _install_plugin_serialize(
+        self,
+        file,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        if file is not None:
+            _files['file'] = file
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'multipart/form-data'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/plugins/upload/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def install_plugin_from_registry(
+        self,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Install Plugin From Registry
+
+        Install a new plugin from registry
+
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._install_plugin_from_registry_serialize(
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def install_plugin_from_registry_with_http_info(
+        self,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Install Plugin From Registry
+
+        Install a new plugin from registry
+
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._install_plugin_from_registry_serialize(
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def install_plugin_from_registry_without_preload_content(
+        self,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Install Plugin From Registry
+
+        Install a new plugin from registry
+
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._install_plugin_from_registry_serialize(
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _install_plugin_from_registry_serialize(
+        self,
+        body,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if body is not None:
+            _body_params = body
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/plugins/upload/registry',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def toggle_plugin(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Toggle Plugin
+
+        Enable or disable a single plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._toggle_plugin_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def toggle_plugin_with_http_info(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Toggle Plugin
+
+        Enable or disable a single plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._toggle_plugin_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def toggle_plugin_without_preload_content(
+        self,
+        plugin_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Toggle Plugin
+
+        Enable or disable a single plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._toggle_plugin_serialize(
+            plugin_id=plugin_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _toggle_plugin_serialize(
+        self,
+        plugin_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if plugin_id is not None:
+            _path_params['plugin_id'] = plugin_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='PUT',
+            resource_path='/plugins/toggle/{plugin_id}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def upsert_plugin_settings(
+        self,
+        plugin_id: StrictStr,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Upsert Plugin Settings
+
+        Updates the settings of a specific plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upsert_plugin_settings_serialize(
+            plugin_id=plugin_id,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def upsert_plugin_settings_with_http_info(
+        self,
+        plugin_id: StrictStr,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Upsert Plugin Settings
+
+        Updates the settings of a specific plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upsert_plugin_settings_serialize(
+            plugin_id=plugin_id,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def upsert_plugin_settings_without_preload_content(
+        self,
+        plugin_id: StrictStr,
+        body: Dict[str, Any],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Upsert Plugin Settings
+
+        Updates the settings of a specific plugin
+
+        :param plugin_id: (required)
+        :type plugin_id: str
+        :param body: (required)
+        :type body: object
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upsert_plugin_settings_serialize(
+            plugin_id=plugin_id,
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _upsert_plugin_settings_serialize(
+        self,
+        plugin_id,
+        body,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if plugin_id is not None:
+            _path_params['plugin_id'] = plugin_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if body is not None:
+            _body_params = body
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='PUT',
+            resource_path='/plugins/settings/{plugin_id}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ delete_plugin(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Delete Plugin

+

Physically remove plugin.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
 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
@validate_call
+def delete_plugin(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Delete Plugin
+
+    Physically remove plugin.
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._delete_plugin_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ delete_plugin_with_http_info(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Delete Plugin

+

Physically remove plugin.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
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
@validate_call
+def delete_plugin_with_http_info(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Delete Plugin
+
+    Physically remove plugin.
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._delete_plugin_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ delete_plugin_without_preload_content(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Delete Plugin

+

Physically remove plugin.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
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
@validate_call
+def delete_plugin_without_preload_content(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Delete Plugin
+
+    Physically remove plugin.
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._delete_plugin_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ get_available_plugins(query=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Available Plugins

+

List available plugins

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
query + Optional[StrictStr] + +
+ +
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
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
@validate_call
+def get_available_plugins(
+    self,
+    query: Optional[StrictStr] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Available Plugins
+
+    List available plugins
+
+    :param query:
+    :type query: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_available_plugins_serialize(
+        query=query,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_available_plugins_with_http_info(query=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Available Plugins

+

List available plugins

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
query + Optional[StrictStr] + +
+ +
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
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
+445
+446
+447
+448
@validate_call
+def get_available_plugins_with_http_info(
+    self,
+    query: Optional[StrictStr] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Available Plugins
+
+    List available plugins
+
+    :param query:
+    :type query: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_available_plugins_serialize(
+        query=query,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_available_plugins_without_preload_content(query=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Available Plugins

+

List available plugins

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
query + Optional[StrictStr] + +
+ +
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
+512
+513
@validate_call
+def get_available_plugins_without_preload_content(
+    self,
+    query: Optional[StrictStr] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Available Plugins
+
+    List available plugins
+
+    :param query:
+    :type query: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_available_plugins_serialize(
+        query=query,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ get_plugin_details(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Plugin Details

+

Returns information on a single plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
@validate_call
+def get_plugin_details(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Plugin Details
+
+    Returns information on a single plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_plugin_details_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_plugin_details_with_http_info(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Plugin Details

+

Returns information on a single plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
@validate_call
+def get_plugin_details_with_http_info(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Plugin Details
+
+    Returns information on a single plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_plugin_details_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_plugin_details_without_preload_content(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Plugin Details

+

Returns information on a single plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
+769
+770
+771
+772
+773
+774
+775
+776
+777
+778
+779
@validate_call
+def get_plugin_details_without_preload_content(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Plugin Details
+
+    Returns information on a single plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_plugin_details_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ get_plugin_settings(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Plugin Settings

+

Returns the settings of a specific plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
843
+844
+845
+846
+847
+848
+849
+850
+851
+852
+853
+854
+855
+856
+857
+858
+859
+860
+861
+862
+863
+864
+865
+866
+867
+868
+869
+870
+871
+872
+873
+874
+875
+876
+877
+878
+879
+880
+881
+882
+883
+884
+885
+886
+887
+888
+889
+890
+891
+892
+893
+894
+895
+896
+897
+898
+899
+900
+901
+902
+903
+904
+905
+906
+907
+908
+909
@validate_call
+def get_plugin_settings(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Plugin Settings
+
+    Returns the settings of a specific plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_plugin_settings_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_plugin_settings_with_http_info(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Plugin Settings

+

Returns the settings of a specific plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
912
+913
+914
+915
+916
+917
+918
+919
+920
+921
+922
+923
+924
+925
+926
+927
+928
+929
+930
+931
+932
+933
+934
+935
+936
+937
+938
+939
+940
+941
+942
+943
+944
+945
+946
+947
+948
+949
+950
+951
+952
+953
+954
+955
+956
+957
+958
+959
+960
+961
+962
+963
+964
+965
+966
+967
+968
+969
+970
+971
+972
+973
+974
+975
+976
+977
+978
@validate_call
+def get_plugin_settings_with_http_info(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Plugin Settings
+
+    Returns the settings of a specific plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_plugin_settings_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_plugin_settings_without_preload_content(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Plugin Settings

+

Returns the settings of a specific plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
@validate_call
+def get_plugin_settings_without_preload_content(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Plugin Settings
+
+    Returns the settings of a specific plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_plugin_settings_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ get_plugins_settings(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Plugins Settings

+

Returns the settings of all the plugins

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1107
+1108
+1109
+1110
+1111
+1112
+1113
+1114
+1115
+1116
+1117
+1118
+1119
+1120
+1121
+1122
+1123
+1124
+1125
+1126
+1127
+1128
+1129
+1130
+1131
+1132
+1133
+1134
+1135
+1136
+1137
+1138
+1139
+1140
+1141
+1142
+1143
+1144
+1145
+1146
+1147
+1148
+1149
+1150
+1151
+1152
+1153
+1154
+1155
+1156
+1157
+1158
+1159
+1160
+1161
+1162
+1163
+1164
+1165
+1166
+1167
+1168
@validate_call
+def get_plugins_settings(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Plugins Settings
+
+    Returns the settings of all the plugins
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_plugins_settings_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_plugins_settings_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Plugins Settings

+

Returns the settings of all the plugins

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1171
+1172
+1173
+1174
+1175
+1176
+1177
+1178
+1179
+1180
+1181
+1182
+1183
+1184
+1185
+1186
+1187
+1188
+1189
+1190
+1191
+1192
+1193
+1194
+1195
+1196
+1197
+1198
+1199
+1200
+1201
+1202
+1203
+1204
+1205
+1206
+1207
+1208
+1209
+1210
+1211
+1212
+1213
+1214
+1215
+1216
+1217
+1218
+1219
+1220
+1221
+1222
+1223
+1224
+1225
+1226
+1227
+1228
+1229
+1230
+1231
+1232
@validate_call
+def get_plugins_settings_with_http_info(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Plugins Settings
+
+    Returns the settings of all the plugins
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_plugins_settings_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_plugins_settings_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Plugins Settings

+

Returns the settings of all the plugins

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1235
+1236
+1237
+1238
+1239
+1240
+1241
+1242
+1243
+1244
+1245
+1246
+1247
+1248
+1249
+1250
+1251
+1252
+1253
+1254
+1255
+1256
+1257
+1258
+1259
+1260
+1261
+1262
+1263
+1264
+1265
+1266
+1267
+1268
+1269
+1270
+1271
+1272
+1273
+1274
+1275
+1276
+1277
+1278
+1279
+1280
+1281
+1282
+1283
+1284
+1285
+1286
+1287
+1288
+1289
+1290
+1291
+1292
@validate_call
+def get_plugins_settings_without_preload_content(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Plugins Settings
+
+    Returns the settings of all the plugins
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_plugins_settings_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ install_plugin(file, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Install Plugin

+

Install a new plugin from a zip file

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
file + Union[StrictBytes, StrictStr] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1353
+1354
+1355
+1356
+1357
+1358
+1359
+1360
+1361
+1362
+1363
+1364
+1365
+1366
+1367
+1368
+1369
+1370
+1371
+1372
+1373
+1374
+1375
+1376
+1377
+1378
+1379
+1380
+1381
+1382
+1383
+1384
+1385
+1386
+1387
+1388
+1389
+1390
+1391
+1392
+1393
+1394
+1395
+1396
+1397
+1398
+1399
+1400
+1401
+1402
+1403
+1404
+1405
+1406
+1407
+1408
+1409
+1410
+1411
+1412
+1413
+1414
+1415
+1416
+1417
+1418
+1419
@validate_call
+def install_plugin(
+    self,
+    file: Union[StrictBytes, StrictStr],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Install Plugin
+
+    Install a new plugin from a zip file
+
+    :param file: (required)
+    :type file: bytearray
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._install_plugin_serialize(
+        file=file,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ install_plugin_from_registry(body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Install Plugin From Registry

+

Install a new plugin from registry

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1630
+1631
+1632
+1633
+1634
+1635
+1636
+1637
+1638
+1639
+1640
+1641
+1642
+1643
+1644
+1645
+1646
+1647
+1648
+1649
+1650
+1651
+1652
+1653
+1654
+1655
+1656
+1657
+1658
+1659
+1660
+1661
+1662
+1663
+1664
+1665
+1666
+1667
+1668
+1669
+1670
+1671
+1672
+1673
+1674
+1675
+1676
+1677
+1678
+1679
+1680
+1681
+1682
+1683
+1684
+1685
+1686
+1687
+1688
+1689
+1690
+1691
+1692
+1693
+1694
+1695
+1696
@validate_call
+def install_plugin_from_registry(
+    self,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Install Plugin From Registry
+
+    Install a new plugin from registry
+
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._install_plugin_from_registry_serialize(
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ install_plugin_from_registry_with_http_info(body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Install Plugin From Registry

+

Install a new plugin from registry

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1699
+1700
+1701
+1702
+1703
+1704
+1705
+1706
+1707
+1708
+1709
+1710
+1711
+1712
+1713
+1714
+1715
+1716
+1717
+1718
+1719
+1720
+1721
+1722
+1723
+1724
+1725
+1726
+1727
+1728
+1729
+1730
+1731
+1732
+1733
+1734
+1735
+1736
+1737
+1738
+1739
+1740
+1741
+1742
+1743
+1744
+1745
+1746
+1747
+1748
+1749
+1750
+1751
+1752
+1753
+1754
+1755
+1756
+1757
+1758
+1759
+1760
+1761
+1762
+1763
+1764
+1765
@validate_call
+def install_plugin_from_registry_with_http_info(
+    self,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Install Plugin From Registry
+
+    Install a new plugin from registry
+
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._install_plugin_from_registry_serialize(
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ install_plugin_from_registry_without_preload_content(body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Install Plugin From Registry

+

Install a new plugin from registry

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1768
+1769
+1770
+1771
+1772
+1773
+1774
+1775
+1776
+1777
+1778
+1779
+1780
+1781
+1782
+1783
+1784
+1785
+1786
+1787
+1788
+1789
+1790
+1791
+1792
+1793
+1794
+1795
+1796
+1797
+1798
+1799
+1800
+1801
+1802
+1803
+1804
+1805
+1806
+1807
+1808
+1809
+1810
+1811
+1812
+1813
+1814
+1815
+1816
+1817
+1818
+1819
+1820
+1821
+1822
+1823
+1824
+1825
+1826
+1827
+1828
+1829
+1830
@validate_call
+def install_plugin_from_registry_without_preload_content(
+    self,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Install Plugin From Registry
+
+    Install a new plugin from registry
+
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._install_plugin_from_registry_serialize(
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ install_plugin_with_http_info(file, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Install Plugin

+

Install a new plugin from a zip file

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
file + Union[StrictBytes, StrictStr] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1422
+1423
+1424
+1425
+1426
+1427
+1428
+1429
+1430
+1431
+1432
+1433
+1434
+1435
+1436
+1437
+1438
+1439
+1440
+1441
+1442
+1443
+1444
+1445
+1446
+1447
+1448
+1449
+1450
+1451
+1452
+1453
+1454
+1455
+1456
+1457
+1458
+1459
+1460
+1461
+1462
+1463
+1464
+1465
+1466
+1467
+1468
+1469
+1470
+1471
+1472
+1473
+1474
+1475
+1476
+1477
+1478
+1479
+1480
+1481
+1482
+1483
+1484
+1485
+1486
+1487
+1488
@validate_call
+def install_plugin_with_http_info(
+    self,
+    file: Union[StrictBytes, StrictStr],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Install Plugin
+
+    Install a new plugin from a zip file
+
+    :param file: (required)
+    :type file: bytearray
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._install_plugin_serialize(
+        file=file,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ install_plugin_without_preload_content(file, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Install Plugin

+

Install a new plugin from a zip file

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
file + Union[StrictBytes, StrictStr] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1491
+1492
+1493
+1494
+1495
+1496
+1497
+1498
+1499
+1500
+1501
+1502
+1503
+1504
+1505
+1506
+1507
+1508
+1509
+1510
+1511
+1512
+1513
+1514
+1515
+1516
+1517
+1518
+1519
+1520
+1521
+1522
+1523
+1524
+1525
+1526
+1527
+1528
+1529
+1530
+1531
+1532
+1533
+1534
+1535
+1536
+1537
+1538
+1539
+1540
+1541
+1542
+1543
+1544
+1545
+1546
+1547
+1548
+1549
+1550
+1551
+1552
+1553
@validate_call
+def install_plugin_without_preload_content(
+    self,
+    file: Union[StrictBytes, StrictStr],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Install Plugin
+
+    Install a new plugin from a zip file
+
+    :param file: (required)
+    :type file: bytearray
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._install_plugin_serialize(
+        file=file,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ toggle_plugin(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Toggle Plugin

+

Enable or disable a single plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1907
+1908
+1909
+1910
+1911
+1912
+1913
+1914
+1915
+1916
+1917
+1918
+1919
+1920
+1921
+1922
+1923
+1924
+1925
+1926
+1927
+1928
+1929
+1930
+1931
+1932
+1933
+1934
+1935
+1936
+1937
+1938
+1939
+1940
+1941
+1942
+1943
+1944
+1945
+1946
+1947
+1948
+1949
+1950
+1951
+1952
+1953
+1954
+1955
+1956
+1957
+1958
+1959
+1960
+1961
+1962
+1963
+1964
+1965
+1966
+1967
+1968
+1969
+1970
+1971
+1972
+1973
@validate_call
+def toggle_plugin(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Toggle Plugin
+
+    Enable or disable a single plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._toggle_plugin_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ toggle_plugin_with_http_info(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Toggle Plugin

+

Enable or disable a single plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
1976
+1977
+1978
+1979
+1980
+1981
+1982
+1983
+1984
+1985
+1986
+1987
+1988
+1989
+1990
+1991
+1992
+1993
+1994
+1995
+1996
+1997
+1998
+1999
+2000
+2001
+2002
+2003
+2004
+2005
+2006
+2007
+2008
+2009
+2010
+2011
+2012
+2013
+2014
+2015
+2016
+2017
+2018
+2019
+2020
+2021
+2022
+2023
+2024
+2025
+2026
+2027
+2028
+2029
+2030
+2031
+2032
+2033
+2034
+2035
+2036
+2037
+2038
+2039
+2040
+2041
+2042
@validate_call
+def toggle_plugin_with_http_info(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Toggle Plugin
+
+    Enable or disable a single plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._toggle_plugin_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ toggle_plugin_without_preload_content(plugin_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Toggle Plugin

+

Enable or disable a single plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
2045
+2046
+2047
+2048
+2049
+2050
+2051
+2052
+2053
+2054
+2055
+2056
+2057
+2058
+2059
+2060
+2061
+2062
+2063
+2064
+2065
+2066
+2067
+2068
+2069
+2070
+2071
+2072
+2073
+2074
+2075
+2076
+2077
+2078
+2079
+2080
+2081
+2082
+2083
+2084
+2085
+2086
+2087
+2088
+2089
+2090
+2091
+2092
+2093
+2094
+2095
+2096
+2097
+2098
+2099
+2100
+2101
+2102
+2103
+2104
+2105
+2106
+2107
@validate_call
+def toggle_plugin_without_preload_content(
+    self,
+    plugin_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Toggle Plugin
+
+    Enable or disable a single plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._toggle_plugin_serialize(
+        plugin_id=plugin_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ upsert_plugin_settings(plugin_id, body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upsert Plugin Settings

+

Updates the settings of a specific plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
2171
+2172
+2173
+2174
+2175
+2176
+2177
+2178
+2179
+2180
+2181
+2182
+2183
+2184
+2185
+2186
+2187
+2188
+2189
+2190
+2191
+2192
+2193
+2194
+2195
+2196
+2197
+2198
+2199
+2200
+2201
+2202
+2203
+2204
+2205
+2206
+2207
+2208
+2209
+2210
+2211
+2212
+2213
+2214
+2215
+2216
+2217
+2218
+2219
+2220
+2221
+2222
+2223
+2224
+2225
+2226
+2227
+2228
+2229
+2230
+2231
+2232
+2233
+2234
+2235
+2236
+2237
+2238
+2239
+2240
+2241
@validate_call
+def upsert_plugin_settings(
+    self,
+    plugin_id: StrictStr,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Upsert Plugin Settings
+
+    Updates the settings of a specific plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upsert_plugin_settings_serialize(
+        plugin_id=plugin_id,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ upsert_plugin_settings_with_http_info(plugin_id, body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upsert Plugin Settings

+

Updates the settings of a specific plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
2244
+2245
+2246
+2247
+2248
+2249
+2250
+2251
+2252
+2253
+2254
+2255
+2256
+2257
+2258
+2259
+2260
+2261
+2262
+2263
+2264
+2265
+2266
+2267
+2268
+2269
+2270
+2271
+2272
+2273
+2274
+2275
+2276
+2277
+2278
+2279
+2280
+2281
+2282
+2283
+2284
+2285
+2286
+2287
+2288
+2289
+2290
+2291
+2292
+2293
+2294
+2295
+2296
+2297
+2298
+2299
+2300
+2301
+2302
+2303
+2304
+2305
+2306
+2307
+2308
+2309
+2310
+2311
+2312
+2313
+2314
@validate_call
+def upsert_plugin_settings_with_http_info(
+    self,
+    plugin_id: StrictStr,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Upsert Plugin Settings
+
+    Updates the settings of a specific plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upsert_plugin_settings_serialize(
+        plugin_id=plugin_id,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ upsert_plugin_settings_without_preload_content(plugin_id, body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upsert Plugin Settings

+

Updates the settings of a specific plugin

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
plugin_id + StrictStr + +
+

(required)

+
+ 		+ required +
body + Dict[str, Any] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/plugins_api.py + 
2317
+2318
+2319
+2320
+2321
+2322
+2323
+2324
+2325
+2326
+2327
+2328
+2329
+2330
+2331
+2332
+2333
+2334
+2335
+2336
+2337
+2338
+2339
+2340
+2341
+2342
+2343
+2344
+2345
+2346
+2347
+2348
+2349
+2350
+2351
+2352
+2353
+2354
+2355
+2356
+2357
+2358
+2359
+2360
+2361
+2362
+2363
+2364
+2365
+2366
+2367
+2368
+2369
+2370
+2371
+2372
+2373
+2374
+2375
+2376
+2377
+2378
+2379
+2380
+2381
+2382
+2383
@validate_call
+def upsert_plugin_settings_without_preload_content(
+    self,
+    plugin_id: StrictStr,
+    body: Dict[str, Any],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Upsert Plugin Settings
+
+    Updates the settings of a specific plugin
+
+    :param plugin_id: (required)
+    :type plugin_id: str
+    :param body: (required)
+    :type body: object
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upsert_plugin_settings_serialize(
+        plugin_id=plugin_id,
+        body=body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/api/rabbit_hole_api/index.html b/API_Documentation/api/rabbit_hole_api/index.html new file mode 100644 index 0000000..5daa911 --- /dev/null +++ b/API_Documentation/api/rabbit_hole_api/index.html @@ -0,0 +1,7078 @@ + + + + + + + + + + + + + + + + + + + + + + + rabbit_hole_api - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

rabbit_hole_api

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ RabbitHoleApi + + +

+ + +
+ + +

NOTE: This class is auto generated by OpenAPI Generator +Ref: https://openapi-generator.tech

+

Do not edit the class manually.

+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
  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
+ 445
+ 446
+ 447
+ 448
+ 449
+ 450
+ 451
+ 452
+ 453
+ 454
+ 455
+ 456
+ 457
+ 458
+ 459
+ 460
+ 461
+ 462
+ 463
+ 464
+ 465
+ 466
+ 467
+ 468
+ 469
+ 470
+ 471
+ 472
+ 473
+ 474
+ 475
+ 476
+ 477
+ 478
+ 479
+ 480
+ 481
+ 482
+ 483
+ 484
+ 485
+ 486
+ 487
+ 488
+ 489
+ 490
+ 491
+ 492
+ 493
+ 494
+ 495
+ 496
+ 497
+ 498
+ 499
+ 500
+ 501
+ 502
+ 503
+ 504
+ 505
+ 506
+ 507
+ 508
+ 509
+ 510
+ 511
+ 512
+ 513
+ 514
+ 515
+ 516
+ 517
+ 518
+ 519
+ 520
+ 521
+ 522
+ 523
+ 524
+ 525
+ 526
+ 527
+ 528
+ 529
+ 530
+ 531
+ 532
+ 533
+ 534
+ 535
+ 536
+ 537
+ 538
+ 539
+ 540
+ 541
+ 542
+ 543
+ 544
+ 545
+ 546
+ 547
+ 548
+ 549
+ 550
+ 551
+ 552
+ 553
+ 554
+ 555
+ 556
+ 557
+ 558
+ 559
+ 560
+ 561
+ 562
+ 563
+ 564
+ 565
+ 566
+ 567
+ 568
+ 569
+ 570
+ 571
+ 572
+ 573
+ 574
+ 575
+ 576
+ 577
+ 578
+ 579
+ 580
+ 581
+ 582
+ 583
+ 584
+ 585
+ 586
+ 587
+ 588
+ 589
+ 590
+ 591
+ 592
+ 593
+ 594
+ 595
+ 596
+ 597
+ 598
+ 599
+ 600
+ 601
+ 602
+ 603
+ 604
+ 605
+ 606
+ 607
+ 608
+ 609
+ 610
+ 611
+ 612
+ 613
+ 614
+ 615
+ 616
+ 617
+ 618
+ 619
+ 620
+ 621
+ 622
+ 623
+ 624
+ 625
+ 626
+ 627
+ 628
+ 629
+ 630
+ 631
+ 632
+ 633
+ 634
+ 635
+ 636
+ 637
+ 638
+ 639
+ 640
+ 641
+ 642
+ 643
+ 644
+ 645
+ 646
+ 647
+ 648
+ 649
+ 650
+ 651
+ 652
+ 653
+ 654
+ 655
+ 656
+ 657
+ 658
+ 659
+ 660
+ 661
+ 662
+ 663
+ 664
+ 665
+ 666
+ 667
+ 668
+ 669
+ 670
+ 671
+ 672
+ 673
+ 674
+ 675
+ 676
+ 677
+ 678
+ 679
+ 680
+ 681
+ 682
+ 683
+ 684
+ 685
+ 686
+ 687
+ 688
+ 689
+ 690
+ 691
+ 692
+ 693
+ 694
+ 695
+ 696
+ 697
+ 698
+ 699
+ 700
+ 701
+ 702
+ 703
+ 704
+ 705
+ 706
+ 707
+ 708
+ 709
+ 710
+ 711
+ 712
+ 713
+ 714
+ 715
+ 716
+ 717
+ 718
+ 719
+ 720
+ 721
+ 722
+ 723
+ 724
+ 725
+ 726
+ 727
+ 728
+ 729
+ 730
+ 731
+ 732
+ 733
+ 734
+ 735
+ 736
+ 737
+ 738
+ 739
+ 740
+ 741
+ 742
+ 743
+ 744
+ 745
+ 746
+ 747
+ 748
+ 749
+ 750
+ 751
+ 752
+ 753
+ 754
+ 755
+ 756
+ 757
+ 758
+ 759
+ 760
+ 761
+ 762
+ 763
+ 764
+ 765
+ 766
+ 767
+ 768
+ 769
+ 770
+ 771
+ 772
+ 773
+ 774
+ 775
+ 776
+ 777
+ 778
+ 779
+ 780
+ 781
+ 782
+ 783
+ 784
+ 785
+ 786
+ 787
+ 788
+ 789
+ 790
+ 791
+ 792
+ 793
+ 794
+ 795
+ 796
+ 797
+ 798
+ 799
+ 800
+ 801
+ 802
+ 803
+ 804
+ 805
+ 806
+ 807
+ 808
+ 809
+ 810
+ 811
+ 812
+ 813
+ 814
+ 815
+ 816
+ 817
+ 818
+ 819
+ 820
+ 821
+ 822
+ 823
+ 824
+ 825
+ 826
+ 827
+ 828
+ 829
+ 830
+ 831
+ 832
+ 833
+ 834
+ 835
+ 836
+ 837
+ 838
+ 839
+ 840
+ 841
+ 842
+ 843
+ 844
+ 845
+ 846
+ 847
+ 848
+ 849
+ 850
+ 851
+ 852
+ 853
+ 854
+ 855
+ 856
+ 857
+ 858
+ 859
+ 860
+ 861
+ 862
+ 863
+ 864
+ 865
+ 866
+ 867
+ 868
+ 869
+ 870
+ 871
+ 872
+ 873
+ 874
+ 875
+ 876
+ 877
+ 878
+ 879
+ 880
+ 881
+ 882
+ 883
+ 884
+ 885
+ 886
+ 887
+ 888
+ 889
+ 890
+ 891
+ 892
+ 893
+ 894
+ 895
+ 896
+ 897
+ 898
+ 899
+ 900
+ 901
+ 902
+ 903
+ 904
+ 905
+ 906
+ 907
+ 908
+ 909
+ 910
+ 911
+ 912
+ 913
+ 914
+ 915
+ 916
+ 917
+ 918
+ 919
+ 920
+ 921
+ 922
+ 923
+ 924
+ 925
+ 926
+ 927
+ 928
+ 929
+ 930
+ 931
+ 932
+ 933
+ 934
+ 935
+ 936
+ 937
+ 938
+ 939
+ 940
+ 941
+ 942
+ 943
+ 944
+ 945
+ 946
+ 947
+ 948
+ 949
+ 950
+ 951
+ 952
+ 953
+ 954
+ 955
+ 956
+ 957
+ 958
+ 959
+ 960
+ 961
+ 962
+ 963
+ 964
+ 965
+ 966
+ 967
+ 968
+ 969
+ 970
+ 971
+ 972
+ 973
+ 974
+ 975
+ 976
+ 977
+ 978
+ 979
+ 980
+ 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
+1061
+1062
+1063
+1064
+1065
+1066
+1067
+1068
+1069
+1070
+1071
+1072
+1073
+1074
+1075
+1076
+1077
+1078
+1079
+1080
+1081
+1082
+1083
+1084
+1085
+1086
+1087
+1088
+1089
+1090
+1091
+1092
+1093
+1094
+1095
+1096
+1097
+1098
+1099
+1100
+1101
+1102
+1103
+1104
+1105
+1106
+1107
+1108
+1109
+1110
+1111
+1112
+1113
+1114
+1115
+1116
+1117
+1118
+1119
+1120
+1121
+1122
+1123
+1124
+1125
+1126
+1127
+1128
+1129
+1130
+1131
+1132
+1133
+1134
+1135
+1136
+1137
+1138
+1139
+1140
+1141
+1142
+1143
+1144
+1145
+1146
+1147
+1148
+1149
+1150
+1151
+1152
+1153
+1154
class RabbitHoleApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_allowed_mimetypes(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Allowed Mimetypes
+
+        Retrieve the allowed mimetypes that can be ingested by the Rabbit Hole
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_allowed_mimetypes_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_allowed_mimetypes_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Allowed Mimetypes
+
+        Retrieve the allowed mimetypes that can be ingested by the Rabbit Hole
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_allowed_mimetypes_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_allowed_mimetypes_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Allowed Mimetypes
+
+        Retrieve the allowed mimetypes that can be ingested by the Rabbit Hole
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_allowed_mimetypes_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_allowed_mimetypes_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/rabbithole/allowed-mimetypes/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def upload_file(
+        self,
+        file: Union[StrictBytes, StrictStr],
+        chunk_size: Annotated[Optional[StrictInt], Field(description="Maximum length of each chunk after the document is split (in characters)")] = None,
+        chunk_overlap: Annotated[Optional[StrictInt], Field(description="Chunk overlap (in characters)")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Upload File
+
+        Upload a file containing text (.txt, .md, .pdf, etc.). File content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+        :param file: (required)
+        :type file: bytearray
+        :param chunk_size: Maximum length of each chunk after the document is split (in characters)
+        :type chunk_size: int
+        :param chunk_overlap: Chunk overlap (in characters)
+        :type chunk_overlap: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upload_file_serialize(
+            file=file,
+            chunk_size=chunk_size,
+            chunk_overlap=chunk_overlap,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def upload_file_with_http_info(
+        self,
+        file: Union[StrictBytes, StrictStr],
+        chunk_size: Annotated[Optional[StrictInt], Field(description="Maximum length of each chunk after the document is split (in characters)")] = None,
+        chunk_overlap: Annotated[Optional[StrictInt], Field(description="Chunk overlap (in characters)")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Upload File
+
+        Upload a file containing text (.txt, .md, .pdf, etc.). File content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+        :param file: (required)
+        :type file: bytearray
+        :param chunk_size: Maximum length of each chunk after the document is split (in characters)
+        :type chunk_size: int
+        :param chunk_overlap: Chunk overlap (in characters)
+        :type chunk_overlap: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upload_file_serialize(
+            file=file,
+            chunk_size=chunk_size,
+            chunk_overlap=chunk_overlap,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def upload_file_without_preload_content(
+        self,
+        file: Union[StrictBytes, StrictStr],
+        chunk_size: Annotated[Optional[StrictInt], Field(description="Maximum length of each chunk after the document is split (in characters)")] = None,
+        chunk_overlap: Annotated[Optional[StrictInt], Field(description="Chunk overlap (in characters)")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Upload File
+
+        Upload a file containing text (.txt, .md, .pdf, etc.). File content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+        :param file: (required)
+        :type file: bytearray
+        :param chunk_size: Maximum length of each chunk after the document is split (in characters)
+        :type chunk_size: int
+        :param chunk_overlap: Chunk overlap (in characters)
+        :type chunk_overlap: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upload_file_serialize(
+            file=file,
+            chunk_size=chunk_size,
+            chunk_overlap=chunk_overlap,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _upload_file_serialize(
+        self,
+        file,
+        chunk_size,
+        chunk_overlap,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        if file is not None:
+            _files['file'] = file
+        if chunk_size is not None:
+            _form_params.append(('chunk_size', chunk_size))
+        if chunk_overlap is not None:
+            _form_params.append(('chunk_overlap', chunk_overlap))
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'multipart/form-data'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/rabbithole/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def upload_memory(
+        self,
+        file: Union[StrictBytes, StrictStr],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Upload Memory
+
+        Upload a memory json file to the cat memory
+
+        :param file: (required)
+        :type file: bytearray
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upload_memory_serialize(
+            file=file,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def upload_memory_with_http_info(
+        self,
+        file: Union[StrictBytes, StrictStr],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Upload Memory
+
+        Upload a memory json file to the cat memory
+
+        :param file: (required)
+        :type file: bytearray
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upload_memory_serialize(
+            file=file,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def upload_memory_without_preload_content(
+        self,
+        file: Union[StrictBytes, StrictStr],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Upload Memory
+
+        Upload a memory json file to the cat memory
+
+        :param file: (required)
+        :type file: bytearray
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upload_memory_serialize(
+            file=file,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _upload_memory_serialize(
+        self,
+        file,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        if file is not None:
+            _files['file'] = file
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'multipart/form-data'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/rabbithole/memory/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def upload_url(
+        self,
+        body_upload_url: BodyUploadUrl,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Upload Url
+
+        Upload a url. Website content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+        :param body_upload_url: (required)
+        :type body_upload_url: BodyUploadUrl
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upload_url_serialize(
+            body_upload_url=body_upload_url,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def upload_url_with_http_info(
+        self,
+        body_upload_url: BodyUploadUrl,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Upload Url
+
+        Upload a url. Website content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+        :param body_upload_url: (required)
+        :type body_upload_url: BodyUploadUrl
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upload_url_serialize(
+            body_upload_url=body_upload_url,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def upload_url_without_preload_content(
+        self,
+        body_upload_url: BodyUploadUrl,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Upload Url
+
+        Upload a url. Website content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+        :param body_upload_url: (required)
+        :type body_upload_url: BodyUploadUrl
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._upload_url_serialize(
+            body_upload_url=body_upload_url,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _upload_url_serialize(
+        self,
+        body_upload_url,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if body_upload_url is not None:
+            _body_params = body_upload_url
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/rabbithole/web/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ get_allowed_mimetypes(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Allowed Mimetypes

+

Retrieve the allowed mimetypes that can be ingested by the Rabbit Hole

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
 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
@validate_call
+def get_allowed_mimetypes(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Allowed Mimetypes
+
+    Retrieve the allowed mimetypes that can be ingested by the Rabbit Hole
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_allowed_mimetypes_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_allowed_mimetypes_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Allowed Mimetypes

+

Retrieve the allowed mimetypes that can be ingested by the Rabbit Hole

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
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
@validate_call
+def get_allowed_mimetypes_with_http_info(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Allowed Mimetypes
+
+    Retrieve the allowed mimetypes that can be ingested by the Rabbit Hole
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_allowed_mimetypes_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_allowed_mimetypes_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Allowed Mimetypes

+

Retrieve the allowed mimetypes that can be ingested by the Rabbit Hole

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
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
@validate_call
+def get_allowed_mimetypes_without_preload_content(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Allowed Mimetypes
+
+    Retrieve the allowed mimetypes that can be ingested by the Rabbit Hole
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_allowed_mimetypes_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ upload_file(file, chunk_size=None, chunk_overlap=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upload File

+

Upload a file containing text (.txt, .md, .pdf, etc.). File content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
file + Union[StrictBytes, StrictStr] + +
+

(required)

+
+ 		+ required +
chunk_size + Annotated[Optional[StrictInt], Field(description='Maximum length of each chunk after the document is split (in characters)')] + +
+

Maximum length of each chunk after the document is split (in characters)

+
+ 		+ None +
chunk_overlap + Annotated[Optional[StrictInt], Field(description='Chunk overlap (in characters)')] + +
+

Chunk overlap (in characters)

+
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
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
@validate_call
+def upload_file(
+    self,
+    file: Union[StrictBytes, StrictStr],
+    chunk_size: Annotated[Optional[StrictInt], Field(description="Maximum length of each chunk after the document is split (in characters)")] = None,
+    chunk_overlap: Annotated[Optional[StrictInt], Field(description="Chunk overlap (in characters)")] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Upload File
+
+    Upload a file containing text (.txt, .md, .pdf, etc.). File content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+    :param file: (required)
+    :type file: bytearray
+    :param chunk_size: Maximum length of each chunk after the document is split (in characters)
+    :type chunk_size: int
+    :param chunk_overlap: Chunk overlap (in characters)
+    :type chunk_overlap: int
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upload_file_serialize(
+        file=file,
+        chunk_size=chunk_size,
+        chunk_overlap=chunk_overlap,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ upload_file_with_http_info(file, chunk_size=None, chunk_overlap=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upload File

+

Upload a file containing text (.txt, .md, .pdf, etc.). File content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
file + Union[StrictBytes, StrictStr] + +
+

(required)

+
+ 		+ required +
chunk_size + Annotated[Optional[StrictInt], Field(description='Maximum length of each chunk after the document is split (in characters)')] + +
+

Maximum length of each chunk after the document is split (in characters)

+
+ 		+ None +
chunk_overlap + Annotated[Optional[StrictInt], Field(description='Chunk overlap (in characters)')] + +
+

Chunk overlap (in characters)

+
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
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
+445
+446
+447
+448
+449
@validate_call
+def upload_file_with_http_info(
+    self,
+    file: Union[StrictBytes, StrictStr],
+    chunk_size: Annotated[Optional[StrictInt], Field(description="Maximum length of each chunk after the document is split (in characters)")] = None,
+    chunk_overlap: Annotated[Optional[StrictInt], Field(description="Chunk overlap (in characters)")] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Upload File
+
+    Upload a file containing text (.txt, .md, .pdf, etc.). File content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+    :param file: (required)
+    :type file: bytearray
+    :param chunk_size: Maximum length of each chunk after the document is split (in characters)
+    :type chunk_size: int
+    :param chunk_overlap: Chunk overlap (in characters)
+    :type chunk_overlap: int
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upload_file_serialize(
+        file=file,
+        chunk_size=chunk_size,
+        chunk_overlap=chunk_overlap,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ upload_file_without_preload_content(file, chunk_size=None, chunk_overlap=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upload File

+

Upload a file containing text (.txt, .md, .pdf, etc.). File content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
file + Union[StrictBytes, StrictStr] + +
+

(required)

+
+ 		+ required +
chunk_size + Annotated[Optional[StrictInt], Field(description='Maximum length of each chunk after the document is split (in characters)')] + +
+

Maximum length of each chunk after the document is split (in characters)

+
+ 		+ None +
chunk_overlap + Annotated[Optional[StrictInt], Field(description='Chunk overlap (in characters)')] + +
+

Chunk overlap (in characters)

+
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
+512
+513
+514
+515
+516
+517
+518
+519
+520
+521
+522
@validate_call
+def upload_file_without_preload_content(
+    self,
+    file: Union[StrictBytes, StrictStr],
+    chunk_size: Annotated[Optional[StrictInt], Field(description="Maximum length of each chunk after the document is split (in characters)")] = None,
+    chunk_overlap: Annotated[Optional[StrictInt], Field(description="Chunk overlap (in characters)")] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Upload File
+
+    Upload a file containing text (.txt, .md, .pdf, etc.). File content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+    :param file: (required)
+    :type file: bytearray
+    :param chunk_size: Maximum length of each chunk after the document is split (in characters)
+    :type chunk_size: int
+    :param chunk_overlap: Chunk overlap (in characters)
+    :type chunk_overlap: int
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upload_file_serialize(
+        file=file,
+        chunk_size=chunk_size,
+        chunk_overlap=chunk_overlap,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ upload_memory(file, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upload Memory

+

Upload a memory json file to the cat memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
file + Union[StrictBytes, StrictStr] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
@validate_call
+def upload_memory(
+    self,
+    file: Union[StrictBytes, StrictStr],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Upload Memory
+
+    Upload a memory json file to the cat memory
+
+    :param file: (required)
+    :type file: bytearray
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upload_memory_serialize(
+        file=file,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ upload_memory_with_http_info(file, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upload Memory

+

Upload a memory json file to the cat memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
file + Union[StrictBytes, StrictStr] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
@validate_call
+def upload_memory_with_http_info(
+    self,
+    file: Union[StrictBytes, StrictStr],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Upload Memory
+
+    Upload a memory json file to the cat memory
+
+    :param file: (required)
+    :type file: bytearray
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upload_memory_serialize(
+        file=file,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ upload_memory_without_preload_content(file, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upload Memory

+

Upload a memory json file to the cat memory

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
file + Union[StrictBytes, StrictStr] + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
+769
+770
+771
+772
+773
+774
+775
+776
+777
+778
+779
+780
+781
+782
+783
+784
+785
+786
+787
+788
+789
+790
+791
+792
+793
+794
+795
+796
+797
+798
+799
+800
+801
+802
+803
+804
+805
@validate_call
+def upload_memory_without_preload_content(
+    self,
+    file: Union[StrictBytes, StrictStr],
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Upload Memory
+
+    Upload a memory json file to the cat memory
+
+    :param file: (required)
+    :type file: bytearray
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upload_memory_serialize(
+        file=file,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ upload_url(body_upload_url, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upload Url

+

Upload a url. Website content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
body_upload_url + BodyUploadUrl + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
882
+883
+884
+885
+886
+887
+888
+889
+890
+891
+892
+893
+894
+895
+896
+897
+898
+899
+900
+901
+902
+903
+904
+905
+906
+907
+908
+909
+910
+911
+912
+913
+914
+915
+916
+917
+918
+919
+920
+921
+922
+923
+924
+925
+926
+927
+928
+929
+930
+931
+932
+933
+934
+935
+936
+937
+938
+939
+940
+941
+942
+943
+944
+945
+946
+947
+948
@validate_call
+def upload_url(
+    self,
+    body_upload_url: BodyUploadUrl,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Upload Url
+
+    Upload a url. Website content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+    :param body_upload_url: (required)
+    :type body_upload_url: BodyUploadUrl
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upload_url_serialize(
+        body_upload_url=body_upload_url,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ upload_url_with_http_info(body_upload_url, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upload Url

+

Upload a url. Website content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
body_upload_url + BodyUploadUrl + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
 951
+ 952
+ 953
+ 954
+ 955
+ 956
+ 957
+ 958
+ 959
+ 960
+ 961
+ 962
+ 963
+ 964
+ 965
+ 966
+ 967
+ 968
+ 969
+ 970
+ 971
+ 972
+ 973
+ 974
+ 975
+ 976
+ 977
+ 978
+ 979
+ 980
+ 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
@validate_call
+def upload_url_with_http_info(
+    self,
+    body_upload_url: BodyUploadUrl,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Upload Url
+
+    Upload a url. Website content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+    :param body_upload_url: (required)
+    :type body_upload_url: BodyUploadUrl
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upload_url_serialize(
+        body_upload_url=body_upload_url,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ upload_url_without_preload_content(body_upload_url, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Upload Url

+

Upload a url. Website content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
body_upload_url + BodyUploadUrl + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/rabbit_hole_api.py + 
1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
+1061
+1062
+1063
+1064
+1065
+1066
+1067
+1068
+1069
+1070
+1071
+1072
+1073
+1074
+1075
+1076
+1077
+1078
+1079
+1080
+1081
+1082
@validate_call
+def upload_url_without_preload_content(
+    self,
+    body_upload_url: BodyUploadUrl,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Upload Url
+
+    Upload a url. Website content will be extracted and segmented into chunks. Chunks will be then vectorized and stored into documents memory.
+
+    :param body_upload_url: (required)
+    :type body_upload_url: BodyUploadUrl
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._upload_url_serialize(
+        body_upload_url=body_upload_url,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/api/settings_api/index.html b/API_Documentation/api/settings_api/index.html new file mode 100644 index 0000000..2e59082 --- /dev/null +++ b/API_Documentation/api/settings_api/index.html @@ -0,0 +1,8473 @@ + + + + + + + + + + + + + + + + + + + + + + + settings_api - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

settings_api

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ SettingsApi + + +

+ + +
+ + +

NOTE: This class is auto generated by OpenAPI Generator +Ref: https://openapi-generator.tech

+

Do not edit the class manually.

+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
  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
+ 445
+ 446
+ 447
+ 448
+ 449
+ 450
+ 451
+ 452
+ 453
+ 454
+ 455
+ 456
+ 457
+ 458
+ 459
+ 460
+ 461
+ 462
+ 463
+ 464
+ 465
+ 466
+ 467
+ 468
+ 469
+ 470
+ 471
+ 472
+ 473
+ 474
+ 475
+ 476
+ 477
+ 478
+ 479
+ 480
+ 481
+ 482
+ 483
+ 484
+ 485
+ 486
+ 487
+ 488
+ 489
+ 490
+ 491
+ 492
+ 493
+ 494
+ 495
+ 496
+ 497
+ 498
+ 499
+ 500
+ 501
+ 502
+ 503
+ 504
+ 505
+ 506
+ 507
+ 508
+ 509
+ 510
+ 511
+ 512
+ 513
+ 514
+ 515
+ 516
+ 517
+ 518
+ 519
+ 520
+ 521
+ 522
+ 523
+ 524
+ 525
+ 526
+ 527
+ 528
+ 529
+ 530
+ 531
+ 532
+ 533
+ 534
+ 535
+ 536
+ 537
+ 538
+ 539
+ 540
+ 541
+ 542
+ 543
+ 544
+ 545
+ 546
+ 547
+ 548
+ 549
+ 550
+ 551
+ 552
+ 553
+ 554
+ 555
+ 556
+ 557
+ 558
+ 559
+ 560
+ 561
+ 562
+ 563
+ 564
+ 565
+ 566
+ 567
+ 568
+ 569
+ 570
+ 571
+ 572
+ 573
+ 574
+ 575
+ 576
+ 577
+ 578
+ 579
+ 580
+ 581
+ 582
+ 583
+ 584
+ 585
+ 586
+ 587
+ 588
+ 589
+ 590
+ 591
+ 592
+ 593
+ 594
+ 595
+ 596
+ 597
+ 598
+ 599
+ 600
+ 601
+ 602
+ 603
+ 604
+ 605
+ 606
+ 607
+ 608
+ 609
+ 610
+ 611
+ 612
+ 613
+ 614
+ 615
+ 616
+ 617
+ 618
+ 619
+ 620
+ 621
+ 622
+ 623
+ 624
+ 625
+ 626
+ 627
+ 628
+ 629
+ 630
+ 631
+ 632
+ 633
+ 634
+ 635
+ 636
+ 637
+ 638
+ 639
+ 640
+ 641
+ 642
+ 643
+ 644
+ 645
+ 646
+ 647
+ 648
+ 649
+ 650
+ 651
+ 652
+ 653
+ 654
+ 655
+ 656
+ 657
+ 658
+ 659
+ 660
+ 661
+ 662
+ 663
+ 664
+ 665
+ 666
+ 667
+ 668
+ 669
+ 670
+ 671
+ 672
+ 673
+ 674
+ 675
+ 676
+ 677
+ 678
+ 679
+ 680
+ 681
+ 682
+ 683
+ 684
+ 685
+ 686
+ 687
+ 688
+ 689
+ 690
+ 691
+ 692
+ 693
+ 694
+ 695
+ 696
+ 697
+ 698
+ 699
+ 700
+ 701
+ 702
+ 703
+ 704
+ 705
+ 706
+ 707
+ 708
+ 709
+ 710
+ 711
+ 712
+ 713
+ 714
+ 715
+ 716
+ 717
+ 718
+ 719
+ 720
+ 721
+ 722
+ 723
+ 724
+ 725
+ 726
+ 727
+ 728
+ 729
+ 730
+ 731
+ 732
+ 733
+ 734
+ 735
+ 736
+ 737
+ 738
+ 739
+ 740
+ 741
+ 742
+ 743
+ 744
+ 745
+ 746
+ 747
+ 748
+ 749
+ 750
+ 751
+ 752
+ 753
+ 754
+ 755
+ 756
+ 757
+ 758
+ 759
+ 760
+ 761
+ 762
+ 763
+ 764
+ 765
+ 766
+ 767
+ 768
+ 769
+ 770
+ 771
+ 772
+ 773
+ 774
+ 775
+ 776
+ 777
+ 778
+ 779
+ 780
+ 781
+ 782
+ 783
+ 784
+ 785
+ 786
+ 787
+ 788
+ 789
+ 790
+ 791
+ 792
+ 793
+ 794
+ 795
+ 796
+ 797
+ 798
+ 799
+ 800
+ 801
+ 802
+ 803
+ 804
+ 805
+ 806
+ 807
+ 808
+ 809
+ 810
+ 811
+ 812
+ 813
+ 814
+ 815
+ 816
+ 817
+ 818
+ 819
+ 820
+ 821
+ 822
+ 823
+ 824
+ 825
+ 826
+ 827
+ 828
+ 829
+ 830
+ 831
+ 832
+ 833
+ 834
+ 835
+ 836
+ 837
+ 838
+ 839
+ 840
+ 841
+ 842
+ 843
+ 844
+ 845
+ 846
+ 847
+ 848
+ 849
+ 850
+ 851
+ 852
+ 853
+ 854
+ 855
+ 856
+ 857
+ 858
+ 859
+ 860
+ 861
+ 862
+ 863
+ 864
+ 865
+ 866
+ 867
+ 868
+ 869
+ 870
+ 871
+ 872
+ 873
+ 874
+ 875
+ 876
+ 877
+ 878
+ 879
+ 880
+ 881
+ 882
+ 883
+ 884
+ 885
+ 886
+ 887
+ 888
+ 889
+ 890
+ 891
+ 892
+ 893
+ 894
+ 895
+ 896
+ 897
+ 898
+ 899
+ 900
+ 901
+ 902
+ 903
+ 904
+ 905
+ 906
+ 907
+ 908
+ 909
+ 910
+ 911
+ 912
+ 913
+ 914
+ 915
+ 916
+ 917
+ 918
+ 919
+ 920
+ 921
+ 922
+ 923
+ 924
+ 925
+ 926
+ 927
+ 928
+ 929
+ 930
+ 931
+ 932
+ 933
+ 934
+ 935
+ 936
+ 937
+ 938
+ 939
+ 940
+ 941
+ 942
+ 943
+ 944
+ 945
+ 946
+ 947
+ 948
+ 949
+ 950
+ 951
+ 952
+ 953
+ 954
+ 955
+ 956
+ 957
+ 958
+ 959
+ 960
+ 961
+ 962
+ 963
+ 964
+ 965
+ 966
+ 967
+ 968
+ 969
+ 970
+ 971
+ 972
+ 973
+ 974
+ 975
+ 976
+ 977
+ 978
+ 979
+ 980
+ 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
+1061
+1062
+1063
+1064
+1065
+1066
+1067
+1068
+1069
+1070
+1071
+1072
+1073
+1074
+1075
+1076
+1077
+1078
+1079
+1080
+1081
+1082
+1083
+1084
+1085
+1086
+1087
+1088
+1089
+1090
+1091
+1092
+1093
+1094
+1095
+1096
+1097
+1098
+1099
+1100
+1101
+1102
+1103
+1104
+1105
+1106
+1107
+1108
+1109
+1110
+1111
+1112
+1113
+1114
+1115
+1116
+1117
+1118
+1119
+1120
+1121
+1122
+1123
+1124
+1125
+1126
+1127
+1128
+1129
+1130
+1131
+1132
+1133
+1134
+1135
+1136
+1137
+1138
+1139
+1140
+1141
+1142
+1143
+1144
+1145
+1146
+1147
+1148
+1149
+1150
+1151
+1152
+1153
+1154
+1155
+1156
+1157
+1158
+1159
+1160
+1161
+1162
+1163
+1164
+1165
+1166
+1167
+1168
+1169
+1170
+1171
+1172
+1173
+1174
+1175
+1176
+1177
+1178
+1179
+1180
+1181
+1182
+1183
+1184
+1185
+1186
+1187
+1188
+1189
+1190
+1191
+1192
+1193
+1194
+1195
+1196
+1197
+1198
+1199
+1200
+1201
+1202
+1203
+1204
+1205
+1206
+1207
+1208
+1209
+1210
+1211
+1212
+1213
+1214
+1215
+1216
+1217
+1218
+1219
+1220
+1221
+1222
+1223
+1224
+1225
+1226
+1227
+1228
+1229
+1230
+1231
+1232
+1233
+1234
+1235
+1236
+1237
+1238
+1239
+1240
+1241
+1242
+1243
+1244
+1245
+1246
+1247
+1248
+1249
+1250
+1251
+1252
+1253
+1254
+1255
+1256
+1257
+1258
+1259
+1260
+1261
+1262
+1263
+1264
+1265
+1266
+1267
+1268
+1269
+1270
+1271
+1272
+1273
+1274
+1275
+1276
+1277
+1278
+1279
+1280
+1281
+1282
+1283
+1284
+1285
+1286
+1287
+1288
+1289
+1290
+1291
+1292
+1293
+1294
+1295
+1296
+1297
+1298
+1299
+1300
+1301
+1302
+1303
+1304
+1305
+1306
+1307
+1308
+1309
+1310
+1311
+1312
+1313
+1314
+1315
+1316
+1317
+1318
+1319
+1320
+1321
+1322
+1323
+1324
+1325
+1326
+1327
+1328
+1329
+1330
+1331
+1332
+1333
+1334
+1335
+1336
+1337
+1338
+1339
+1340
+1341
+1342
+1343
+1344
+1345
+1346
+1347
+1348
+1349
+1350
+1351
+1352
+1353
+1354
+1355
+1356
+1357
+1358
+1359
+1360
+1361
+1362
+1363
+1364
+1365
+1366
+1367
+1368
+1369
+1370
+1371
+1372
+1373
+1374
+1375
+1376
+1377
+1378
+1379
+1380
+1381
+1382
+1383
+1384
+1385
+1386
+1387
+1388
+1389
+1390
+1391
+1392
+1393
+1394
+1395
+1396
+1397
+1398
+1399
+1400
+1401
+1402
+1403
+1404
+1405
+1406
+1407
+1408
class SettingsApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def create_setting(
+        self,
+        setting_body: SettingBody,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Create Setting
+
+        Create a new setting in the database
+
+        :param setting_body: (required)
+        :type setting_body: SettingBody
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._create_setting_serialize(
+            setting_body=setting_body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def create_setting_with_http_info(
+        self,
+        setting_body: SettingBody,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Create Setting
+
+        Create a new setting in the database
+
+        :param setting_body: (required)
+        :type setting_body: SettingBody
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._create_setting_serialize(
+            setting_body=setting_body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def create_setting_without_preload_content(
+        self,
+        setting_body: SettingBody,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Create Setting
+
+        Create a new setting in the database
+
+        :param setting_body: (required)
+        :type setting_body: SettingBody
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._create_setting_serialize(
+            setting_body=setting_body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _create_setting_serialize(
+        self,
+        setting_body,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if setting_body is not None:
+            _body_params = setting_body
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/settings/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def delete_setting(
+        self,
+        setting_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Delete Setting
+
+        Delete a specific setting in the database
+
+        :param setting_id: (required)
+        :type setting_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._delete_setting_serialize(
+            setting_id=setting_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def delete_setting_with_http_info(
+        self,
+        setting_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Delete Setting
+
+        Delete a specific setting in the database
+
+        :param setting_id: (required)
+        :type setting_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._delete_setting_serialize(
+            setting_id=setting_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def delete_setting_without_preload_content(
+        self,
+        setting_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Delete Setting
+
+        Delete a specific setting in the database
+
+        :param setting_id: (required)
+        :type setting_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._delete_setting_serialize(
+            setting_id=setting_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _delete_setting_serialize(
+        self,
+        setting_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if setting_id is not None:
+            _path_params['settingId'] = setting_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='DELETE',
+            resource_path='/settings/{settingId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_setting(
+        self,
+        setting_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Setting
+
+        Get the a specific setting from the database
+
+        :param setting_id: (required)
+        :type setting_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_setting_serialize(
+            setting_id=setting_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_setting_with_http_info(
+        self,
+        setting_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Setting
+
+        Get the a specific setting from the database
+
+        :param setting_id: (required)
+        :type setting_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_setting_serialize(
+            setting_id=setting_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_setting_without_preload_content(
+        self,
+        setting_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Setting
+
+        Get the a specific setting from the database
+
+        :param setting_id: (required)
+        :type setting_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_setting_serialize(
+            setting_id=setting_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_setting_serialize(
+        self,
+        setting_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if setting_id is not None:
+            _path_params['settingId'] = setting_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/settings/{settingId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_settings(
+        self,
+        search: Optional[StrictStr] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Get Settings
+
+        Get the entire list of settings available in the database
+
+        :param search:
+        :type search: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_settings_serialize(
+            search=search,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_settings_with_http_info(
+        self,
+        search: Optional[StrictStr] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Get Settings
+
+        Get the entire list of settings available in the database
+
+        :param search:
+        :type search: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_settings_serialize(
+            search=search,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_settings_without_preload_content(
+        self,
+        search: Optional[StrictStr] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Settings
+
+        Get the entire list of settings available in the database
+
+        :param search:
+        :type search: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_settings_serialize(
+            search=search,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_settings_serialize(
+        self,
+        search,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if search is not None:
+
+            _query_params.append(('search', search))
+
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/settings/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def update_setting(
+        self,
+        setting_id: StrictStr,
+        setting_body: SettingBody,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Update Setting
+
+        Update a specific setting in the database if it exists
+
+        :param setting_id: (required)
+        :type setting_id: str
+        :param setting_body: (required)
+        :type setting_body: SettingBody
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._update_setting_serialize(
+            setting_id=setting_id,
+            setting_body=setting_body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def update_setting_with_http_info(
+        self,
+        setting_id: StrictStr,
+        setting_body: SettingBody,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Update Setting
+
+        Update a specific setting in the database if it exists
+
+        :param setting_id: (required)
+        :type setting_id: str
+        :param setting_body: (required)
+        :type setting_body: SettingBody
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._update_setting_serialize(
+            setting_id=setting_id,
+            setting_body=setting_body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def update_setting_without_preload_content(
+        self,
+        setting_id: StrictStr,
+        setting_body: SettingBody,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Update Setting
+
+        Update a specific setting in the database if it exists
+
+        :param setting_id: (required)
+        :type setting_id: str
+        :param setting_body: (required)
+        :type setting_body: SettingBody
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._update_setting_serialize(
+            setting_id=setting_id,
+            setting_body=setting_body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object",
+            '422': "HTTPValidationError"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _update_setting_serialize(
+        self,
+        setting_id,
+        setting_body,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if setting_id is not None:
+            _path_params['settingId'] = setting_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if setting_body is not None:
+            _body_params = setting_body
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='PUT',
+            resource_path='/settings/{settingId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ create_setting(setting_body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Create Setting

+

Create a new setting in the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_body + SettingBody + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
 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
@validate_call
+def create_setting(
+    self,
+    setting_body: SettingBody,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Create Setting
+
+    Create a new setting in the database
+
+    :param setting_body: (required)
+    :type setting_body: SettingBody
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._create_setting_serialize(
+        setting_body=setting_body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ create_setting_with_http_info(setting_body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Create Setting

+

Create a new setting in the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_body + SettingBody + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
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
@validate_call
+def create_setting_with_http_info(
+    self,
+    setting_body: SettingBody,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Create Setting
+
+    Create a new setting in the database
+
+    :param setting_body: (required)
+    :type setting_body: SettingBody
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._create_setting_serialize(
+        setting_body=setting_body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ create_setting_without_preload_content(setting_body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Create Setting

+

Create a new setting in the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_body + SettingBody + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
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
@validate_call
+def create_setting_without_preload_content(
+    self,
+    setting_body: SettingBody,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Create Setting
+
+    Create a new setting in the database
+
+    :param setting_body: (required)
+    :type setting_body: SettingBody
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._create_setting_serialize(
+        setting_body=setting_body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ delete_setting(setting_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Delete Setting

+

Delete a specific setting in the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
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
@validate_call
+def delete_setting(
+    self,
+    setting_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Delete Setting
+
+    Delete a specific setting in the database
+
+    :param setting_id: (required)
+    :type setting_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._delete_setting_serialize(
+        setting_id=setting_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ delete_setting_with_http_info(setting_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Delete Setting

+

Delete a specific setting in the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
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
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
@validate_call
+def delete_setting_with_http_info(
+    self,
+    setting_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Delete Setting
+
+    Delete a specific setting in the database
+
+    :param setting_id: (required)
+    :type setting_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._delete_setting_serialize(
+        setting_id=setting_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ delete_setting_without_preload_content(setting_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Delete Setting

+

Delete a specific setting in the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
+512
+513
+514
+515
+516
+517
+518
+519
+520
+521
+522
+523
+524
+525
+526
+527
@validate_call
+def delete_setting_without_preload_content(
+    self,
+    setting_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Delete Setting
+
+    Delete a specific setting in the database
+
+    :param setting_id: (required)
+    :type setting_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._delete_setting_serialize(
+        setting_id=setting_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ get_setting(setting_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Setting

+

Get the a specific setting from the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
@validate_call
+def get_setting(
+    self,
+    setting_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Setting
+
+    Get the a specific setting from the database
+
+    :param setting_id: (required)
+    :type setting_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_setting_serialize(
+        setting_id=setting_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_setting_with_http_info(setting_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Setting

+

Get the a specific setting from the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
@validate_call
+def get_setting_with_http_info(
+    self,
+    setting_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Setting
+
+    Get the a specific setting from the database
+
+    :param setting_id: (required)
+    :type setting_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_setting_serialize(
+        setting_id=setting_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_setting_without_preload_content(setting_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Setting

+

Get the a specific setting from the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_id + StrictStr + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
+742
+743
+744
+745
+746
+747
+748
+749
+750
+751
+752
+753
+754
+755
+756
+757
+758
+759
+760
+761
+762
+763
+764
+765
+766
+767
+768
+769
+770
+771
+772
+773
+774
+775
+776
+777
+778
+779
+780
+781
+782
+783
+784
+785
+786
+787
+788
+789
+790
+791
@validate_call
+def get_setting_without_preload_content(
+    self,
+    setting_id: StrictStr,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Setting
+
+    Get the a specific setting from the database
+
+    :param setting_id: (required)
+    :type setting_id: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_setting_serialize(
+        setting_id=setting_id,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ get_settings(search=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Settings

+

Get the entire list of settings available in the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
search + Optional[StrictStr] + +
+ +
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
855
+856
+857
+858
+859
+860
+861
+862
+863
+864
+865
+866
+867
+868
+869
+870
+871
+872
+873
+874
+875
+876
+877
+878
+879
+880
+881
+882
+883
+884
+885
+886
+887
+888
+889
+890
+891
+892
+893
+894
+895
+896
+897
+898
+899
+900
+901
+902
+903
+904
+905
+906
+907
+908
+909
+910
+911
+912
+913
+914
+915
+916
+917
+918
+919
+920
+921
@validate_call
+def get_settings(
+    self,
+    search: Optional[StrictStr] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Get Settings
+
+    Get the entire list of settings available in the database
+
+    :param search:
+    :type search: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_settings_serialize(
+        search=search,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ get_settings_with_http_info(search=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Settings

+

Get the entire list of settings available in the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
search + Optional[StrictStr] + +
+ +
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
924
+925
+926
+927
+928
+929
+930
+931
+932
+933
+934
+935
+936
+937
+938
+939
+940
+941
+942
+943
+944
+945
+946
+947
+948
+949
+950
+951
+952
+953
+954
+955
+956
+957
+958
+959
+960
+961
+962
+963
+964
+965
+966
+967
+968
+969
+970
+971
+972
+973
+974
+975
+976
+977
+978
+979
+980
+981
+982
+983
+984
+985
+986
+987
+988
+989
+990
@validate_call
+def get_settings_with_http_info(
+    self,
+    search: Optional[StrictStr] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Get Settings
+
+    Get the entire list of settings available in the database
+
+    :param search:
+    :type search: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_settings_serialize(
+        search=search,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ get_settings_without_preload_content(search=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Get Settings

+

Get the entire list of settings available in the database

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
search + Optional[StrictStr] + +
+ +
+ 		+ None +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
@validate_call
+def get_settings_without_preload_content(
+    self,
+    search: Optional[StrictStr] = None,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Get Settings
+
+    Get the entire list of settings available in the database
+
+    :param search:
+    :type search: str
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._get_settings_serialize(
+        search=search,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ +
+ + +

+ update_setting(setting_id, setting_body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Update Setting

+

Update a specific setting in the database if it exists

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_id + StrictStr + +
+

(required)

+
+ 		+ required +
setting_body + SettingBody + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
1121
+1122
+1123
+1124
+1125
+1126
+1127
+1128
+1129
+1130
+1131
+1132
+1133
+1134
+1135
+1136
+1137
+1138
+1139
+1140
+1141
+1142
+1143
+1144
+1145
+1146
+1147
+1148
+1149
+1150
+1151
+1152
+1153
+1154
+1155
+1156
+1157
+1158
+1159
+1160
+1161
+1162
+1163
+1164
+1165
+1166
+1167
+1168
+1169
+1170
+1171
+1172
+1173
+1174
+1175
+1176
+1177
+1178
+1179
+1180
+1181
+1182
+1183
+1184
+1185
+1186
+1187
+1188
+1189
+1190
+1191
@validate_call
+def update_setting(
+    self,
+    setting_id: StrictStr,
+    setting_body: SettingBody,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Update Setting
+
+    Update a specific setting in the database if it exists
+
+    :param setting_id: (required)
+    :type setting_id: str
+    :param setting_body: (required)
+    :type setting_body: SettingBody
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._update_setting_serialize(
+        setting_id=setting_id,
+        setting_body=setting_body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ update_setting_with_http_info(setting_id, setting_body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Update Setting

+

Update a specific setting in the database if it exists

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_id + StrictStr + +
+

(required)

+
+ 		+ required +
setting_body + SettingBody + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
1194
+1195
+1196
+1197
+1198
+1199
+1200
+1201
+1202
+1203
+1204
+1205
+1206
+1207
+1208
+1209
+1210
+1211
+1212
+1213
+1214
+1215
+1216
+1217
+1218
+1219
+1220
+1221
+1222
+1223
+1224
+1225
+1226
+1227
+1228
+1229
+1230
+1231
+1232
+1233
+1234
+1235
+1236
+1237
+1238
+1239
+1240
+1241
+1242
+1243
+1244
+1245
+1246
+1247
+1248
+1249
+1250
+1251
+1252
+1253
+1254
+1255
+1256
+1257
+1258
+1259
+1260
+1261
+1262
+1263
+1264
@validate_call
+def update_setting_with_http_info(
+    self,
+    setting_id: StrictStr,
+    setting_body: SettingBody,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Update Setting
+
+    Update a specific setting in the database if it exists
+
+    :param setting_id: (required)
+    :type setting_id: str
+    :param setting_body: (required)
+    :type setting_body: SettingBody
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._update_setting_serialize(
+        setting_id=setting_id,
+        setting_body=setting_body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ update_setting_without_preload_content(setting_id, setting_body, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Update Setting

+

Update a specific setting in the database if it exists

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
setting_id + StrictStr + +
+

(required)

+
+ 		+ required +
setting_body + SettingBody + +
+

(required)

+
+ 		+ required +
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/settings_api.py + 
1267
+1268
+1269
+1270
+1271
+1272
+1273
+1274
+1275
+1276
+1277
+1278
+1279
+1280
+1281
+1282
+1283
+1284
+1285
+1286
+1287
+1288
+1289
+1290
+1291
+1292
+1293
+1294
+1295
+1296
+1297
+1298
+1299
+1300
+1301
+1302
+1303
+1304
+1305
+1306
+1307
+1308
+1309
+1310
+1311
+1312
+1313
+1314
+1315
+1316
+1317
+1318
+1319
+1320
+1321
+1322
+1323
+1324
+1325
+1326
+1327
+1328
+1329
+1330
+1331
+1332
+1333
@validate_call
+def update_setting_without_preload_content(
+    self,
+    setting_id: StrictStr,
+    setting_body: SettingBody,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Update Setting
+
+    Update a specific setting in the database if it exists
+
+    :param setting_id: (required)
+    :type setting_id: str
+    :param setting_body: (required)
+    :type setting_body: SettingBody
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._update_setting_serialize(
+        setting_id=setting_id,
+        setting_body=setting_body,
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object",
+        '422': "HTTPValidationError"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/api/status_api/index.html b/API_Documentation/api/status_api/index.html new file mode 100644 index 0000000..ac2e13c --- /dev/null +++ b/API_Documentation/api/status_api/index.html @@ -0,0 +1,2593 @@ + + + + + + + + + + + + + + + + + + + + + + + status_api - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

status_api

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ StatusApi + + +

+ + +
+ + +

NOTE: This class is auto generated by OpenAPI Generator +Ref: https://openapi-generator.tech

+

Do not edit the class manually.

+ +
+ Source code in cheshire_cat_api/api/status_api.py + 
 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
class StatusApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def home(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> object:
+        """Home
+
+        Server status
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._home_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def home_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[object]:
+        """Home
+
+        Server status
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._home_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def home_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Home
+
+        Server status
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._home_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "object"
+
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _home_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ home(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Home

+

Server status

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ object + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/status_api.py + 
 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
@validate_call
+def home(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> object:
+    """Home
+
+    Server status
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._home_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    ).data
+
+
+
+ +
+ +
+ + +

+ home_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Home

+

Server status

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse[object] + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/status_api.py + 
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
@validate_call
+def home_with_http_info(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> ApiResponse[object]:
+    """Home
+
+    Server status
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._home_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    response_data.read()
+    return self.api_client.response_deserialize(
+        response_data=response_data,
+        response_types_map=_response_types_map,
+    )
+
+
+
+ +
+ +
+ + +

+ home_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0) + +

+ + +
+ +

Home

+

Server status

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_request_timeout + Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
_request_auth + Optional[Dict[StrictStr, Any]] + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
_content_type + Optional[StrictStr] + +
+

force content-type for the request.

+
+ 		+ None +
_headers + Optional[Dict[StrictStr, Any]] + +
+

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

+
+ 		+ None +
_host_index + Annotated[StrictInt, Field(ge=0, le=0)] + +
+

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponseType + +
+

Returns the result object.

+
+
+ +
+ Source code in cheshire_cat_api/api/status_api.py + 
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
@validate_call
+def home_without_preload_content(
+    self,
+    _request_timeout: Union[
+        None,
+        Annotated[StrictFloat, Field(gt=0)],
+        Tuple[
+            Annotated[StrictFloat, Field(gt=0)],
+            Annotated[StrictFloat, Field(gt=0)]
+        ]
+    ] = None,
+    _request_auth: Optional[Dict[StrictStr, Any]] = None,
+    _content_type: Optional[StrictStr] = None,
+    _headers: Optional[Dict[StrictStr, Any]] = None,
+    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+) -> RESTResponseType:
+    """Home
+
+    Server status
+
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    :type _request_timeout: int, tuple(int, int), optional
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the
+                          authentication in the spec for a single request.
+    :type _request_auth: dict, optional
+    :param _content_type: force content-type for the request.
+    :type _content_type: str, Optional
+    :param _headers: set to override the headers for a single
+                     request; this effectively ignores the headers
+                     in the spec for a single request.
+    :type _headers: dict, optional
+    :param _host_index: set to override the host_index for a single
+                        request; this effectively ignores the host_index
+                        in the spec for a single request.
+    :type _host_index: int, optional
+    :return: Returns the result object.
+    """ # noqa: E501
+
+    _param = self._home_serialize(
+        _request_auth=_request_auth,
+        _content_type=_content_type,
+        _headers=_headers,
+        _host_index=_host_index
+    )
+
+    _response_types_map: Dict[str, Optional[str]] = {
+        '200': "object"
+
+    }
+    response_data = self.api_client.call_api(
+        *_param,
+        _request_timeout=_request_timeout
+    )
+    return response_data.response
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/api_client/index.html b/API_Documentation/api_client/index.html new file mode 100644 index 0000000..845e93f --- /dev/null +++ b/API_Documentation/api_client/index.html @@ -0,0 +1,5951 @@ + + + + + + + + + + + + + + + + + + + + + + + api_client - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

api_client

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ ApiClient + + +

+ + +
+ + +

Generic API client for OpenAPI client library builds.

+

OpenAPI generic API client. This client handles the client- +server communication, and is invariant across implementations. Specifics of +the methods and models for each application are generated from the OpenAPI +templates.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
configuration + +
+

.Configuration object for this client

+
+ 		+ None +
header_name + +
+

a header to pass when making calls to the API.

+
+ 		+ None +
header_value + +
+

a header value to pass when making calls to the API.

+
+ 		+ None +
cookie + +
+

a cookie to include in the header when making calls to the API

+
+ 		+ None +
+ +
+ Source code in cheshire_cat_api/api_client.py + 
 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
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
+509
+510
+511
+512
+513
+514
+515
+516
+517
+518
+519
+520
+521
+522
+523
+524
+525
+526
+527
+528
+529
+530
+531
+532
+533
+534
+535
+536
+537
+538
+539
+540
+541
+542
+543
+544
+545
+546
+547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
+635
+636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
+688
+689
+690
+691
+692
+693
+694
+695
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
+711
+712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
+732
+733
+734
+735
+736
+737
+738
+739
+740
+741
class ApiClient:
+    """Generic API client for OpenAPI client library builds.
+
+    OpenAPI generic API client. This client handles the client-
+    server communication, and is invariant across implementations. Specifics of
+    the methods and models for each application are generated from the OpenAPI
+    templates.
+
+    :param configuration: .Configuration object for this client
+    :param header_name: a header to pass when making calls to the API.
+    :param header_value: a header value to pass when making calls to
+        the API.
+    :param cookie: a cookie to include in the header when making calls
+        to the API
+    """
+
+    PRIMITIVE_TYPES = (float, bool, bytes, str, int)
+    NATIVE_TYPES_MAPPING = {
+        'int': int,
+        'long': int, # TODO remove as only py3 is supported?
+        'float': float,
+        'str': str,
+        'bool': bool,
+        'date': datetime.date,
+        'datetime': datetime.datetime,
+        'object': object,
+    }
+    _pool = None
+
+    def __init__(
+        self,
+        configuration=None,
+        header_name=None,
+        header_value=None,
+        cookie=None
+    ) -> None:
+        # use default configuration if none is provided
+        if configuration is None:
+            configuration = Configuration.get_default()
+        self.configuration = configuration
+
+        self.rest_client = rest.RESTClientObject(configuration)
+        self.default_headers = {}
+        if header_name is not None:
+            self.default_headers[header_name] = header_value
+        self.cookie = cookie
+        # Set default User-Agent.
+        self.user_agent = 'OpenAPI-Generator/1.0.0/python'
+        self.client_side_validation = configuration.client_side_validation
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        pass
+
+    @property
+    def user_agent(self):
+        """User agent for this API client"""
+        return self.default_headers['User-Agent']
+
+    @user_agent.setter
+    def user_agent(self, value):
+        self.default_headers['User-Agent'] = value
+
+    def set_default_header(self, header_name, header_value):
+        self.default_headers[header_name] = header_value
+
+
+    _default = None
+
+    @classmethod
+    def get_default(cls):
+        """Return new instance of ApiClient.
+
+        This method returns newly created, based on default constructor,
+        object of ApiClient class or returns a copy of default
+        ApiClient.
+
+        :return: The ApiClient object.
+        """
+        if cls._default is None:
+            cls._default = ApiClient()
+        return cls._default
+
+    @classmethod
+    def set_default(cls, default):
+        """Set default instance of ApiClient.
+
+        It stores default ApiClient.
+
+        :param default: object of ApiClient.
+        """
+        cls._default = default
+
+    def param_serialize(
+        self,
+        method,
+        resource_path,
+        path_params=None,
+        query_params=None,
+        header_params=None,
+        body=None,
+        post_params=None,
+        files=None, auth_settings=None,
+        collection_formats=None,
+        _host=None,
+        _request_auth=None
+    ) -> Tuple:
+
+        """Builds the HTTP request params needed by the request.
+        :param method: Method to call.
+        :param resource_path: Path to method endpoint.
+        :param path_params: Path parameters in the url.
+        :param query_params: Query parameters in the url.
+        :param header_params: Header parameters to be
+            placed in the request header.
+        :param body: Request body.
+        :param post_params dict: Request post form parameters,
+            for `application/x-www-form-urlencoded`, `multipart/form-data`.
+        :param auth_settings list: Auth Settings names for the request.
+        :param files dict: key -> filename, value -> filepath,
+            for `multipart/form-data`.
+        :param collection_formats: dict of collection formats for path, query,
+            header, and post parameters.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :return: tuple of form (path, http_method, query_params, header_params,
+            body, post_params, files)
+        """
+
+        config = self.configuration
+
+        # header parameters
+        header_params = header_params or {}
+        header_params.update(self.default_headers)
+        if self.cookie:
+            header_params['Cookie'] = self.cookie
+        if header_params:
+            header_params = self.sanitize_for_serialization(header_params)
+            header_params = dict(
+                self.parameters_to_tuples(header_params,collection_formats)
+            )
+
+        # path parameters
+        if path_params:
+            path_params = self.sanitize_for_serialization(path_params)
+            path_params = self.parameters_to_tuples(
+                path_params,
+                collection_formats
+            )
+            for k, v in path_params:
+                # specified safe chars, encode everything
+                resource_path = resource_path.replace(
+                    '{%s}' % k,
+                    quote(str(v), safe=config.safe_chars_for_path_param)
+                )
+
+        # post parameters
+        if post_params or files:
+            post_params = post_params if post_params else []
+            post_params = self.sanitize_for_serialization(post_params)
+            post_params = self.parameters_to_tuples(
+                post_params,
+                collection_formats
+            )
+            post_params.extend(self.files_parameters(files))
+
+        # auth setting
+        self.update_params_for_auth(
+            header_params,
+            query_params,
+            auth_settings,
+            resource_path,
+            method,
+            body,
+            request_auth=_request_auth
+        )
+
+        # body
+        if body:
+            body = self.sanitize_for_serialization(body)
+
+        # request url
+        if _host is None:
+            url = self.configuration.host + resource_path
+        else:
+            # use server/host defined in path or operation instead
+            url = _host + resource_path
+
+        # query parameters
+        if query_params:
+            query_params = self.sanitize_for_serialization(query_params)
+            url_query = self.parameters_to_url_query(
+                query_params,
+                collection_formats
+            )
+            url += "?" + url_query
+
+        return method, url, header_params, body, post_params
+
+
+    def call_api(
+        self,
+        method,
+        url,
+        header_params=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ) -> rest.RESTResponse:
+        """Makes the HTTP request (synchronous)
+        :param method: Method to call.
+        :param url: Path to method endpoint.
+        :param header_params: Header parameters to be
+            placed in the request header.
+        :param body: Request body.
+        :param post_params dict: Request post form parameters,
+            for `application/x-www-form-urlencoded`, `multipart/form-data`.
+        :param _request_timeout: timeout setting for this request.
+        :return: RESTResponse
+        """
+
+        try:
+            # perform request and return response
+            response_data = self.rest_client.request(
+                method, url,
+                headers=header_params,
+                body=body, post_params=post_params,
+                _request_timeout=_request_timeout
+            )
+
+        except ApiException as e:
+            if e.body:
+                e.body = e.body.decode('utf-8')
+            raise e
+
+        return response_data
+
+    def response_deserialize(
+        self,
+        response_data=None,
+        response_types_map=None
+    ) -> ApiResponse:
+        """Deserializes response into an object.
+        :param response_data: RESTResponse object to be deserialized.
+        :param response_types_map: dict of response types.
+        :return: ApiResponse
+        """
+
+
+        response_type = response_types_map.get(str(response_data.status), None)
+        if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599:
+            # if not found, look for '1XX', '2XX', etc.
+            response_type = response_types_map.get(str(response_data.status)[0] + "XX", None)
+
+        if not 200 <= response_data.status <= 299:
+            if response_data.status == 400:
+                raise BadRequestException(http_resp=response_data)
+
+            if response_data.status == 401:
+                raise UnauthorizedException(http_resp=response_data)
+
+            if response_data.status == 403:
+                raise ForbiddenException(http_resp=response_data)
+
+            if response_data.status == 404:
+                raise NotFoundException(http_resp=response_data)
+
+            if 500 <= response_data.status <= 599:
+                raise ServiceException(http_resp=response_data)
+            raise ApiException(http_resp=response_data)
+
+        # deserialize response data
+
+        if response_type == "bytearray":
+            return_data = response_data.data
+        elif response_type is None:
+            return_data = None
+        elif response_type == "file":
+            return_data = self.__deserialize_file(response_data)
+        else:
+            match = None
+            content_type = response_data.getheader('content-type')
+            if content_type is not None:
+                match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type)
+            encoding = match.group(1) if match else "utf-8"
+            response_text = response_data.data.decode(encoding)
+            return_data = self.deserialize(response_text, response_type)
+
+        return ApiResponse(
+            status_code = response_data.status,
+            data = return_data,
+            headers = response_data.getheaders(),
+            raw_data = response_data.data
+        )
+
+    def sanitize_for_serialization(self, obj):
+        """Builds a JSON POST object.
+
+        If obj is None, return None.
+        If obj is str, int, long, float, bool, return directly.
+        If obj is datetime.datetime, datetime.date
+            convert to string in iso8601 format.
+        If obj is list, sanitize each element in the list.
+        If obj is dict, return the dict.
+        If obj is OpenAPI model, return the properties dict.
+
+        :param obj: The data to serialize.
+        :return: The serialized form of data.
+        """
+        if obj is None:
+            return None
+        elif isinstance(obj, self.PRIMITIVE_TYPES):
+            return obj
+        elif isinstance(obj, list):
+            return [
+                self.sanitize_for_serialization(sub_obj) for sub_obj in obj
+            ]
+        elif isinstance(obj, tuple):
+            return tuple(
+                self.sanitize_for_serialization(sub_obj) for sub_obj in obj
+            )
+        elif isinstance(obj, (datetime.datetime, datetime.date)):
+            return obj.isoformat()
+
+        elif isinstance(obj, dict):
+            obj_dict = obj
+        else:
+            # Convert model obj to dict except
+            # attributes `openapi_types`, `attribute_map`
+            # and attributes which value is not None.
+            # Convert attribute name to json key in
+            # model definition for request.
+            obj_dict = obj.to_dict()
+
+        return {
+            key: self.sanitize_for_serialization(val)
+            for key, val in obj_dict.items()
+        }
+
+    def deserialize(self, response_text, response_type):
+        """Deserializes response into an object.
+
+        :param response: RESTResponse object to be deserialized.
+        :param response_type: class literal for
+            deserialized object, or string of class name.
+
+        :return: deserialized object.
+        """
+
+        # fetch data from response object
+        try:
+            data = json.loads(response_text)
+        except ValueError:
+            data = response_text
+
+        return self.__deserialize(data, response_type)
+
+    def __deserialize(self, data, klass):
+        """Deserializes dict, list, str into an object.
+
+        :param data: dict, list or str.
+        :param klass: class literal, or string of class name.
+
+        :return: object.
+        """
+        if data is None:
+            return None
+
+        if isinstance(klass, str):
+            if klass.startswith('List['):
+                sub_kls = re.match(r'List\[(.*)]', klass).group(1)
+                return [self.__deserialize(sub_data, sub_kls)
+                        for sub_data in data]
+
+            if klass.startswith('Dict['):
+                sub_kls = re.match(r'Dict\[([^,]*), (.*)]', klass).group(2)
+                return {k: self.__deserialize(v, sub_kls)
+                        for k, v in data.items()}
+
+            # convert str to class
+            if klass in self.NATIVE_TYPES_MAPPING:
+                klass = self.NATIVE_TYPES_MAPPING[klass]
+            else:
+                klass = getattr(cheshire_cat_api.models, klass)
+
+        if klass in self.PRIMITIVE_TYPES:
+            return self.__deserialize_primitive(data, klass)
+        elif klass == object:
+            return self.__deserialize_object(data)
+        elif klass == datetime.date:
+            return self.__deserialize_date(data)
+        elif klass == datetime.datetime:
+            return self.__deserialize_datetime(data)
+        else:
+            return self.__deserialize_model(data, klass)
+
+    def parameters_to_tuples(self, params, collection_formats):
+        """Get parameters as list of tuples, formatting collections.
+
+        :param params: Parameters as dict or list of two-tuples
+        :param dict collection_formats: Parameter collection formats
+        :return: Parameters as list of tuples, collections formatted
+        """
+        new_params = []
+        if collection_formats is None:
+            collection_formats = {}
+        for k, v in params.items() if isinstance(params, dict) else params:
+            if k in collection_formats:
+                collection_format = collection_formats[k]
+                if collection_format == 'multi':
+                    new_params.extend((k, value) for value in v)
+                else:
+                    if collection_format == 'ssv':
+                        delimiter = ' '
+                    elif collection_format == 'tsv':
+                        delimiter = '\t'
+                    elif collection_format == 'pipes':
+                        delimiter = '|'
+                    else:  # csv is the default
+                        delimiter = ','
+                    new_params.append(
+                        (k, delimiter.join(str(value) for value in v)))
+            else:
+                new_params.append((k, v))
+        return new_params
+
+    def parameters_to_url_query(self, params, collection_formats):
+        """Get parameters as list of tuples, formatting collections.
+
+        :param params: Parameters as dict or list of two-tuples
+        :param dict collection_formats: Parameter collection formats
+        :return: URL query string (e.g. a=Hello%20World&b=123)
+        """
+        new_params = []
+        if collection_formats is None:
+            collection_formats = {}
+        for k, v in params.items() if isinstance(params, dict) else params:
+            if isinstance(v, bool):
+                v = str(v).lower()
+            if isinstance(v, (int, float)):
+                v = str(v)
+            if isinstance(v, dict):
+                v = json.dumps(v)
+
+            if k in collection_formats:
+                collection_format = collection_formats[k]
+                if collection_format == 'multi':
+                    new_params.extend((k, value) for value in v)
+                else:
+                    if collection_format == 'ssv':
+                        delimiter = ' '
+                    elif collection_format == 'tsv':
+                        delimiter = '\t'
+                    elif collection_format == 'pipes':
+                        delimiter = '|'
+                    else:  # csv is the default
+                        delimiter = ','
+                    new_params.append(
+                        (k, delimiter.join(quote(str(value)) for value in v))
+                    )
+            else:
+                new_params.append((k, quote(str(v))))
+
+        return "&".join(["=".join(item) for item in new_params])
+
+    def files_parameters(self, files=None):
+        """Builds form parameters.
+
+        :param files: File parameters.
+        :return: Form parameters with files.
+        """
+        params = []
+
+        if files:
+            for k, v in files.items():
+                if not v:
+                    continue
+                file_names = v if type(v) is list else [v]
+                for n in file_names:
+                    with open(n, 'rb') as f:
+                        filename = os.path.basename(f.name)
+                        filedata = f.read()
+                        mimetype = (
+                            mimetypes.guess_type(filename)[0]
+                            or 'application/octet-stream'
+                        )
+                        params.append(
+                            tuple([k, tuple([filename, filedata, mimetype])])
+                        )
+
+        return params
+
+    def select_header_accept(self, accepts: List[str]) -> Optional[str]:
+        """Returns `Accept` based on an array of accepts provided.
+
+        :param accepts: List of headers.
+        :return: Accept (e.g. application/json).
+        """
+        if not accepts:
+            return None
+
+        for accept in accepts:
+            if re.search('json', accept, re.IGNORECASE):
+                return accept
+
+        return accepts[0]
+
+    def select_header_content_type(self, content_types):
+        """Returns `Content-Type` based on an array of content_types provided.
+
+        :param content_types: List of content-types.
+        :return: Content-Type (e.g. application/json).
+        """
+        if not content_types:
+            return None
+
+        for content_type in content_types:
+            if re.search('json', content_type, re.IGNORECASE):
+                return content_type
+
+        return content_types[0]
+
+    def update_params_for_auth(
+        self,
+        headers,
+        queries,
+        auth_settings,
+        resource_path,
+        method,
+        body,
+        request_auth=None
+    ) -> None:
+        """Updates header and query params based on authentication setting.
+
+        :param headers: Header parameters dict to be updated.
+        :param queries: Query parameters tuple list to be updated.
+        :param auth_settings: Authentication setting identifiers list.
+        :resource_path: A string representation of the HTTP request resource path.
+        :method: A string representation of the HTTP request method.
+        :body: A object representing the body of the HTTP request.
+        The object type is the return value of sanitize_for_serialization().
+        :param request_auth: if set, the provided settings will
+                             override the token in the configuration.
+        """
+        if not auth_settings:
+            return
+
+        if request_auth:
+            self._apply_auth_params(
+                headers,
+                queries,
+                resource_path,
+                method,
+                body,
+                request_auth
+            )
+        else:
+            for auth in auth_settings:
+                auth_setting = self.configuration.auth_settings().get(auth)
+                if auth_setting:
+                    self._apply_auth_params(
+                        headers,
+                        queries,
+                        resource_path,
+                        method,
+                        body,
+                        auth_setting
+                    )
+
+    def _apply_auth_params(
+        self,
+        headers,
+        queries,
+        resource_path,
+        method,
+        body,
+        auth_setting
+    ) -> None:
+        """Updates the request parameters based on a single auth_setting
+
+        :param headers: Header parameters dict to be updated.
+        :param queries: Query parameters tuple list to be updated.
+        :resource_path: A string representation of the HTTP request resource path.
+        :method: A string representation of the HTTP request method.
+        :body: A object representing the body of the HTTP request.
+        The object type is the return value of sanitize_for_serialization().
+        :param auth_setting: auth settings for the endpoint
+        """
+        if auth_setting['in'] == 'cookie':
+            headers['Cookie'] = auth_setting['value']
+        elif auth_setting['in'] == 'header':
+            if auth_setting['type'] != 'http-signature':
+                headers[auth_setting['key']] = auth_setting['value']
+        elif auth_setting['in'] == 'query':
+            queries.append((auth_setting['key'], auth_setting['value']))
+        else:
+            raise ApiValueError(
+                'Authentication token must be in `query` or `header`'
+            )
+
+    def __deserialize_file(self, response):
+        """Deserializes body to file
+
+        Saves response body into a file in a temporary folder,
+        using the filename from the `Content-Disposition` header if provided.
+
+        handle file downloading
+        save response body into a tmp file and return the instance
+
+        :param response:  RESTResponse.
+        :return: file path.
+        """
+        fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path)
+        os.close(fd)
+        os.remove(path)
+
+        content_disposition = response.getheader("Content-Disposition")
+        if content_disposition:
+            filename = re.search(
+                r'filename=[\'"]?([^\'"\s]+)[\'"]?',
+                content_disposition
+            ).group(1)
+            path = os.path.join(os.path.dirname(path), filename)
+
+        with open(path, "wb") as f:
+            f.write(response.data)
+
+        return path
+
+    def __deserialize_primitive(self, data, klass):
+        """Deserializes string to primitive type.
+
+        :param data: str.
+        :param klass: class literal.
+
+        :return: int, long, float, str, bool.
+        """
+        try:
+            return klass(data)
+        except UnicodeEncodeError:
+            return str(data)
+        except TypeError:
+            return data
+
+    def __deserialize_object(self, value):
+        """Return an original value.
+
+        :return: object.
+        """
+        return value
+
+    def __deserialize_date(self, string):
+        """Deserializes string to date.
+
+        :param string: str.
+        :return: date.
+        """
+        try:
+            return parse(string).date()
+        except ImportError:
+            return string
+        except ValueError:
+            raise rest.ApiException(
+                status=0,
+                reason="Failed to parse `{0}` as date object".format(string)
+            )
+
+    def __deserialize_datetime(self, string):
+        """Deserializes string to datetime.
+
+        The string should be in iso8601 datetime format.
+
+        :param string: str.
+        :return: datetime.
+        """
+        try:
+            return parse(string)
+        except ImportError:
+            return string
+        except ValueError:
+            raise rest.ApiException(
+                status=0,
+                reason=(
+                    "Failed to parse `{0}` as datetime object"
+                    .format(string)
+                )
+            )
+
+    def __deserialize_model(self, data, klass):
+        """Deserializes list or dict to model.
+
+        :param data: dict, list.
+        :param klass: class literal.
+        :return: model object.
+        """
+
+        return klass.from_dict(data)
+
+
+ + + +
+ + + + + + + +
+ + + +

+ user_agent + + + property + writable + + +

+ + +
+ +

User agent for this API client

+
+ +
+ + + +
+ + +

+ __deserialize(data, klass) + +

+ + +
+ +

Deserializes dict, list, str into an object.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
data + +
+

dict, list or str.

+
+ 		+ required +
klass + +
+

class literal, or string of class name.

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

object.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
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
def __deserialize(self, data, klass):
+    """Deserializes dict, list, str into an object.
+
+    :param data: dict, list or str.
+    :param klass: class literal, or string of class name.
+
+    :return: object.
+    """
+    if data is None:
+        return None
+
+    if isinstance(klass, str):
+        if klass.startswith('List['):
+            sub_kls = re.match(r'List\[(.*)]', klass).group(1)
+            return [self.__deserialize(sub_data, sub_kls)
+                    for sub_data in data]
+
+        if klass.startswith('Dict['):
+            sub_kls = re.match(r'Dict\[([^,]*), (.*)]', klass).group(2)
+            return {k: self.__deserialize(v, sub_kls)
+                    for k, v in data.items()}
+
+        # convert str to class
+        if klass in self.NATIVE_TYPES_MAPPING:
+            klass = self.NATIVE_TYPES_MAPPING[klass]
+        else:
+            klass = getattr(cheshire_cat_api.models, klass)
+
+    if klass in self.PRIMITIVE_TYPES:
+        return self.__deserialize_primitive(data, klass)
+    elif klass == object:
+        return self.__deserialize_object(data)
+    elif klass == datetime.date:
+        return self.__deserialize_date(data)
+    elif klass == datetime.datetime:
+        return self.__deserialize_datetime(data)
+    else:
+        return self.__deserialize_model(data, klass)
+
+
+
+ +
+ +
+ + +

+ __deserialize_date(string) + +

+ + +
+ +

Deserializes string to date.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
string + +
+

str.

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

date.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708
+709
+710
def __deserialize_date(self, string):
+    """Deserializes string to date.
+
+    :param string: str.
+    :return: date.
+    """
+    try:
+        return parse(string).date()
+    except ImportError:
+        return string
+    except ValueError:
+        raise rest.ApiException(
+            status=0,
+            reason="Failed to parse `{0}` as date object".format(string)
+        )
+
+
+
+ +
+ +
+ + +

+ __deserialize_datetime(string) + +

+ + +
+ +

Deserializes string to datetime.

+

The string should be in iso8601 datetime format.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
string + +
+

str.

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

datetime.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
712
+713
+714
+715
+716
+717
+718
+719
+720
+721
+722
+723
+724
+725
+726
+727
+728
+729
+730
+731
def __deserialize_datetime(self, string):
+    """Deserializes string to datetime.
+
+    The string should be in iso8601 datetime format.
+
+    :param string: str.
+    :return: datetime.
+    """
+    try:
+        return parse(string)
+    except ImportError:
+        return string
+    except ValueError:
+        raise rest.ApiException(
+            status=0,
+            reason=(
+                "Failed to parse `{0}` as datetime object"
+                .format(string)
+            )
+        )
+
+
+
+ +
+ +
+ + +

+ __deserialize_file(response) + +

+ + +
+ +

Deserializes body to file

+

Saves response body into a file in a temporary folder, +using the filename from the Content-Disposition header if provided.

+

handle file downloading +save response body into a tmp file and return the instance

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
response + +
+

RESTResponse.

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

file path.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
def __deserialize_file(self, response):
+    """Deserializes body to file
+
+    Saves response body into a file in a temporary folder,
+    using the filename from the `Content-Disposition` header if provided.
+
+    handle file downloading
+    save response body into a tmp file and return the instance
+
+    :param response:  RESTResponse.
+    :return: file path.
+    """
+    fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path)
+    os.close(fd)
+    os.remove(path)
+
+    content_disposition = response.getheader("Content-Disposition")
+    if content_disposition:
+        filename = re.search(
+            r'filename=[\'"]?([^\'"\s]+)[\'"]?',
+            content_disposition
+        ).group(1)
+        path = os.path.join(os.path.dirname(path), filename)
+
+    with open(path, "wb") as f:
+        f.write(response.data)
+
+    return path
+
+
+
+ +
+ +
+ + +

+ __deserialize_model(data, klass) + +

+ + +
+ +

Deserializes list or dict to model.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
data + +
+

dict, list.

+
+ 		+ required +
klass + +
+

class literal.

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

model object.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
733
+734
+735
+736
+737
+738
+739
+740
+741
def __deserialize_model(self, data, klass):
+    """Deserializes list or dict to model.
+
+    :param data: dict, list.
+    :param klass: class literal.
+    :return: model object.
+    """
+
+    return klass.from_dict(data)
+
+
+
+ +
+ +
+ + +

+ __deserialize_object(value) + +

+ + +
+ +

Return an original value.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

object.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
689
+690
+691
+692
+693
+694
def __deserialize_object(self, value):
+    """Return an original value.
+
+    :return: object.
+    """
+    return value
+
+
+
+ +
+ +
+ + +

+ __deserialize_primitive(data, klass) + +

+ + +
+ +

Deserializes string to primitive type.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
data + +
+

str.

+
+ 		+ required +
klass + +
+

class literal.

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

int, long, float, str, bool.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
674
+675
+676
+677
+678
+679
+680
+681
+682
+683
+684
+685
+686
+687
def __deserialize_primitive(self, data, klass):
+    """Deserializes string to primitive type.
+
+    :param data: str.
+    :param klass: class literal.
+
+    :return: int, long, float, str, bool.
+    """
+    try:
+        return klass(data)
+    except UnicodeEncodeError:
+        return str(data)
+    except TypeError:
+        return data
+
+
+
+ +
+ +
+ + +

+ call_api(method, url, header_params=None, body=None, post_params=None, _request_timeout=None) + +

+ + +
+ +

Makes the HTTP request (synchronous)

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
method + +
+

Method to call.

+
+ 		+ required +
url + +
+

Path to method endpoint.

+
+ 		+ required +
header_params + +
+

Header parameters to be placed in the request header.

+
+ 		+ None +
body + +
+

Request body.

+
+ 		+ None +
dict + post_params + +
+

Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.

+
+ 		+ required +
_request_timeout + +
+

timeout setting for this request.

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ RESTResponse + +
+

RESTResponse

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
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
def call_api(
+    self,
+    method,
+    url,
+    header_params=None,
+    body=None,
+    post_params=None,
+    _request_timeout=None
+) -> rest.RESTResponse:
+    """Makes the HTTP request (synchronous)
+    :param method: Method to call.
+    :param url: Path to method endpoint.
+    :param header_params: Header parameters to be
+        placed in the request header.
+    :param body: Request body.
+    :param post_params dict: Request post form parameters,
+        for `application/x-www-form-urlencoded`, `multipart/form-data`.
+    :param _request_timeout: timeout setting for this request.
+    :return: RESTResponse
+    """
+
+    try:
+        # perform request and return response
+        response_data = self.rest_client.request(
+            method, url,
+            headers=header_params,
+            body=body, post_params=post_params,
+            _request_timeout=_request_timeout
+        )
+
+    except ApiException as e:
+        if e.body:
+            e.body = e.body.decode('utf-8')
+        raise e
+
+    return response_data
+
+
+
+ +
+ +
+ + +

+ deserialize(response_text, response_type) + +

+ + +
+ +

Deserializes response into an object.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
response + +
+

RESTResponse object to be deserialized.

+
+ 		+ required +
response_type + +
+

class literal for deserialized object, or string of class name.

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

deserialized object.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
384
+385
+386
+387
+388
+389
+390
+391
+392
+393
+394
+395
+396
+397
+398
+399
+400
def deserialize(self, response_text, response_type):
+    """Deserializes response into an object.
+
+    :param response: RESTResponse object to be deserialized.
+    :param response_type: class literal for
+        deserialized object, or string of class name.
+
+    :return: deserialized object.
+    """
+
+    # fetch data from response object
+    try:
+        data = json.loads(response_text)
+    except ValueError:
+        data = response_text
+
+    return self.__deserialize(data, response_type)
+
+
+
+ +
+ +
+ + +

+ files_parameters(files=None) + +

+ + +
+ +

Builds form parameters.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
files + +
+

File parameters.

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

Form parameters with files.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
510
+511
+512
+513
+514
+515
+516
+517
+518
+519
+520
+521
+522
+523
+524
+525
+526
+527
+528
+529
+530
+531
+532
+533
+534
+535
def files_parameters(self, files=None):
+    """Builds form parameters.
+
+    :param files: File parameters.
+    :return: Form parameters with files.
+    """
+    params = []
+
+    if files:
+        for k, v in files.items():
+            if not v:
+                continue
+            file_names = v if type(v) is list else [v]
+            for n in file_names:
+                with open(n, 'rb') as f:
+                    filename = os.path.basename(f.name)
+                    filedata = f.read()
+                    mimetype = (
+                        mimetypes.guess_type(filename)[0]
+                        or 'application/octet-stream'
+                    )
+                    params.append(
+                        tuple([k, tuple([filename, filedata, mimetype])])
+                    )
+
+    return params
+
+
+
+ +
+ +
+ + +

+ get_default() + + + classmethod + + +

+ + +
+ +

Return new instance of ApiClient.

+

This method returns newly created, based on default constructor, +object of ApiClient class or returns a copy of default +ApiClient.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

The ApiClient object.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
@classmethod
+def get_default(cls):
+    """Return new instance of ApiClient.
+
+    This method returns newly created, based on default constructor,
+    object of ApiClient class or returns a copy of default
+    ApiClient.
+
+    :return: The ApiClient object.
+    """
+    if cls._default is None:
+        cls._default = ApiClient()
+    return cls._default
+
+
+
+ +
+ +
+ + +

+ param_serialize(method, resource_path, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, auth_settings=None, collection_formats=None, _host=None, _request_auth=None) + +

+ + +
+ +

Builds the HTTP request params needed by the request.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
method + +
+

Method to call.

+
+ 		+ required +
resource_path + +
+

Path to method endpoint.

+
+ 		+ required +
path_params + +
+

Path parameters in the url.

+
+ 		+ None +
query_params + +
+

Query parameters in the url.

+
+ 		+ None +
header_params + +
+

Header parameters to be placed in the request header.

+
+ 		+ None +
body + +
+

Request body.

+
+ 		+ None +
dict + post_params + +
+

Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.

+
+ 		+ required +
list + auth_settings + +
+

Auth Settings names for the request.

+
+ 		+ required +
collection_formats + +
+

dict of collection formats for path, query, header, and post parameters.

+
+ 		+ None +
_request_auth + +
+

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Tuple + +
+

tuple of form (path, http_method, query_params, header_params, body, post_params, files)

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
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
def param_serialize(
+    self,
+    method,
+    resource_path,
+    path_params=None,
+    query_params=None,
+    header_params=None,
+    body=None,
+    post_params=None,
+    files=None, auth_settings=None,
+    collection_formats=None,
+    _host=None,
+    _request_auth=None
+) -> Tuple:
+
+    """Builds the HTTP request params needed by the request.
+    :param method: Method to call.
+    :param resource_path: Path to method endpoint.
+    :param path_params: Path parameters in the url.
+    :param query_params: Query parameters in the url.
+    :param header_params: Header parameters to be
+        placed in the request header.
+    :param body: Request body.
+    :param post_params dict: Request post form parameters,
+        for `application/x-www-form-urlencoded`, `multipart/form-data`.
+    :param auth_settings list: Auth Settings names for the request.
+    :param files dict: key -> filename, value -> filepath,
+        for `multipart/form-data`.
+    :param collection_formats: dict of collection formats for path, query,
+        header, and post parameters.
+    :param _request_auth: set to override the auth_settings for an a single
+                          request; this effectively ignores the authentication
+                          in the spec for a single request.
+    :return: tuple of form (path, http_method, query_params, header_params,
+        body, post_params, files)
+    """
+
+    config = self.configuration
+
+    # header parameters
+    header_params = header_params or {}
+    header_params.update(self.default_headers)
+    if self.cookie:
+        header_params['Cookie'] = self.cookie
+    if header_params:
+        header_params = self.sanitize_for_serialization(header_params)
+        header_params = dict(
+            self.parameters_to_tuples(header_params,collection_formats)
+        )
+
+    # path parameters
+    if path_params:
+        path_params = self.sanitize_for_serialization(path_params)
+        path_params = self.parameters_to_tuples(
+            path_params,
+            collection_formats
+        )
+        for k, v in path_params:
+            # specified safe chars, encode everything
+            resource_path = resource_path.replace(
+                '{%s}' % k,
+                quote(str(v), safe=config.safe_chars_for_path_param)
+            )
+
+    # post parameters
+    if post_params or files:
+        post_params = post_params if post_params else []
+        post_params = self.sanitize_for_serialization(post_params)
+        post_params = self.parameters_to_tuples(
+            post_params,
+            collection_formats
+        )
+        post_params.extend(self.files_parameters(files))
+
+    # auth setting
+    self.update_params_for_auth(
+        header_params,
+        query_params,
+        auth_settings,
+        resource_path,
+        method,
+        body,
+        request_auth=_request_auth
+    )
+
+    # body
+    if body:
+        body = self.sanitize_for_serialization(body)
+
+    # request url
+    if _host is None:
+        url = self.configuration.host + resource_path
+    else:
+        # use server/host defined in path or operation instead
+        url = _host + resource_path
+
+    # query parameters
+    if query_params:
+        query_params = self.sanitize_for_serialization(query_params)
+        url_query = self.parameters_to_url_query(
+            query_params,
+            collection_formats
+        )
+        url += "?" + url_query
+
+    return method, url, header_params, body, post_params
+
+
+
+ +
+ +
+ + +

+ parameters_to_tuples(params, collection_formats) + +

+ + +
+ +

Get parameters as list of tuples, formatting collections.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
params + +
+

Parameters as dict or list of two-tuples

+
+ 		+ required +
collection_formats + dict + +
+

Parameter collection formats

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

Parameters as list of tuples, collections formatted

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
def parameters_to_tuples(self, params, collection_formats):
+    """Get parameters as list of tuples, formatting collections.
+
+    :param params: Parameters as dict or list of two-tuples
+    :param dict collection_formats: Parameter collection formats
+    :return: Parameters as list of tuples, collections formatted
+    """
+    new_params = []
+    if collection_formats is None:
+        collection_formats = {}
+    for k, v in params.items() if isinstance(params, dict) else params:
+        if k in collection_formats:
+            collection_format = collection_formats[k]
+            if collection_format == 'multi':
+                new_params.extend((k, value) for value in v)
+            else:
+                if collection_format == 'ssv':
+                    delimiter = ' '
+                elif collection_format == 'tsv':
+                    delimiter = '\t'
+                elif collection_format == 'pipes':
+                    delimiter = '|'
+                else:  # csv is the default
+                    delimiter = ','
+                new_params.append(
+                    (k, delimiter.join(str(value) for value in v)))
+        else:
+            new_params.append((k, v))
+    return new_params
+
+
+
+ +
+ +
+ + +

+ parameters_to_url_query(params, collection_formats) + +

+ + +
+ +

Get parameters as list of tuples, formatting collections.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
params + +
+

Parameters as dict or list of two-tuples

+
+ 		+ required +
collection_formats + dict + +
+

Parameter collection formats

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

URL query string (e.g. a=Hello%20World&b=123)

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
+507
+508
def parameters_to_url_query(self, params, collection_formats):
+    """Get parameters as list of tuples, formatting collections.
+
+    :param params: Parameters as dict or list of two-tuples
+    :param dict collection_formats: Parameter collection formats
+    :return: URL query string (e.g. a=Hello%20World&b=123)
+    """
+    new_params = []
+    if collection_formats is None:
+        collection_formats = {}
+    for k, v in params.items() if isinstance(params, dict) else params:
+        if isinstance(v, bool):
+            v = str(v).lower()
+        if isinstance(v, (int, float)):
+            v = str(v)
+        if isinstance(v, dict):
+            v = json.dumps(v)
+
+        if k in collection_formats:
+            collection_format = collection_formats[k]
+            if collection_format == 'multi':
+                new_params.extend((k, value) for value in v)
+            else:
+                if collection_format == 'ssv':
+                    delimiter = ' '
+                elif collection_format == 'tsv':
+                    delimiter = '\t'
+                elif collection_format == 'pipes':
+                    delimiter = '|'
+                else:  # csv is the default
+                    delimiter = ','
+                new_params.append(
+                    (k, delimiter.join(quote(str(value)) for value in v))
+                )
+        else:
+            new_params.append((k, quote(str(v))))
+
+    return "&".join(["=".join(item) for item in new_params])
+
+
+
+ +
+ +
+ + +

+ response_deserialize(response_data=None, response_types_map=None) + +

+ + +
+ +

Deserializes response into an object.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
response_data + +
+

RESTResponse object to be deserialized.

+
+ 		+ None +
response_types_map + +
+

dict of response types.

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ ApiResponse + +
+

ApiResponse

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
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
def response_deserialize(
+    self,
+    response_data=None,
+    response_types_map=None
+) -> ApiResponse:
+    """Deserializes response into an object.
+    :param response_data: RESTResponse object to be deserialized.
+    :param response_types_map: dict of response types.
+    :return: ApiResponse
+    """
+
+
+    response_type = response_types_map.get(str(response_data.status), None)
+    if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599:
+        # if not found, look for '1XX', '2XX', etc.
+        response_type = response_types_map.get(str(response_data.status)[0] + "XX", None)
+
+    if not 200 <= response_data.status <= 299:
+        if response_data.status == 400:
+            raise BadRequestException(http_resp=response_data)
+
+        if response_data.status == 401:
+            raise UnauthorizedException(http_resp=response_data)
+
+        if response_data.status == 403:
+            raise ForbiddenException(http_resp=response_data)
+
+        if response_data.status == 404:
+            raise NotFoundException(http_resp=response_data)
+
+        if 500 <= response_data.status <= 599:
+            raise ServiceException(http_resp=response_data)
+        raise ApiException(http_resp=response_data)
+
+    # deserialize response data
+
+    if response_type == "bytearray":
+        return_data = response_data.data
+    elif response_type is None:
+        return_data = None
+    elif response_type == "file":
+        return_data = self.__deserialize_file(response_data)
+    else:
+        match = None
+        content_type = response_data.getheader('content-type')
+        if content_type is not None:
+            match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type)
+        encoding = match.group(1) if match else "utf-8"
+        response_text = response_data.data.decode(encoding)
+        return_data = self.deserialize(response_text, response_type)
+
+    return ApiResponse(
+        status_code = response_data.status,
+        data = return_data,
+        headers = response_data.getheaders(),
+        raw_data = response_data.data
+    )
+
+
+
+ +
+ +
+ + +

+ sanitize_for_serialization(obj) + +

+ + +
+ +

Builds a JSON POST object.

+

If obj is None, return None. +If obj is str, int, long, float, bool, return directly. +If obj is datetime.datetime, datetime.date + convert to string in iso8601 format. +If obj is list, sanitize each element in the list. +If obj is dict, return the dict. +If obj is OpenAPI model, return the properties dict.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
obj + +
+

The data to serialize.

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

The serialized form of data.

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
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
def sanitize_for_serialization(self, obj):
+    """Builds a JSON POST object.
+
+    If obj is None, return None.
+    If obj is str, int, long, float, bool, return directly.
+    If obj is datetime.datetime, datetime.date
+        convert to string in iso8601 format.
+    If obj is list, sanitize each element in the list.
+    If obj is dict, return the dict.
+    If obj is OpenAPI model, return the properties dict.
+
+    :param obj: The data to serialize.
+    :return: The serialized form of data.
+    """
+    if obj is None:
+        return None
+    elif isinstance(obj, self.PRIMITIVE_TYPES):
+        return obj
+    elif isinstance(obj, list):
+        return [
+            self.sanitize_for_serialization(sub_obj) for sub_obj in obj
+        ]
+    elif isinstance(obj, tuple):
+        return tuple(
+            self.sanitize_for_serialization(sub_obj) for sub_obj in obj
+        )
+    elif isinstance(obj, (datetime.datetime, datetime.date)):
+        return obj.isoformat()
+
+    elif isinstance(obj, dict):
+        obj_dict = obj
+    else:
+        # Convert model obj to dict except
+        # attributes `openapi_types`, `attribute_map`
+        # and attributes which value is not None.
+        # Convert attribute name to json key in
+        # model definition for request.
+        obj_dict = obj.to_dict()
+
+    return {
+        key: self.sanitize_for_serialization(val)
+        for key, val in obj_dict.items()
+    }
+
+
+
+ +
+ +
+ + +

+ select_header_accept(accepts) + +

+ + +
+ +

Returns Accept based on an array of accepts provided.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
accepts + List[str] + +
+

List of headers.

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Optional[str] + +
+

Accept (e.g. application/json).

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
537
+538
+539
+540
+541
+542
+543
+544
+545
+546
+547
+548
+549
+550
def select_header_accept(self, accepts: List[str]) -> Optional[str]:
+    """Returns `Accept` based on an array of accepts provided.
+
+    :param accepts: List of headers.
+    :return: Accept (e.g. application/json).
+    """
+    if not accepts:
+        return None
+
+    for accept in accepts:
+        if re.search('json', accept, re.IGNORECASE):
+            return accept
+
+    return accepts[0]
+
+
+
+ +
+ +
+ + +

+ select_header_content_type(content_types) + +

+ + +
+ +

Returns Content-Type based on an array of content_types provided.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
content_types + +
+

List of content-types.

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

Content-Type (e.g. application/json).

+
+
+ +
+ Source code in cheshire_cat_api/api_client.py + 
552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564
+565
def select_header_content_type(self, content_types):
+    """Returns `Content-Type` based on an array of content_types provided.
+
+    :param content_types: List of content-types.
+    :return: Content-Type (e.g. application/json).
+    """
+    if not content_types:
+        return None
+
+    for content_type in content_types:
+        if re.search('json', content_type, re.IGNORECASE):
+            return content_type
+
+    return content_types[0]
+
+
+
+ +
+ +
+ + +

+ set_default(default) + + + classmethod + + +

+ + +
+ +

Set default instance of ApiClient.

+

It stores default ApiClient.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
default + +
+

object of ApiClient.

+
+ 		+ required +
+ +
+ Source code in cheshire_cat_api/api_client.py + 
127
+128
+129
+130
+131
+132
+133
+134
+135
@classmethod
+def set_default(cls, default):
+    """Set default instance of ApiClient.
+
+    It stores default ApiClient.
+
+    :param default: object of ApiClient.
+    """
+    cls._default = default
+
+
+
+ +
+ +
+ + +

+ update_params_for_auth(headers, queries, auth_settings, resource_path, method, body, request_auth=None) + +

+ + +
+ +

Updates header and query params based on authentication setting.

+

:resource_path: A string representation of the HTTP request resource path. +:method: A string representation of the HTTP request method. +:body: A object representing the body of the HTTP request. +The object type is the return value of sanitize_for_serialization().

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
headers + +
+

Header parameters dict to be updated.

+
+ 		+ required +
queries + +
+

Query parameters tuple list to be updated.

+
+ 		+ required +
auth_settings + +
+

Authentication setting identifiers list.

+
+ 		+ required +
request_auth + +
+

if set, the provided settings will override the token in the configuration.

+
+ 		+ None +
+ +
+ Source code in cheshire_cat_api/api_client.py + 
567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
def update_params_for_auth(
+    self,
+    headers,
+    queries,
+    auth_settings,
+    resource_path,
+    method,
+    body,
+    request_auth=None
+) -> None:
+    """Updates header and query params based on authentication setting.
+
+    :param headers: Header parameters dict to be updated.
+    :param queries: Query parameters tuple list to be updated.
+    :param auth_settings: Authentication setting identifiers list.
+    :resource_path: A string representation of the HTTP request resource path.
+    :method: A string representation of the HTTP request method.
+    :body: A object representing the body of the HTTP request.
+    The object type is the return value of sanitize_for_serialization().
+    :param request_auth: if set, the provided settings will
+                         override the token in the configuration.
+    """
+    if not auth_settings:
+        return
+
+    if request_auth:
+        self._apply_auth_params(
+            headers,
+            queries,
+            resource_path,
+            method,
+            body,
+            request_auth
+        )
+    else:
+        for auth in auth_settings:
+            auth_setting = self.configuration.auth_settings().get(auth)
+            if auth_setting:
+                self._apply_auth_params(
+                    headers,
+                    queries,
+                    resource_path,
+                    method,
+                    body,
+                    auth_setting
+                )
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/api_response/index.html b/API_Documentation/api_response/index.html new file mode 100644 index 0000000..6858965 --- /dev/null +++ b/API_Documentation/api_response/index.html @@ -0,0 +1,1286 @@ + + + + + + + + + + + + + + + + + + + + + + + api_response - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

api_response

+ +
+ + + + +
+ +

API response object.

+ + + +
+ + + + + + + + +
+ + + +

+ ApiResponse + + +

+ + +
+

+ Bases: BaseModel, Generic[T]

+ + +

API response object

+ +
+ Source code in cheshire_cat_api/api_response.py + 
 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
class ApiResponse(BaseModel, Generic[T]):
+    """
+    API response object
+    """
+
+    status_code: StrictInt = Field(description="HTTP status code")
+    headers: Optional[Dict[StrictStr, StrictStr]] = Field(None, description="HTTP headers")
+    data: T = Field(description="Deserialized data given the data type")
+    raw_data: StrictBytes = Field(description="Raw data (HTTP response body)")
+
+    model_config = {
+        "arbitrary_types_allowed": True
+    }
+
+
+ + + +
+ + + + + + + + + + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/cat_client/index.html b/API_Documentation/cat_client/index.html new file mode 100644 index 0000000..600b5dc --- /dev/null +++ b/API_Documentation/cat_client/index.html @@ -0,0 +1,1802 @@ + + + + + + + + + + + + + + + + + + + + + + + cat_client - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

cat_client

+ +
+ + + + +
+ + + +
+ + + + + + + + +
+ + + +

+ CatClient + + +

+ + +
+ + +

The class to communicate with the Cheshire Cat AI

+ +
+ Source code in cheshire_cat_api/cat_client.py + 
 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
class CatClient:
+    """
+    The class to communicate with the Cheshire Cat AI
+    """
+
+    def __init__(self,
+                 config: Optional[Config] = None,
+                 on_open: Optional[Callable] = None,
+                 on_close: Optional[Callable] = None,
+                 on_message: Optional[Callable] = None,
+                 on_error: Optional[Callable] = None
+                 ):
+
+        # Instantiate user message handlers if any, otherwise use default
+        self.on_message = on_message
+        self.on_error = on_error
+        self.on_close = on_close
+        self.on_open = on_open
+
+        # Settings
+        self._conn_settings = config if config is not None else Config()
+        # TODO: user_id should be automatically passed from settings to http endpoints
+
+        self.memory = None
+        self.plugins = None
+        self.rabbit_hole = None
+        self.status = None
+        self.embedder = None
+        self.settings = None
+        self.llm = None
+
+        self._ws = None
+
+        self._connect_api()
+
+    def _connect_api(self):
+        protocol = "https" if self._conn_settings.secure_connection else "http"
+        config = Configuration(host=f"{protocol}://{self._conn_settings.base_url}:{self._conn_settings.port}")
+
+        client = ApiClient(
+            configuration=config,
+            header_name='access_token',
+            header_value=self._conn_settings.auth_key
+        )
+        self.memory = MemoryApi(client)
+        self.plugins = PluginsApi(client)
+        self.rabbit_hole = RabbitHoleApi(client)
+        self.status = StatusApi(client)
+        self.embedder = EmbedderApi(client)
+        self.settings = SettingsApi(client)
+        self.llm = LargeLanguageModelApi(client)
+
+    def connect_ws(self):
+        protocol = "wss" if self._conn_settings.secure_connection else "ws"
+        url = f"{protocol}://{self._conn_settings.base_url}:{self._conn_settings.port}/ws/{self._conn_settings.user_id}"
+
+        self._ws = WebSocketApp(
+            url,
+            on_message=self.on_ws_message,
+            on_error=self.on_ws_error,
+            on_close=self.on_ws_close,
+            on_open=self.on_ws_open
+        )
+
+        self.conn = Thread(target=self._ws.run_forever)
+        self.conn.start()
+
+    def on_ws_open(self, ws):
+        """"Default message handler on connection opening"""
+
+        logging.info(f"Websocket connection established with id {self._conn_settings.user_id}")
+
+        # Run user custom function
+        if callable(self.on_open):
+            self.on_open()
+
+    def on_ws_message(self, ws, message: str):
+        """"Default message handler when receiving a message"""
+        # Run user custom function
+        if callable(self.on_message):
+            self.on_message(message)
+            return
+
+        answer = json.loads(message)
+        print(answer["content"])
+
+    def on_ws_error(self, ws, error: Exception):
+        """"Default message handler on WebSocket error"""
+
+        logging.exception(f"An error occurred in ws connection with id {self._conn_settings.user_id}: {error}", exc_info=True)
+
+        # Run user custom function
+        if callable(self.on_error):
+            self.on_error(error)
+
+    def on_ws_close(self, ws, status_code: int, msg: str):
+        """"Default message handler on closed connection"""
+
+        logging.info(f"Connection with id {self._conn_settings.user_id} closed with code {status_code}: {msg}")
+
+        # Run user custom function
+        if callable(self.on_close):
+            self.on_close(status_code, msg)
+
+
+    def send(self, message: str, **kwargs):
+        """Send a message to WebSocket server using a separate thread"""
+
+        if self._ws is None:     
+            logging.warning("WebSocket connection is not available. Message not sent.")
+        else:
+            self._ws.send(json.dumps({
+                "text": message,
+                **kwargs
+            }))
+
+    def close(self):
+
+        if self._ws is None:
+            logging.warning("Websocket connection is already close")
+            return
+
+        # Close connection
+        self._ws.close()
+        self.conn.join()
+
+    @property
+    def is_ws_connected(self):
+        return self._ws and self._ws.sock and self._ws.sock.connected
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ on_ws_close(ws, status_code, msg) + +

+ + +
+ +

"Default message handler on closed connection

+ +
+ Source code in cheshire_cat_api/cat_client.py + 
110
+111
+112
+113
+114
+115
+116
+117
def on_ws_close(self, ws, status_code: int, msg: str):
+    """"Default message handler on closed connection"""
+
+    logging.info(f"Connection with id {self._conn_settings.user_id} closed with code {status_code}: {msg}")
+
+    # Run user custom function
+    if callable(self.on_close):
+        self.on_close(status_code, msg)
+
+
+
+ +
+ +
+ + +

+ on_ws_error(ws, error) + +

+ + +
+ +

"Default message handler on WebSocket error

+ +
+ Source code in cheshire_cat_api/cat_client.py + 
101
+102
+103
+104
+105
+106
+107
+108
def on_ws_error(self, ws, error: Exception):
+    """"Default message handler on WebSocket error"""
+
+    logging.exception(f"An error occurred in ws connection with id {self._conn_settings.user_id}: {error}", exc_info=True)
+
+    # Run user custom function
+    if callable(self.on_error):
+        self.on_error(error)
+
+
+
+ +
+ +
+ + +

+ on_ws_message(ws, message) + +

+ + +
+ +

"Default message handler when receiving a message

+ +
+ Source code in cheshire_cat_api/cat_client.py + 
91
+92
+93
+94
+95
+96
+97
+98
+99
def on_ws_message(self, ws, message: str):
+    """"Default message handler when receiving a message"""
+    # Run user custom function
+    if callable(self.on_message):
+        self.on_message(message)
+        return
+
+    answer = json.loads(message)
+    print(answer["content"])
+
+
+
+ +
+ +
+ + +

+ on_ws_open(ws) + +

+ + +
+ +

"Default message handler on connection opening

+ +
+ Source code in cheshire_cat_api/cat_client.py + 
82
+83
+84
+85
+86
+87
+88
+89
def on_ws_open(self, ws):
+    """"Default message handler on connection opening"""
+
+    logging.info(f"Websocket connection established with id {self._conn_settings.user_id}")
+
+    # Run user custom function
+    if callable(self.on_open):
+        self.on_open()
+
+
+
+ +
+ +
+ + +

+ send(message, **kwargs) + +

+ + +
+ +

Send a message to WebSocket server using a separate thread

+ +
+ Source code in cheshire_cat_api/cat_client.py + 
120
+121
+122
+123
+124
+125
+126
+127
+128
+129
def send(self, message: str, **kwargs):
+    """Send a message to WebSocket server using a separate thread"""
+
+    if self._ws is None:     
+        logging.warning("WebSocket connection is not available. Message not sent.")
+    else:
+        self._ws.send(json.dumps({
+            "text": message,
+            **kwargs
+        }))
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/config/index.html b/API_Documentation/config/index.html new file mode 100644 index 0000000..6cd6154 --- /dev/null +++ b/API_Documentation/config/index.html @@ -0,0 +1,1280 @@ + + + + + + + + + + + + + + + + + + + + + + + config - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

config

+ +
+ + + + +
+ + + +
+ + + + + + + + +
+ + + +

+ Config + + + + dataclass + + +

+ + +
+ + +

Class containing all the configuration options and variables used by ccat-api package

+ +
+ Source code in cheshire_cat_api/config.py + 
 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
@dataclass
+class Config:
+    """
+    Class containing all the configuration options and variables used by ccat-api package
+    """  
+    base_url: str = 'localhost'
+    port: int = 1865
+    user_id: str = "user"
+    auth_key: str = ''
+    secure_connection: bool = False
+
+
+ + + +
+ + + + + + + + + + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/configuration/index.html b/API_Documentation/configuration/index.html new file mode 100644 index 0000000..d3f17f4 --- /dev/null +++ b/API_Documentation/configuration/index.html @@ -0,0 +1,4566 @@ + + + + + + + + + + + + + + + + + + + + + + + configuration - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

configuration

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ Configuration + + +

+ + +
+ + +

This class contains various settings of the API client.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
host + +
+

Base url.

+
+ 		+ None +
api_key + +
+

Dict to store API key(s). Each entry in the dict specifies an API key. The dict key is the name of the security scheme in the OAS specification. The dict value is the API key secret.

+
+ 		+ None +
api_key_prefix + +
+

Dict to store API prefix (e.g. Bearer). The dict key is the name of the security scheme in the OAS specification. The dict value is an API key prefix when generating the auth data.

+
+ 		+ None +
username + +
+

Username for HTTP basic authentication.

+
+ 		+ None +
password + +
+

Password for HTTP basic authentication.

+
+ 		+ None +
access_token + +
+

Access token.

+
+ 		+ None +
server_index + +
+

Index to servers configuration.

+
+ 		+ None +
server_variables + +
+

Mapping with string values to replace variables in templated server configuration. The validation of enums is performed for variables with defined enum values before.

+
+ 		+ None +
server_operation_index + +
+

Mapping from operation ID to an index to server configuration.

+
+ 		+ None +
server_operation_variables + +
+

Mapping from operation ID to a mapping with string values to replace variables in templated server configuration. The validation of enums is performed for variables with defined enum values before.

+
+ 		+ None +
ssl_ca_cert + +
+

str - the path to a file of concatenated CA certificates in PEM format.

+
+ 		+ None +
+ +
+ Source code in cheshire_cat_api/configuration.py + 
 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
class Configuration:
+    """This class contains various settings of the API client.
+
+    :param host: Base url.
+    :param api_key: Dict to store API key(s).
+      Each entry in the dict specifies an API key.
+      The dict key is the name of the security scheme in the OAS specification.
+      The dict value is the API key secret.
+    :param api_key_prefix: Dict to store API prefix (e.g. Bearer).
+      The dict key is the name of the security scheme in the OAS specification.
+      The dict value is an API key prefix when generating the auth data.
+    :param username: Username for HTTP basic authentication.
+    :param password: Password for HTTP basic authentication.
+    :param access_token: Access token.
+    :param server_index: Index to servers configuration.
+    :param server_variables: Mapping with string values to replace variables in
+      templated server configuration. The validation of enums is performed for
+      variables with defined enum values before.
+    :param server_operation_index: Mapping from operation ID to an index to server
+      configuration.
+    :param server_operation_variables: Mapping from operation ID to a mapping with
+      string values to replace variables in templated server configuration.
+      The validation of enums is performed for variables with defined enum
+      values before.
+    :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
+      in PEM format.
+
+    """
+
+    _default = None
+
+    def __init__(self, host=None,
+                 api_key=None, api_key_prefix=None,
+                 username=None, password=None,
+                 access_token=None,
+                 server_index=None, server_variables=None,
+                 server_operation_index=None, server_operation_variables=None,
+                 ssl_ca_cert=None,
+                 ) -> None:
+        """Constructor
+        """
+        self._base_path = "http://localhost" if host is None else host
+        """Default Base url
+        """
+        self.server_index = 0 if server_index is None and host is None else server_index
+        self.server_operation_index = server_operation_index or {}
+        """Default server index
+        """
+        self.server_variables = server_variables or {}
+        self.server_operation_variables = server_operation_variables or {}
+        """Default server variables
+        """
+        self.temp_folder_path = None
+        """Temp file folder for downloading files
+        """
+        # Authentication Settings
+        self.api_key = {}
+        if api_key:
+            self.api_key = api_key
+        """dict to store API key(s)
+        """
+        self.api_key_prefix = {}
+        if api_key_prefix:
+            self.api_key_prefix = api_key_prefix
+        """dict to store API prefix (e.g. Bearer)
+        """
+        self.refresh_api_key_hook = None
+        """function hook to refresh API key if expired
+        """
+        self.username = username
+        """Username for HTTP basic authentication
+        """
+        self.password = password
+        """Password for HTTP basic authentication
+        """
+        self.access_token = access_token
+        """Access token
+        """
+        self.logger = {}
+        """Logging Settings
+        """
+        self.logger["package_logger"] = logging.getLogger("cheshire_cat_api")
+        self.logger["urllib3_logger"] = logging.getLogger("urllib3")
+        self.logger_format = '%(asctime)s %(levelname)s %(message)s'
+        """Log format
+        """
+        self.logger_stream_handler = None
+        """Log stream handler
+        """
+        self.logger_file_handler = None
+        """Log file handler
+        """
+        self.logger_file = None
+        """Debug file location
+        """
+        self.debug = False
+        """Debug switch
+        """
+
+        self.verify_ssl = True
+        """SSL/TLS verification
+           Set this to false to skip verifying SSL certificate when calling API
+           from https server.
+        """
+        self.ssl_ca_cert = ssl_ca_cert
+        """Set this to customize the certificate file to verify the peer.
+        """
+        self.cert_file = None
+        """client certificate file
+        """
+        self.key_file = None
+        """client key file
+        """
+        self.assert_hostname = None
+        """Set this to True/False to enable/disable SSL hostname verification.
+        """
+        self.tls_server_name = None
+        """SSL/TLS Server Name Indication (SNI)
+           Set this to the SNI value expected by the server.
+        """
+
+
+        self.proxy = None
+        """Proxy URL
+        """
+        self.proxy_headers = None
+        """Proxy headers
+        """
+        self.safe_chars_for_path_param = ''
+        """Safe chars for path_param
+        """
+        self.retries = None
+        """Adding retries to override urllib3 default value 3
+        """
+        # Enable client side validation
+        self.client_side_validation = True
+
+        self.socket_options = None
+        """Options to pass down to the underlying urllib3 socket
+        """
+
+        self.datetime_format = "%Y-%m-%dT%H:%M:%S.%f%z"
+        """datetime format
+        """
+
+        self.date_format = "%Y-%m-%d"
+        """date format
+        """
+
+    def __deepcopy__(self, memo):
+        cls = self.__class__
+        result = cls.__new__(cls)
+        memo[id(self)] = result
+        for k, v in self.__dict__.items():
+            if k not in ('logger', 'logger_file_handler'):
+                setattr(result, k, copy.deepcopy(v, memo))
+        # shallow copy of loggers
+        result.logger = copy.copy(self.logger)
+        # use setters to configure loggers
+        result.logger_file = self.logger_file
+        result.debug = self.debug
+        return result
+
+    def __setattr__(self, name, value):
+        object.__setattr__(self, name, value)
+
+    @classmethod
+    def set_default(cls, default):
+        """Set default instance of configuration.
+
+        It stores default configuration, which can be
+        returned by get_default_copy method.
+
+        :param default: object of Configuration
+        """
+        cls._default = default
+
+    @classmethod
+    def get_default_copy(cls):
+        """Deprecated. Please use `get_default` instead.
+
+        Deprecated. Please use `get_default` instead.
+
+        :return: The configuration object.
+        """
+        return cls.get_default()
+
+    @classmethod
+    def get_default(cls):
+        """Return the default configuration.
+
+        This method returns newly created, based on default constructor,
+        object of Configuration class or returns a copy of default
+        configuration.
+
+        :return: The configuration object.
+        """
+        if cls._default is None:
+            cls._default = Configuration()
+        return cls._default
+
+    @property
+    def logger_file(self):
+        """The logger file.
+
+        If the logger_file is None, then add stream handler and remove file
+        handler. Otherwise, add file handler and remove stream handler.
+
+        :param value: The logger_file path.
+        :type: str
+        """
+        return self.__logger_file
+
+    @logger_file.setter
+    def logger_file(self, value):
+        """The logger file.
+
+        If the logger_file is None, then add stream handler and remove file
+        handler. Otherwise, add file handler and remove stream handler.
+
+        :param value: The logger_file path.
+        :type: str
+        """
+        self.__logger_file = value
+        if self.__logger_file:
+            # If set logging file,
+            # then add file handler and remove stream handler.
+            self.logger_file_handler = logging.FileHandler(self.__logger_file)
+            self.logger_file_handler.setFormatter(self.logger_formatter)
+            for _, logger in self.logger.items():
+                logger.addHandler(self.logger_file_handler)
+
+    @property
+    def debug(self):
+        """Debug status
+
+        :param value: The debug status, True or False.
+        :type: bool
+        """
+        return self.__debug
+
+    @debug.setter
+    def debug(self, value):
+        """Debug status
+
+        :param value: The debug status, True or False.
+        :type: bool
+        """
+        self.__debug = value
+        if self.__debug:
+            # if debug status is True, turn on debug logging
+            for _, logger in self.logger.items():
+                logger.setLevel(logging.DEBUG)
+            # turn on httplib debug
+            httplib.HTTPConnection.debuglevel = 1
+        else:
+            # if debug status is False, turn off debug logging,
+            # setting log level to default `logging.WARNING`
+            for _, logger in self.logger.items():
+                logger.setLevel(logging.WARNING)
+            # turn off httplib debug
+            httplib.HTTPConnection.debuglevel = 0
+
+    @property
+    def logger_format(self):
+        """The logger format.
+
+        The logger_formatter will be updated when sets logger_format.
+
+        :param value: The format string.
+        :type: str
+        """
+        return self.__logger_format
+
+    @logger_format.setter
+    def logger_format(self, value):
+        """The logger format.
+
+        The logger_formatter will be updated when sets logger_format.
+
+        :param value: The format string.
+        :type: str
+        """
+        self.__logger_format = value
+        self.logger_formatter = logging.Formatter(self.__logger_format)
+
+    def get_api_key_with_prefix(self, identifier, alias=None):
+        """Gets API key (with prefix if set).
+
+        :param identifier: The identifier of apiKey.
+        :param alias: The alternative identifier of apiKey.
+        :return: The token for api key authentication.
+        """
+        if self.refresh_api_key_hook is not None:
+            self.refresh_api_key_hook(self)
+        key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None)
+        if key:
+            prefix = self.api_key_prefix.get(identifier)
+            if prefix:
+                return "%s %s" % (prefix, key)
+            else:
+                return key
+
+    def get_basic_auth_token(self):
+        """Gets HTTP basic authentication header (string).
+
+        :return: The token for basic HTTP authentication.
+        """
+        username = ""
+        if self.username is not None:
+            username = self.username
+        password = ""
+        if self.password is not None:
+            password = self.password
+        return urllib3.util.make_headers(
+            basic_auth=username + ':' + password
+        ).get('authorization')
+
+    def auth_settings(self):
+        """Gets Auth Settings dict for api client.
+
+        :return: The Auth Settings information dict.
+        """
+        auth = {}
+        return auth
+
+    def to_debug_report(self):
+        """Gets the essential information for debugging.
+
+        :return: The report for debugging.
+        """
+        return "Python SDK Debug Report:\n"\
+               "OS: {env}\n"\
+               "Python Version: {pyversion}\n"\
+               "Version of the API: 1.3.1\n"\
+               "SDK Package Version: 1.0.0".\
+               format(env=sys.platform, pyversion=sys.version)
+
+    def get_host_settings(self):
+        """Gets an array of host settings
+
+        :return: An array of host settings
+        """
+        return [
+            {
+                'url': "",
+                'description': "No description provided",
+            }
+        ]
+
+    def get_host_from_settings(self, index, variables=None, servers=None):
+        """Gets host URL based on the index and variables
+        :param index: array index of the host settings
+        :param variables: hash of variable and the corresponding value
+        :param servers: an array of host settings or None
+        :return: URL based on host settings
+        """
+        if index is None:
+            return self._base_path
+
+        variables = {} if variables is None else variables
+        servers = self.get_host_settings() if servers is None else servers
+
+        try:
+            server = servers[index]
+        except IndexError:
+            raise ValueError(
+                "Invalid index {0} when selecting the host settings. "
+                "Must be less than {1}".format(index, len(servers)))
+
+        url = server['url']
+
+        # go through variables and replace placeholders
+        for variable_name, variable in server.get('variables', {}).items():
+            used_value = variables.get(
+                variable_name, variable['default_value'])
+
+            if 'enum_values' in variable \
+                    and used_value not in variable['enum_values']:
+                raise ValueError(
+                    "The variable `{0}` in the host URL has invalid value "
+                    "{1}. Must be {2}.".format(
+                        variable_name, variables[variable_name],
+                        variable['enum_values']))
+
+            url = url.replace("{" + variable_name + "}", used_value)
+
+        return url
+
+    @property
+    def host(self):
+        """Return generated host."""
+        return self.get_host_from_settings(self.server_index, variables=self.server_variables)
+
+    @host.setter
+    def host(self, value):
+        """Fix base path."""
+        self._base_path = value
+        self.server_index = None
+
+
+ + + +
+ + + + + + + +
+ + + +

+ access_token = access_token + + + instance-attribute + + +

+ + +
+ +

Access token

+
+ +
+ +
+ + + +

+ assert_hostname = None + + + instance-attribute + + +

+ + +
+ +

Set this to True/False to enable/disable SSL hostname verification.

+
+ +
+ +
+ + + +

+ cert_file = None + + + instance-attribute + + +

+ + +
+ +

client certificate file

+
+ +
+ +
+ + + +

+ date_format = '%Y-%m-%d' + + + instance-attribute + + +

+ + +
+ +

date format

+
+ +
+ +
+ + + +

+ datetime_format = '%Y-%m-%dT%H:%M:%S.%f%z' + + + instance-attribute + + +

+ + +
+ +

datetime format

+
+ +
+ +
+ + + +

+ debug + + + property + writable + + +

+ + +
+ +

Debug status

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
value + +
+

The debug status, True or False.

+
+ 		+ required +
+
+ +
+ +
+ + + +

+ host + + + property + writable + + +

+ + +
+ +

Return generated host.

+
+ +
+ +
+ + + +

+ key_file = None + + + instance-attribute + + +

+ + +
+ +

client key file

+
+ +
+ +
+ + + +

+ logger = {} + + + instance-attribute + + +

+ + +
+ +

Logging Settings

+
+ +
+ +
+ + + +

+ logger_file + + + property + writable + + +

+ + +
+ +

The logger file.

+

If the logger_file is None, then add stream handler and remove file +handler. Otherwise, add file handler and remove stream handler.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
value + +
+

The logger_file path.

+
+ 		+ required +
+
+ +
+ +
+ + + +

+ logger_file_handler = None + + + instance-attribute + + +

+ + +
+ +

Log file handler

+
+ +
+ +
+ + + +

+ logger_format + + + property + writable + + +

+ + +
+ +

The logger format.

+

The logger_formatter will be updated when sets logger_format.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
value + +
+

The format string.

+
+ 		+ required +
+
+ +
+ +
+ + + +

+ logger_stream_handler = None + + + instance-attribute + + +

+ + +
+ +

Log stream handler

+
+ +
+ +
+ + + +

+ password = password + + + instance-attribute + + +

+ + +
+ +

Password for HTTP basic authentication

+
+ +
+ +
+ + + +

+ proxy = None + + + instance-attribute + + +

+ + +
+ +

Proxy URL

+
+ +
+ +
+ + + +

+ proxy_headers = None + + + instance-attribute + + +

+ + +
+ +

Proxy headers

+
+ +
+ +
+ + + +

+ refresh_api_key_hook = None + + + instance-attribute + + +

+ + +
+ +

function hook to refresh API key if expired

+
+ +
+ +
+ + + +

+ retries = None + + + instance-attribute + + +

+ + +
+ +

Adding retries to override urllib3 default value 3

+
+ +
+ +
+ + + +

+ safe_chars_for_path_param = '' + + + instance-attribute + + +

+ + +
+ +

Safe chars for path_param

+
+ +
+ +
+ + + +

+ server_operation_index = server_operation_index or {} + + + instance-attribute + + +

+ + +
+ +

Default server index

+
+ +
+ +
+ + + +

+ server_operation_variables = server_operation_variables or {} + + + instance-attribute + + +

+ + +
+ +

Default server variables

+
+ +
+ +
+ + + +

+ socket_options = None + + + instance-attribute + + +

+ + +
+ +

Options to pass down to the underlying urllib3 socket

+
+ +
+ +
+ + + +

+ ssl_ca_cert = ssl_ca_cert + + + instance-attribute + + +

+ + +
+ +

Set this to customize the certificate file to verify the peer.

+
+ +
+ +
+ + + +

+ temp_folder_path = None + + + instance-attribute + + +

+ + +
+ +

Temp file folder for downloading files

+
+ +
+ +
+ + + +

+ tls_server_name = None + + + instance-attribute + + +

+ + +
+ +

SSL/TLS Server Name Indication (SNI) +Set this to the SNI value expected by the server.

+
+ +
+ +
+ + + +

+ username = username + + + instance-attribute + + +

+ + +
+ +

Username for HTTP basic authentication

+
+ +
+ +
+ + + +

+ verify_ssl = True + + + instance-attribute + + +

+ + +
+ +

SSL/TLS verification +Set this to false to skip verifying SSL certificate when calling API +from https server.

+
+ +
+ + + +
+ + +

+ __init__(host=None, api_key=None, api_key_prefix=None, username=None, password=None, access_token=None, server_index=None, server_variables=None, server_operation_index=None, server_operation_variables=None, ssl_ca_cert=None) + +

+ + +
+ +

Constructor

+ +
+ Source code in cheshire_cat_api/configuration.py + 
 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
def __init__(self, host=None,
+             api_key=None, api_key_prefix=None,
+             username=None, password=None,
+             access_token=None,
+             server_index=None, server_variables=None,
+             server_operation_index=None, server_operation_variables=None,
+             ssl_ca_cert=None,
+             ) -> None:
+    """Constructor
+    """
+    self._base_path = "http://localhost" if host is None else host
+    """Default Base url
+    """
+    self.server_index = 0 if server_index is None and host is None else server_index
+    self.server_operation_index = server_operation_index or {}
+    """Default server index
+    """
+    self.server_variables = server_variables or {}
+    self.server_operation_variables = server_operation_variables or {}
+    """Default server variables
+    """
+    self.temp_folder_path = None
+    """Temp file folder for downloading files
+    """
+    # Authentication Settings
+    self.api_key = {}
+    if api_key:
+        self.api_key = api_key
+    """dict to store API key(s)
+    """
+    self.api_key_prefix = {}
+    if api_key_prefix:
+        self.api_key_prefix = api_key_prefix
+    """dict to store API prefix (e.g. Bearer)
+    """
+    self.refresh_api_key_hook = None
+    """function hook to refresh API key if expired
+    """
+    self.username = username
+    """Username for HTTP basic authentication
+    """
+    self.password = password
+    """Password for HTTP basic authentication
+    """
+    self.access_token = access_token
+    """Access token
+    """
+    self.logger = {}
+    """Logging Settings
+    """
+    self.logger["package_logger"] = logging.getLogger("cheshire_cat_api")
+    self.logger["urllib3_logger"] = logging.getLogger("urllib3")
+    self.logger_format = '%(asctime)s %(levelname)s %(message)s'
+    """Log format
+    """
+    self.logger_stream_handler = None
+    """Log stream handler
+    """
+    self.logger_file_handler = None
+    """Log file handler
+    """
+    self.logger_file = None
+    """Debug file location
+    """
+    self.debug = False
+    """Debug switch
+    """
+
+    self.verify_ssl = True
+    """SSL/TLS verification
+       Set this to false to skip verifying SSL certificate when calling API
+       from https server.
+    """
+    self.ssl_ca_cert = ssl_ca_cert
+    """Set this to customize the certificate file to verify the peer.
+    """
+    self.cert_file = None
+    """client certificate file
+    """
+    self.key_file = None
+    """client key file
+    """
+    self.assert_hostname = None
+    """Set this to True/False to enable/disable SSL hostname verification.
+    """
+    self.tls_server_name = None
+    """SSL/TLS Server Name Indication (SNI)
+       Set this to the SNI value expected by the server.
+    """
+
+
+    self.proxy = None
+    """Proxy URL
+    """
+    self.proxy_headers = None
+    """Proxy headers
+    """
+    self.safe_chars_for_path_param = ''
+    """Safe chars for path_param
+    """
+    self.retries = None
+    """Adding retries to override urllib3 default value 3
+    """
+    # Enable client side validation
+    self.client_side_validation = True
+
+    self.socket_options = None
+    """Options to pass down to the underlying urllib3 socket
+    """
+
+    self.datetime_format = "%Y-%m-%dT%H:%M:%S.%f%z"
+    """datetime format
+    """
+
+    self.date_format = "%Y-%m-%d"
+    """date format
+    """
+
+
+
+ +
+ +
+ + +

+ auth_settings() + +

+ + +
+ +

Gets Auth Settings dict for api client.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

The Auth Settings information dict.

+
+
+ +
+ Source code in cheshire_cat_api/configuration.py + 
346
+347
+348
+349
+350
+351
+352
def auth_settings(self):
+    """Gets Auth Settings dict for api client.
+
+    :return: The Auth Settings information dict.
+    """
+    auth = {}
+    return auth
+
+
+
+ +
+ +
+ + +

+ get_api_key_with_prefix(identifier, alias=None) + +

+ + +
+ +

Gets API key (with prefix if set).

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
identifier + +
+

The identifier of apiKey.

+
+ 		+ required +
alias + +
+

The alternative identifier of apiKey.

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

The token for api key authentication.

+
+
+ +
+ Source code in cheshire_cat_api/configuration.py + 
314
+315
+316
+317
+318
+319
+320
+321
+322
+323
+324
+325
+326
+327
+328
+329
def get_api_key_with_prefix(self, identifier, alias=None):
+    """Gets API key (with prefix if set).
+
+    :param identifier: The identifier of apiKey.
+    :param alias: The alternative identifier of apiKey.
+    :return: The token for api key authentication.
+    """
+    if self.refresh_api_key_hook is not None:
+        self.refresh_api_key_hook(self)
+    key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None)
+    if key:
+        prefix = self.api_key_prefix.get(identifier)
+        if prefix:
+            return "%s %s" % (prefix, key)
+        else:
+            return key
+
+
+
+ +
+ +
+ + +

+ get_basic_auth_token() + +

+ + +
+ +

Gets HTTP basic authentication header (string).

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

The token for basic HTTP authentication.

+
+
+ +
+ Source code in cheshire_cat_api/configuration.py + 
331
+332
+333
+334
+335
+336
+337
+338
+339
+340
+341
+342
+343
+344
def get_basic_auth_token(self):
+    """Gets HTTP basic authentication header (string).
+
+    :return: The token for basic HTTP authentication.
+    """
+    username = ""
+    if self.username is not None:
+        username = self.username
+    password = ""
+    if self.password is not None:
+        password = self.password
+    return urllib3.util.make_headers(
+        basic_auth=username + ':' + password
+    ).get('authorization')
+
+
+
+ +
+ +
+ + +

+ get_default() + + + classmethod + + +

+ + +
+ +

Return the default configuration.

+

This method returns newly created, based on default constructor, +object of Configuration class or returns a copy of default +configuration.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

The configuration object.

+
+
+ +
+ Source code in cheshire_cat_api/configuration.py + 
215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
@classmethod
+def get_default(cls):
+    """Return the default configuration.
+
+    This method returns newly created, based on default constructor,
+    object of Configuration class or returns a copy of default
+    configuration.
+
+    :return: The configuration object.
+    """
+    if cls._default is None:
+        cls._default = Configuration()
+    return cls._default
+
+
+
+ +
+ +
+ + +

+ get_default_copy() + + + classmethod + + +

+ + +
+ +

Deprecated. Please use get_default instead.

+

Deprecated. Please use get_default instead.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

The configuration object.

+
+
+ +
+ Source code in cheshire_cat_api/configuration.py + 
205
+206
+207
+208
+209
+210
+211
+212
+213
@classmethod
+def get_default_copy(cls):
+    """Deprecated. Please use `get_default` instead.
+
+    Deprecated. Please use `get_default` instead.
+
+    :return: The configuration object.
+    """
+    return cls.get_default()
+
+
+
+ +
+ +
+ + +

+ get_host_from_settings(index, variables=None, servers=None) + +

+ + +
+ +

Gets host URL based on the index and variables

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
index + +
+

array index of the host settings

+
+ 		+ required +
variables + +
+

hash of variable and the corresponding value

+
+ 		+ None +
servers + +
+

an array of host settings or None

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

URL based on host settings

+
+
+ +
+ Source code in cheshire_cat_api/configuration.py + 
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
def get_host_from_settings(self, index, variables=None, servers=None):
+    """Gets host URL based on the index and variables
+    :param index: array index of the host settings
+    :param variables: hash of variable and the corresponding value
+    :param servers: an array of host settings or None
+    :return: URL based on host settings
+    """
+    if index is None:
+        return self._base_path
+
+    variables = {} if variables is None else variables
+    servers = self.get_host_settings() if servers is None else servers
+
+    try:
+        server = servers[index]
+    except IndexError:
+        raise ValueError(
+            "Invalid index {0} when selecting the host settings. "
+            "Must be less than {1}".format(index, len(servers)))
+
+    url = server['url']
+
+    # go through variables and replace placeholders
+    for variable_name, variable in server.get('variables', {}).items():
+        used_value = variables.get(
+            variable_name, variable['default_value'])
+
+        if 'enum_values' in variable \
+                and used_value not in variable['enum_values']:
+            raise ValueError(
+                "The variable `{0}` in the host URL has invalid value "
+                "{1}. Must be {2}.".format(
+                    variable_name, variables[variable_name],
+                    variable['enum_values']))
+
+        url = url.replace("{" + variable_name + "}", used_value)
+
+    return url
+
+
+
+ +
+ +
+ + +

+ get_host_settings() + +

+ + +
+ +

Gets an array of host settings

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

An array of host settings

+
+
+ +
+ Source code in cheshire_cat_api/configuration.py + 
366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
def get_host_settings(self):
+    """Gets an array of host settings
+
+    :return: An array of host settings
+    """
+    return [
+        {
+            'url': "",
+            'description': "No description provided",
+        }
+    ]
+
+
+
+ +
+ +
+ + +

+ set_default(default) + + + classmethod + + +

+ + +
+ +

Set default instance of configuration.

+

It stores default configuration, which can be +returned by get_default_copy method.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
default + +
+

object of Configuration

+
+ 		+ required +
+ +
+ Source code in cheshire_cat_api/configuration.py + 
194
+195
+196
+197
+198
+199
+200
+201
+202
+203
@classmethod
+def set_default(cls, default):
+    """Set default instance of configuration.
+
+    It stores default configuration, which can be
+    returned by get_default_copy method.
+
+    :param default: object of Configuration
+    """
+    cls._default = default
+
+
+
+ +
+ +
+ + +

+ to_debug_report() + +

+ + +
+ +

Gets the essential information for debugging.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

The report for debugging.

+
+
+ +
+ Source code in cheshire_cat_api/configuration.py + 
354
+355
+356
+357
+358
+359
+360
+361
+362
+363
+364
def to_debug_report(self):
+    """Gets the essential information for debugging.
+
+    :return: The report for debugging.
+    """
+    return "Python SDK Debug Report:\n"\
+           "OS: {env}\n"\
+           "Python Version: {pyversion}\n"\
+           "Version of the API: 1.3.1\n"\
+           "SDK Package Version: 1.0.0".\
+           format(env=sys.platform, pyversion=sys.version)
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/exceptions/index.html b/API_Documentation/exceptions/index.html new file mode 100644 index 0000000..1624c4a --- /dev/null +++ b/API_Documentation/exceptions/index.html @@ -0,0 +1,2242 @@ + + + + + + + + + + + + + + + + + + + + + + + exceptions - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

exceptions

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ ApiAttributeError + + +

+ + +
+

+ Bases: OpenApiException, AttributeError

+ + +
+ Source code in cheshire_cat_api/exceptions.py + 
66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ __init__(msg, path_to_item=None) + +

+ + +
+ +

Raised when an attribute reference or assignment fails.

+

Args: + msg (str): the exception message

+

Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict

+ +
+ Source code in cheshire_cat_api/exceptions.py + 
67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
def __init__(self, msg, path_to_item=None) -> None:
+    """
+    Raised when an attribute reference or assignment fails.
+
+    Args:
+        msg (str): the exception message
+
+    Keyword Args:
+        path_to_item (None/list) the path to the exception in the
+            received_data dict
+    """
+    self.path_to_item = path_to_item
+    full_msg = msg
+    if path_to_item:
+        full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+    super(ApiAttributeError, self).__init__(full_msg)
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ ApiException + + +

+ + +
+

+ Bases: OpenApiException

+ + +
+ Source code in cheshire_cat_api/exceptions.py + 
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
class ApiException(OpenApiException):
+
+    def __init__(self, status=None, reason=None, http_resp=None) -> None:
+        if http_resp:
+            self.status = http_resp.status
+            self.reason = http_resp.reason
+            self.body = http_resp.data.decode('utf-8')
+            self.headers = http_resp.getheaders()
+        else:
+            self.status = status
+            self.reason = reason
+            self.body = None
+            self.headers = None
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.body:
+            error_message += "HTTP response body: {0}\n".format(self.body)
+
+        return error_message
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ __str__() + +

+ + +
+ +

Custom error messages for exception

+ +
+ Source code in cheshire_cat_api/exceptions.py + 
116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
def __str__(self):
+    """Custom error messages for exception"""
+    error_message = "({0})\n"\
+                    "Reason: {1}\n".format(self.status, self.reason)
+    if self.headers:
+        error_message += "HTTP response headers: {0}\n".format(
+            self.headers)
+
+    if self.body:
+        error_message += "HTTP response body: {0}\n".format(self.body)
+
+    return error_message
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ ApiKeyError + + +

+ + +
+

+ Bases: OpenApiException, KeyError

+ + +
+ Source code in cheshire_cat_api/exceptions.py + 
85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ __init__(msg, path_to_item=None) + +

+ + +
+ +

Args: + msg (str): the exception message

+

Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict

+ +
+ Source code in cheshire_cat_api/exceptions.py + 
86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
def __init__(self, msg, path_to_item=None) -> None:
+    """
+    Args:
+        msg (str): the exception message
+
+    Keyword Args:
+        path_to_item (None/list) the path to the exception in the
+            received_data dict
+    """
+    self.path_to_item = path_to_item
+    full_msg = msg
+    if path_to_item:
+        full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+    super(ApiKeyError, self).__init__(full_msg)
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ ApiTypeError + + +

+ + +
+

+ Bases: OpenApiException, TypeError

+ + +
+ Source code in cheshire_cat_api/exceptions.py + 
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
class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ __init__(msg, path_to_item=None, valid_classes=None, key_type=None) + +

+ + +
+ +

Raises an exception for TypeErrors

+

Args: + msg (str): the exception message

+

Keyword Args: + path_to_item (list): a list of keys an indices to get to the + current_item + None if unset + valid_classes (tuple): the primitive classes that current item + should be an instance of + None if unset + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + None if unset

+ +
+ Source code in cheshire_cat_api/exceptions.py + 
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
def __init__(self, msg, path_to_item=None, valid_classes=None,
+             key_type=None) -> None:
+    """ Raises an exception for TypeErrors
+
+    Args:
+        msg (str): the exception message
+
+    Keyword Args:
+        path_to_item (list): a list of keys an indices to get to the
+                             current_item
+                             None if unset
+        valid_classes (tuple): the primitive classes that current item
+                               should be an instance of
+                               None if unset
+        key_type (bool): False if our value is a value in a dict
+                         True if it is a key in a dict
+                         False if our item is an item in a list
+                         None if unset
+    """
+    self.path_to_item = path_to_item
+    self.valid_classes = valid_classes
+    self.key_type = key_type
+    full_msg = msg
+    if path_to_item:
+        full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+    super(ApiTypeError, self).__init__(full_msg)
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ ApiValueError + + +

+ + +
+

+ Bases: OpenApiException, ValueError

+ + +
+ Source code in cheshire_cat_api/exceptions.py + 
48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ __init__(msg, path_to_item=None) + +

+ + +
+ +

Args: + msg (str): the exception message

+

Keyword Args: + path_to_item (list) the path to the exception in the + received_data dict. None if unset

+ +
+ Source code in cheshire_cat_api/exceptions.py + 
49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
def __init__(self, msg, path_to_item=None) -> None:
+    """
+    Args:
+        msg (str): the exception message
+
+    Keyword Args:
+        path_to_item (list) the path to the exception in the
+            received_data dict. None if unset
+    """
+
+    self.path_to_item = path_to_item
+    full_msg = msg
+    if path_to_item:
+        full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+    super(ApiValueError, self).__init__(full_msg)
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ OpenApiException + + +

+ + +
+

+ Bases: Exception

+ + +

The base exception class for all OpenAPIExceptions

+ +
+ Source code in cheshire_cat_api/exceptions.py + 
15
+16
class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+ +
+ +
+ + +
+ + +

+ render_path(path_to_item) + +

+ + +
+ +

Returns a string representation of a path

+ +
+ Source code in cheshire_cat_api/exceptions.py + 
158
+159
+160
+161
+162
+163
+164
+165
+166
def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/models/body_upload_url/index.html b/API_Documentation/models/body_upload_url/index.html new file mode 100644 index 0000000..6b84d2d --- /dev/null +++ b/API_Documentation/models/body_upload_url/index.html @@ -0,0 +1,1693 @@ + + + + + + + + + + + + + + + + + + + + + + + body_upload_url - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

body_upload_url

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ BodyUploadUrl + + +

+ + +
+

+ Bases: BaseModel

+ + +

BodyUploadUrl

+ +
+ Source code in cheshire_cat_api/models/body_upload_url.py + 
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
class BodyUploadUrl(BaseModel):
+    """
+    BodyUploadUrl
+    """ # noqa: E501
+    url: StrictStr = Field(description="URL of the website to which you want to save the content")
+    chunk_size: Optional[StrictInt] = Field(default=400, description="Maximum length of each chunk after the document is split (in characters)")
+    chunk_overlap: Optional[StrictInt] = Field(default=100, description="Chunk overlap (in characters)")
+    __properties: ClassVar[List[str]] = ["url", "chunk_size", "chunk_overlap"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BodyUploadUrl from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of BodyUploadUrl from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "url": obj.get("url"),
+            "chunk_size": obj.get("chunk_size") if obj.get("chunk_size") is not None else 400,
+            "chunk_overlap": obj.get("chunk_overlap") if obj.get("chunk_overlap") is not None else 100
+        })
+        return _obj
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ from_dict(obj) + + + classmethod + + +

+ + +
+ +

Create an instance of BodyUploadUrl from a dict

+ +
+ Source code in cheshire_cat_api/models/body_upload_url.py + 
76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
@classmethod
+def from_dict(cls, obj: Dict) -> Self:
+    """Create an instance of BodyUploadUrl from a dict"""
+    if obj is None:
+        return None
+
+    if not isinstance(obj, dict):
+        return cls.model_validate(obj)
+
+    _obj = cls.model_validate({
+        "url": obj.get("url"),
+        "chunk_size": obj.get("chunk_size") if obj.get("chunk_size") is not None else 400,
+        "chunk_overlap": obj.get("chunk_overlap") if obj.get("chunk_overlap") is not None else 100
+    })
+    return _obj
+
+
+
+ +
+ +
+ + +

+ from_json(json_str) + + + classmethod + + +

+ + +
+ +

Create an instance of BodyUploadUrl from a JSON string

+ +
+ Source code in cheshire_cat_api/models/body_upload_url.py + 
53
+54
+55
+56
@classmethod
+def from_json(cls, json_str: str) -> Self:
+    """Create an instance of BodyUploadUrl from a JSON string"""
+    return cls.from_dict(json.loads(json_str))
+
+
+
+ +
+ +
+ + +

+ to_dict() + +

+ + +
+ +

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic's +self.model_dump(by_alias=True):

+
    +
  • None is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value None + are ignored.
    • +
+ +
+ Source code in cheshire_cat_api/models/body_upload_url.py + 
58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
def to_dict(self) -> Dict[str, Any]:
+    """Return the dictionary representation of the model using alias.
+
+    This has the following differences from calling pydantic's
+    `self.model_dump(by_alias=True)`:
+
+    * `None` is only added to the output dict for nullable fields that
+      were set at model initialization. Other fields with value `None`
+      are ignored.
+    """
+    _dict = self.model_dump(
+        by_alias=True,
+        exclude={
+        },
+        exclude_none=True,
+    )
+    return _dict
+
+
+
+ +
+ +
+ + +

+ to_json() + +

+ + +
+ +

Returns the JSON representation of the model using alias

+ +
+ Source code in cheshire_cat_api/models/body_upload_url.py + 
48
+49
+50
+51
def to_json(self) -> str:
+    """Returns the JSON representation of the model using alias"""
+    # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+    return json.dumps(self.to_dict())
+
+
+
+ +
+ +
+ + +

+ to_str() + +

+ + +
+ +

Returns the string representation of the model using alias

+ +
+ Source code in cheshire_cat_api/models/body_upload_url.py + 
44
+45
+46
def to_str(self) -> str:
+    """Returns the string representation of the model using alias"""
+    return pprint.pformat(self.model_dump(by_alias=True))
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/models/http_validation_error/index.html b/API_Documentation/models/http_validation_error/index.html new file mode 100644 index 0000000..acbbaa6 --- /dev/null +++ b/API_Documentation/models/http_validation_error/index.html @@ -0,0 +1,1709 @@ + + + + + + + + + + + + + + + + + + + + + + + http_validation_error - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

http_validation_error

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ HTTPValidationError + + +

+ + +
+

+ Bases: BaseModel

+ + +

HTTPValidationError

+ +
+ Source code in cheshire_cat_api/models/http_validation_error.py + 
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
class HTTPValidationError(BaseModel):
+    """
+    HTTPValidationError
+    """ # noqa: E501
+    detail: Optional[List[ValidationError]] = None
+    __properties: ClassVar[List[str]] = ["detail"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of HTTPValidationError from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in detail (list)
+        _items = []
+        if self.detail:
+            for _item in self.detail:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['detail'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of HTTPValidationError from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "detail": [ValidationError.from_dict(_item) for _item in obj.get("detail")] if obj.get("detail") is not None else None
+        })
+        return _obj
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ from_dict(obj) + + + classmethod + + +

+ + +
+ +

Create an instance of HTTPValidationError from a dict

+ +
+ Source code in cheshire_cat_api/models/http_validation_error.py + 
81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93
@classmethod
+def from_dict(cls, obj: Dict) -> Self:
+    """Create an instance of HTTPValidationError from a dict"""
+    if obj is None:
+        return None
+
+    if not isinstance(obj, dict):
+        return cls.model_validate(obj)
+
+    _obj = cls.model_validate({
+        "detail": [ValidationError.from_dict(_item) for _item in obj.get("detail")] if obj.get("detail") is not None else None
+    })
+    return _obj
+
+
+
+ +
+ +
+ + +

+ from_json(json_str) + + + classmethod + + +

+ + +
+ +

Create an instance of HTTPValidationError from a JSON string

+ +
+ Source code in cheshire_cat_api/models/http_validation_error.py + 
51
+52
+53
+54
@classmethod
+def from_json(cls, json_str: str) -> Self:
+    """Create an instance of HTTPValidationError from a JSON string"""
+    return cls.from_dict(json.loads(json_str))
+
+
+
+ +
+ +
+ + +

+ to_dict() + +

+ + +
+ +

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic's +self.model_dump(by_alias=True):

+
    +
  • None is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value None + are ignored.
    • +
+ +
+ Source code in cheshire_cat_api/models/http_validation_error.py + 
56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
def to_dict(self) -> Dict[str, Any]:
+    """Return the dictionary representation of the model using alias.
+
+    This has the following differences from calling pydantic's
+    `self.model_dump(by_alias=True)`:
+
+    * `None` is only added to the output dict for nullable fields that
+      were set at model initialization. Other fields with value `None`
+      are ignored.
+    """
+    _dict = self.model_dump(
+        by_alias=True,
+        exclude={
+        },
+        exclude_none=True,
+    )
+    # override the default output from pydantic by calling `to_dict()` of each item in detail (list)
+    _items = []
+    if self.detail:
+        for _item in self.detail:
+            if _item:
+                _items.append(_item.to_dict())
+        _dict['detail'] = _items
+    return _dict
+
+
+
+ +
+ +
+ + +

+ to_json() + +

+ + +
+ +

Returns the JSON representation of the model using alias

+ +
+ Source code in cheshire_cat_api/models/http_validation_error.py + 
46
+47
+48
+49
def to_json(self) -> str:
+    """Returns the JSON representation of the model using alias"""
+    # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+    return json.dumps(self.to_dict())
+
+
+
+ +
+ +
+ + +

+ to_str() + +

+ + +
+ +

Returns the string representation of the model using alias

+ +
+ Source code in cheshire_cat_api/models/http_validation_error.py + 
42
+43
+44
def to_str(self) -> str:
+    """Returns the string representation of the model using alias"""
+    return pprint.pformat(self.model_dump(by_alias=True))
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/models/location_inner/index.html b/API_Documentation/models/location_inner/index.html new file mode 100644 index 0000000..645880a --- /dev/null +++ b/API_Documentation/models/location_inner/index.html @@ -0,0 +1,1758 @@ + + + + + + + + + + + + + + + + + + + + + + + location_inner - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

location_inner

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ LocationInner + + +

+ + +
+

+ Bases: BaseModel

+ + +

LocationInner

+ +
+ Source code in cheshire_cat_api/models/location_inner.py + 
 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
class LocationInner(BaseModel):
+    """
+    LocationInner
+    """
+
+    # data type: str
+    anyof_schema_1_validator: Optional[StrictStr] = None
+    # data type: int
+    anyof_schema_2_validator: Optional[StrictInt] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[int, str]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: List[str] = Literal[LOCATIONINNER_ANY_OF_SCHEMAS]
+
+    model_config = {
+        "validate_assignment": True
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = LocationInner.model_construct()
+        error_messages = []
+        # validate data type: str
+        try:
+            instance.anyof_schema_1_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: int
+        try:
+            instance.anyof_schema_2_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in LocationInner with anyOf schemas: int, str. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # deserialize data into str
+        try:
+            # validation
+            instance.anyof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_1_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into int
+        try:
+            # validation
+            instance.anyof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_2_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into LocationInner with anyOf schemas: int, str. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        to_json = getattr(self.actual_instance, "to_json", None)
+        if callable(to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Dict:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        to_json = getattr(self.actual_instance, "to_json", None)
+        if callable(to_json):
+            return self.actual_instance.to_dict()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ from_json(json_str) + + + classmethod + + +

+ + +
+ +

Returns the object represented by the json string

+ +
+ Source code in cheshire_cat_api/models/location_inner.py + 
 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
@classmethod
+def from_json(cls, json_str: str) -> Self:
+    """Returns the object represented by the json string"""
+    instance = cls.model_construct()
+    error_messages = []
+    # deserialize data into str
+    try:
+        # validation
+        instance.anyof_schema_1_validator = json.loads(json_str)
+        # assign value to actual_instance
+        instance.actual_instance = instance.anyof_schema_1_validator
+        return instance
+    except (ValidationError, ValueError) as e:
+        error_messages.append(str(e))
+    # deserialize data into int
+    try:
+        # validation
+        instance.anyof_schema_2_validator = json.loads(json_str)
+        # assign value to actual_instance
+        instance.actual_instance = instance.anyof_schema_2_validator
+        return instance
+    except (ValidationError, ValueError) as e:
+        error_messages.append(str(e))
+
+    if error_messages:
+        # no match
+        raise ValueError("No match found when deserializing the JSON string into LocationInner with anyOf schemas: int, str. Details: " + ", ".join(error_messages))
+    else:
+        return instance
+
+
+
+ +
+ +
+ + +

+ to_dict() + +

+ + +
+ +

Returns the dict representation of the actual instance

+ +
+ Source code in cheshire_cat_api/models/location_inner.py + 
129
+130
+131
+132
+133
+134
+135
+136
+137
+138
def to_dict(self) -> Dict:
+    """Returns the dict representation of the actual instance"""
+    if self.actual_instance is None:
+        return "null"
+
+    to_json = getattr(self.actual_instance, "to_json", None)
+    if callable(to_json):
+        return self.actual_instance.to_dict()
+    else:
+        return json.dumps(self.actual_instance)
+
+
+
+ +
+ +
+ + +

+ to_json() + +

+ + +
+ +

Returns the JSON representation of the actual instance

+ +
+ Source code in cheshire_cat_api/models/location_inner.py + 
118
+119
+120
+121
+122
+123
+124
+125
+126
+127
def to_json(self) -> str:
+    """Returns the JSON representation of the actual instance"""
+    if self.actual_instance is None:
+        return "null"
+
+    to_json = getattr(self.actual_instance, "to_json", None)
+    if callable(to_json):
+        return self.actual_instance.to_json()
+    else:
+        return json.dumps(self.actual_instance)
+
+
+
+ +
+ +
+ + +

+ to_str() + +

+ + +
+ +

Returns the string representation of the actual instance

+ +
+ Source code in cheshire_cat_api/models/location_inner.py + 
140
+141
+142
def to_str(self) -> str:
+    """Returns the string representation of the actual instance"""
+    return pprint.pformat(self.model_dump())
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/models/setting_body/index.html b/API_Documentation/models/setting_body/index.html new file mode 100644 index 0000000..d6d0fc9 --- /dev/null +++ b/API_Documentation/models/setting_body/index.html @@ -0,0 +1,1725 @@ + + + + + + + + + + + + + + + + + + + + + + + setting_body - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

setting_body

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ SettingBody + + +

+ + +
+

+ Bases: BaseModel

+ + +

SettingBody

+ +
+ Source code in cheshire_cat_api/models/setting_body.py + 
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
class SettingBody(BaseModel):
+    """
+    SettingBody
+    """ # noqa: E501
+    name: StrictStr
+    value: Value
+    category: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["name", "value", "category"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SettingBody from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of value
+        if self.value:
+            _dict['value'] = self.value.to_dict()
+        # set to None if category (nullable) is None
+        # and model_fields_set contains the field
+        if self.category is None and "category" in self.model_fields_set:
+            _dict['category'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of SettingBody from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "value": Value.from_dict(obj.get("value")) if obj.get("value") is not None else None,
+            "category": obj.get("category")
+        })
+        return _obj
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ from_dict(obj) + + + classmethod + + +

+ + +
+ +

Create an instance of SettingBody from a dict

+ +
+ Source code in cheshire_cat_api/models/setting_body.py + 
84
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
@classmethod
+def from_dict(cls, obj: Dict) -> Self:
+    """Create an instance of SettingBody from a dict"""
+    if obj is None:
+        return None
+
+    if not isinstance(obj, dict):
+        return cls.model_validate(obj)
+
+    _obj = cls.model_validate({
+        "name": obj.get("name"),
+        "value": Value.from_dict(obj.get("value")) if obj.get("value") is not None else None,
+        "category": obj.get("category")
+    })
+    return _obj
+
+
+
+ +
+ +
+ + +

+ from_json(json_str) + + + classmethod + + +

+ + +
+ +

Create an instance of SettingBody from a JSON string

+ +
+ Source code in cheshire_cat_api/models/setting_body.py + 
53
+54
+55
+56
@classmethod
+def from_json(cls, json_str: str) -> Self:
+    """Create an instance of SettingBody from a JSON string"""
+    return cls.from_dict(json.loads(json_str))
+
+
+
+ +
+ +
+ + +

+ to_dict() + +

+ + +
+ +

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic's +self.model_dump(by_alias=True):

+
    +
  • None is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value None + are ignored.
    • +
+ +
+ Source code in cheshire_cat_api/models/setting_body.py + 
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
def to_dict(self) -> Dict[str, Any]:
+    """Return the dictionary representation of the model using alias.
+
+    This has the following differences from calling pydantic's
+    `self.model_dump(by_alias=True)`:
+
+    * `None` is only added to the output dict for nullable fields that
+      were set at model initialization. Other fields with value `None`
+      are ignored.
+    """
+    _dict = self.model_dump(
+        by_alias=True,
+        exclude={
+        },
+        exclude_none=True,
+    )
+    # override the default output from pydantic by calling `to_dict()` of value
+    if self.value:
+        _dict['value'] = self.value.to_dict()
+    # set to None if category (nullable) is None
+    # and model_fields_set contains the field
+    if self.category is None and "category" in self.model_fields_set:
+        _dict['category'] = None
+
+    return _dict
+
+
+
+ +
+ +
+ + +

+ to_json() + +

+ + +
+ +

Returns the JSON representation of the model using alias

+ +
+ Source code in cheshire_cat_api/models/setting_body.py + 
48
+49
+50
+51
def to_json(self) -> str:
+    """Returns the JSON representation of the model using alias"""
+    # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+    return json.dumps(self.to_dict())
+
+
+
+ +
+ +
+ + +

+ to_str() + +

+ + +
+ +

Returns the string representation of the model using alias

+ +
+ Source code in cheshire_cat_api/models/setting_body.py + 
44
+45
+46
def to_str(self) -> str:
+    """Returns the string representation of the model using alias"""
+    return pprint.pformat(self.model_dump(by_alias=True))
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/models/validation_error/index.html b/API_Documentation/models/validation_error/index.html new file mode 100644 index 0000000..389055f --- /dev/null +++ b/API_Documentation/models/validation_error/index.html @@ -0,0 +1,1721 @@ + + + + + + + + + + + + + + + + + + + + + + + validation_error - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

validation_error

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ ValidationError + + +

+ + +
+

+ Bases: BaseModel

+ + +

ValidationError

+ +
+ Source code in cheshire_cat_api/models/validation_error.py + 
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
class ValidationError(BaseModel):
+    """
+    ValidationError
+    """ # noqa: E501
+    loc: List[LocationInner]
+    msg: StrictStr
+    type: StrictStr
+    __properties: ClassVar[List[str]] = ["loc", "msg", "type"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ValidationError from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in loc (list)
+        _items = []
+        if self.loc:
+            for _item in self.loc:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['loc'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of ValidationError from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "loc": [LocationInner.from_dict(_item) for _item in obj.get("loc")] if obj.get("loc") is not None else None,
+            "msg": obj.get("msg"),
+            "type": obj.get("type")
+        })
+        return _obj
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ from_dict(obj) + + + classmethod + + +

+ + +
+ +

Create an instance of ValidationError from a dict

+ +
+ Source code in cheshire_cat_api/models/validation_error.py + 
83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
@classmethod
+def from_dict(cls, obj: Dict) -> Self:
+    """Create an instance of ValidationError from a dict"""
+    if obj is None:
+        return None
+
+    if not isinstance(obj, dict):
+        return cls.model_validate(obj)
+
+    _obj = cls.model_validate({
+        "loc": [LocationInner.from_dict(_item) for _item in obj.get("loc")] if obj.get("loc") is not None else None,
+        "msg": obj.get("msg"),
+        "type": obj.get("type")
+    })
+    return _obj
+
+
+
+ +
+ +
+ + +

+ from_json(json_str) + + + classmethod + + +

+ + +
+ +

Create an instance of ValidationError from a JSON string

+ +
+ Source code in cheshire_cat_api/models/validation_error.py + 
53
+54
+55
+56
@classmethod
+def from_json(cls, json_str: str) -> Self:
+    """Create an instance of ValidationError from a JSON string"""
+    return cls.from_dict(json.loads(json_str))
+
+
+
+ +
+ +
+ + +

+ to_dict() + +

+ + +
+ +

Return the dictionary representation of the model using alias.

+

This has the following differences from calling pydantic's +self.model_dump(by_alias=True):

+
    +
  • None is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value None + are ignored.
    • +
+ +
+ Source code in cheshire_cat_api/models/validation_error.py + 
58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
def to_dict(self) -> Dict[str, Any]:
+    """Return the dictionary representation of the model using alias.
+
+    This has the following differences from calling pydantic's
+    `self.model_dump(by_alias=True)`:
+
+    * `None` is only added to the output dict for nullable fields that
+      were set at model initialization. Other fields with value `None`
+      are ignored.
+    """
+    _dict = self.model_dump(
+        by_alias=True,
+        exclude={
+        },
+        exclude_none=True,
+    )
+    # override the default output from pydantic by calling `to_dict()` of each item in loc (list)
+    _items = []
+    if self.loc:
+        for _item in self.loc:
+            if _item:
+                _items.append(_item.to_dict())
+        _dict['loc'] = _items
+    return _dict
+
+
+
+ +
+ +
+ + +

+ to_json() + +

+ + +
+ +

Returns the JSON representation of the model using alias

+ +
+ Source code in cheshire_cat_api/models/validation_error.py + 
48
+49
+50
+51
def to_json(self) -> str:
+    """Returns the JSON representation of the model using alias"""
+    # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+    return json.dumps(self.to_dict())
+
+
+
+ +
+ +
+ + +

+ to_str() + +

+ + +
+ +

Returns the string representation of the model using alias

+ +
+ Source code in cheshire_cat_api/models/validation_error.py + 
44
+45
+46
def to_str(self) -> str:
+    """Returns the string representation of the model using alias"""
+    return pprint.pformat(self.model_dump(by_alias=True))
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/models/value/index.html b/API_Documentation/models/value/index.html new file mode 100644 index 0000000..3cd0986 --- /dev/null +++ b/API_Documentation/models/value/index.html @@ -0,0 +1,1758 @@ + + + + + + + + + + + + + + + + + + + + + + + value - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

value

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ Value + + +

+ + +
+

+ Bases: BaseModel

+ + +

Value

+ +
+ Source code in cheshire_cat_api/models/value.py + 
 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
class Value(BaseModel):
+    """
+    Value
+    """
+
+    # data type: object
+    anyof_schema_1_validator: Optional[Union[str, Any]] = None
+    # data type: List[object]
+    anyof_schema_2_validator: Optional[List[Any]] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[List[object], object]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: List[str] = Literal[VALUE_ANY_OF_SCHEMAS]
+
+    model_config = {
+        "validate_assignment": True
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = Value.model_construct()
+        error_messages = []
+        # validate data type: object
+        try:
+            instance.anyof_schema_1_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: List[object]
+        try:
+            instance.anyof_schema_2_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in Value with anyOf schemas: List[object], object. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # deserialize data into object
+        try:
+            # validation
+            instance.anyof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_1_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into List[object]
+        try:
+            # validation
+            instance.anyof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_2_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into Value with anyOf schemas: List[object], object. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        to_json = getattr(self.actual_instance, "to_json", None)
+        if callable(to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Dict:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        to_json = getattr(self.actual_instance, "to_json", None)
+        if callable(to_json):
+            return self.actual_instance.to_dict()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ from_json(json_str) + + + classmethod + + +

+ + +
+ +

Returns the object represented by the json string

+ +
+ Source code in cheshire_cat_api/models/value.py + 
 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
@classmethod
+def from_json(cls, json_str: str) -> Self:
+    """Returns the object represented by the json string"""
+    instance = cls.model_construct()
+    error_messages = []
+    # deserialize data into object
+    try:
+        # validation
+        instance.anyof_schema_1_validator = json.loads(json_str)
+        # assign value to actual_instance
+        instance.actual_instance = instance.anyof_schema_1_validator
+        return instance
+    except (ValidationError, ValueError) as e:
+        error_messages.append(str(e))
+    # deserialize data into List[object]
+    try:
+        # validation
+        instance.anyof_schema_2_validator = json.loads(json_str)
+        # assign value to actual_instance
+        instance.actual_instance = instance.anyof_schema_2_validator
+        return instance
+    except (ValidationError, ValueError) as e:
+        error_messages.append(str(e))
+
+    if error_messages:
+        # no match
+        raise ValueError("No match found when deserializing the JSON string into Value with anyOf schemas: List[object], object. Details: " + ", ".join(error_messages))
+    else:
+        return instance
+
+
+
+ +
+ +
+ + +

+ to_dict() + +

+ + +
+ +

Returns the dict representation of the actual instance

+ +
+ Source code in cheshire_cat_api/models/value.py + 
129
+130
+131
+132
+133
+134
+135
+136
+137
+138
def to_dict(self) -> Dict:
+    """Returns the dict representation of the actual instance"""
+    if self.actual_instance is None:
+        return "null"
+
+    to_json = getattr(self.actual_instance, "to_json", None)
+    if callable(to_json):
+        return self.actual_instance.to_dict()
+    else:
+        return json.dumps(self.actual_instance)
+
+
+
+ +
+ +
+ + +

+ to_json() + +

+ + +
+ +

Returns the JSON representation of the actual instance

+ +
+ Source code in cheshire_cat_api/models/value.py + 
118
+119
+120
+121
+122
+123
+124
+125
+126
+127
def to_json(self) -> str:
+    """Returns the JSON representation of the actual instance"""
+    if self.actual_instance is None:
+        return "null"
+
+    to_json = getattr(self.actual_instance, "to_json", None)
+    if callable(to_json):
+        return self.actual_instance.to_json()
+    else:
+        return json.dumps(self.actual_instance)
+
+
+
+ +
+ +
+ + +

+ to_str() + +

+ + +
+ +

Returns the string representation of the actual instance

+ +
+ Source code in cheshire_cat_api/models/value.py + 
140
+141
+142
def to_str(self) -> str:
+    """Returns the string representation of the actual instance"""
+    return pprint.pformat(self.model_dump())
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/API_Documentation/rest/index.html b/API_Documentation/rest/index.html new file mode 100644 index 0000000..4d7f1c6 --- /dev/null +++ b/API_Documentation/rest/index.html @@ -0,0 +1,2219 @@ + + + + + + + + + + + + + + + + + + + + + rest - The Cheshire Cat API Python Client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

rest

+ +
+ + + + +
+ +

😸 Cheshire-Cat API

+

Production ready AI assistant framework

+

The version of the OpenAPI document: 1.3.1 +Generated by OpenAPI Generator (https://openapi-generator.tech)

+

Do not edit the class manually.

+ + + +
+ + + + + + + + +
+ + + +

+ RESTClientObject + + +

+ + +
+ + +
+ Source code in cheshire_cat_api/rest.py + 
 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
class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        addition_pool_args = {}
+        if configuration.assert_hostname is not None:
+            addition_pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            addition_pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            addition_pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            addition_pool_args['socket_options'] = configuration.socket_options
+
+        # https pool manager
+        if configuration.proxy:
+            self.pool_manager = urllib3.ProxyManager(
+                cert_reqs=cert_reqs,
+                ca_certs=configuration.ssl_ca_cert,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                proxy_url=configuration.proxy,
+                proxy_headers=configuration.proxy_headers,
+                **addition_pool_args
+            )
+        else:
+            self.pool_manager = urllib3.PoolManager(
+                cert_reqs=cert_reqs,
+                ca_certs=configuration.ssl_ca_cert,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                **addition_pool_args
+            )
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than Json when `body` argument is
+                # provided in serialized form
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    request_body = body
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ request(method, url, headers=None, body=None, post_params=None, _request_timeout=None) + +

+ + +
+ +

Perform requests.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
method + +
+

http request method

+
+ 		+ required +
url + +
+

http request url

+
+ 		+ required +
headers + +
+

http request headers

+
+ 		+ None +
body + +
+

request json body, for application/json

+
+ 		+ None +
post_params + +
+

request post parameters, application/x-www-form-urlencoded and multipart/form-data

+
+ 		+ None +
_request_timeout + +
+

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

+
+ 		+ None +
+ +
+ Source code in cheshire_cat_api/rest.py + 
 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
def request(
+    self,
+    method,
+    url,
+    headers=None,
+    body=None,
+    post_params=None,
+    _request_timeout=None
+):
+    """Perform requests.
+
+    :param method: http request method
+    :param url: http request url
+    :param headers: http request headers
+    :param body: request json body, for `application/json`
+    :param post_params: request post parameters,
+                        `application/x-www-form-urlencoded`
+                        and `multipart/form-data`
+    :param _request_timeout: timeout setting for this request. If one
+                             number provided, it will be total request
+                             timeout. It can also be a pair (tuple) of
+                             (connection, read) timeouts.
+    """
+    method = method.upper()
+    assert method in [
+        'GET',
+        'HEAD',
+        'DELETE',
+        'POST',
+        'PUT',
+        'PATCH',
+        'OPTIONS'
+    ]
+
+    if post_params and body:
+        raise ApiValueError(
+            "body parameter cannot be used with post_params parameter."
+        )
+
+    post_params = post_params or {}
+    headers = headers or {}
+
+    timeout = None
+    if _request_timeout:
+        if isinstance(_request_timeout, (int, float)):
+            timeout = urllib3.Timeout(total=_request_timeout)
+        elif (
+                isinstance(_request_timeout, tuple)
+                and len(_request_timeout) == 2
+            ):
+            timeout = urllib3.Timeout(
+                connect=_request_timeout[0],
+                read=_request_timeout[1]
+            )
+
+    try:
+        # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+        if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+            # no content type provided or payload is json
+            content_type = headers.get('Content-Type')
+            if (
+                not content_type
+                or re.search('json', content_type, re.IGNORECASE)
+            ):
+                request_body = None
+                if body is not None:
+                    request_body = json.dumps(body)
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    body=request_body,
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+            elif content_type == 'application/x-www-form-urlencoded':
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields=post_params,
+                    encode_multipart=False,
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+            elif content_type == 'multipart/form-data':
+                # must del headers['Content-Type'], or the correct
+                # Content-Type which generated by urllib3 will be
+                # overwritten.
+                del headers['Content-Type']
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields=post_params,
+                    encode_multipart=True,
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+            # Pass a `string` parameter directly in the body to support
+            # other content types than Json when `body` argument is
+            # provided in serialized form
+            elif isinstance(body, str) or isinstance(body, bytes):
+                request_body = body
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    body=request_body,
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+            else:
+                # Cannot generate the request from given parameters
+                msg = """Cannot prepare a request message for provided
+                         arguments. Please check that your arguments match
+                         declared content type."""
+                raise ApiException(status=0, reason=msg)
+        # For `GET`, `HEAD`
+        else:
+            r = self.pool_manager.request(
+                method,
+                url,
+                fields={},
+                timeout=timeout,
+                headers=headers,
+                preload_content=False
+            )
+    except urllib3.exceptions.SSLError as e:
+        msg = "\n".join([type(e).__name__, str(e)])
+        raise ApiException(status=0, reason=msg)
+
+    return RESTResponse(r)
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ RESTResponse + + +

+ + +
+

+ Bases: IOBase

+ + +
+ Source code in cheshire_cat_api/rest.py + 
26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ getheader(name, default=None) + +

+ + +
+ +

Returns a given response header.

+ +
+ Source code in cheshire_cat_api/rest.py + 
43
+44
+45
def getheader(self, name, default=None):
+    """Returns a given response header."""
+    return self.response.headers.get(name, default)
+
+
+
+ +
+ +
+ + +

+ getheaders() + +

+ + +
+ +

Returns a dictionary of the response headers.

+ +
+ Source code in cheshire_cat_api/rest.py + 
39
+40
+41
def getheaders(self):
+    """Returns a dictionary of the response headers."""
+    return self.response.headers
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css new file mode 100644 index 0000000..85449ec --- /dev/null +++ b/assets/_mkdocstrings.css @@ -0,0 +1,119 @@ + +/* Avoid breaking parameter names, etc. in table cells. */ +.doc-contents td code { + word-break: normal !important; +} + +/* No line break before first paragraph of descriptions. */ +.doc-md-description, +.doc-md-description>p:first-child { + display: inline; +} + +/* Max width for docstring sections tables. */ +.doc .md-typeset__table, +.doc .md-typeset__table table { + display: table !important; + width: 100%; +} + +.doc .md-typeset__table tr { + display: table-row; +} + +/* Defaults in Spacy table style. */ +.doc-param-default { + float: right; +} + +/* Backward-compatibility: docstring section titles in bold. */ +.doc-section-title { + font-weight: bold; +} + +/* Symbols in Navigation and ToC. */ +:root, +[data-md-color-scheme="default"] { + --doc-symbol-attribute-fg-color: #953800; + --doc-symbol-function-fg-color: #8250df; + --doc-symbol-method-fg-color: #8250df; + --doc-symbol-class-fg-color: #0550ae; + --doc-symbol-module-fg-color: #5cad0f; + + --doc-symbol-attribute-bg-color: #9538001a; + --doc-symbol-function-bg-color: #8250df1a; + --doc-symbol-method-bg-color: #8250df1a; + --doc-symbol-class-bg-color: #0550ae1a; + --doc-symbol-module-bg-color: #5cad0f1a; +} + +[data-md-color-scheme="slate"] { + --doc-symbol-attribute-fg-color: #ffa657; + --doc-symbol-function-fg-color: #d2a8ff; + --doc-symbol-method-fg-color: #d2a8ff; + --doc-symbol-class-fg-color: #79c0ff; + --doc-symbol-module-fg-color: #baff79; + + --doc-symbol-attribute-bg-color: #ffa6571a; + --doc-symbol-function-bg-color: #d2a8ff1a; + --doc-symbol-method-bg-color: #d2a8ff1a; + --doc-symbol-class-bg-color: #79c0ff1a; + --doc-symbol-module-bg-color: #baff791a; +} + +code.doc-symbol { + border-radius: .1rem; + font-size: .85em; + padding: 0 .3em; + font-weight: bold; +} + +code.doc-symbol-attribute { + color: var(--doc-symbol-attribute-fg-color); + background-color: var(--doc-symbol-attribute-bg-color); +} + +code.doc-symbol-attribute::after { + content: "attr"; +} + +code.doc-symbol-function { + color: var(--doc-symbol-function-fg-color); + background-color: var(--doc-symbol-function-bg-color); +} + +code.doc-symbol-function::after { + content: "func"; +} + +code.doc-symbol-method { + color: var(--doc-symbol-method-fg-color); + background-color: var(--doc-symbol-method-bg-color); +} + +code.doc-symbol-method::after { + content: "meth"; +} + +code.doc-symbol-class { + color: var(--doc-symbol-class-fg-color); + background-color: var(--doc-symbol-class-bg-color); +} + +code.doc-symbol-class::after { + content: "class"; +} + +code.doc-symbol-module { + color: var(--doc-symbol-module-fg-color); + background-color: var(--doc-symbol-module-bg-color); +} + +code.doc-symbol-module::after { + content: "mod"; +} + +.doc-signature .autorefs { + color: inherit; + border-bottom: 1px dotted currentcolor; +} diff --git a/assets/cheshire-cat-logo.svg b/assets/cheshire-cat-logo.svg new file mode 100644 index 0000000..ccdfbf4 --- /dev/null +++ b/assets/cheshire-cat-logo.svg @@ -0,0 +1,14 @@ + + + + + + + + + + \ No newline at end of file diff --git a/assets/favicon.ico b/assets/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..7aff06eeaca4b0d476da5d0ab1be1bac3bbf8f34 GIT binary patch literal 15086 zcmeI23vgA%8OJvS4Ub4di?%CHli7{Cw+Y}WUWT9Eq!2Q%ShXq%~@DE9cx zh8FM*Xb0_~4IBeUMe$*6u$PZX@CMX_;y(xR;0NOj&RE3w#JR{!d9i0hcv4Zt5Ndr@|Ci0lPu|H8y);Csg_DK-Rzk z(D+#t$6N3)oC~dj@u16s)}ZB~QJka270pU7(n^!D5&Q!=NAZfC3+- zr5g%Y!@aN!-UszpF?|N*a3$o0#e#kSXq-lem8a8DuM6A&?ZwqVfOgRf&MTLszGgN z{^@zP2&?1ju+bdLa&5-Qg0r71WOA)+G2obc2lcO4}~=3gIcx+NuNj4t);j6~n8r z6-pp}CXhZI-UG${4?nNC&w+)YbsOAMWcxX6fyY5>Hphug&$>C}L!O^bnCJfZ=)8CW zG=lqwLh?V88w`q@VNk`;b~^1uzF{K=x7CgWW9X4Vs7A`^rJ>ir3(` z@KexuHMjAR?g$!Nwetb!>Yea|PJ5yHslD(!5S!P?5l{=NtA2bN-thBL;&yGcxBLmL zKex=LHCJT!0%%U=Do~{2`!~o=&%D8$MAs9vpTy=EQhVF;pgL;vE_l<=+xEibMr`(m z*lAs8U2YF43-hDry#)IDeVFdo(>gpY;Q@qXu;~Lk{5m>UG_S(iadn?yb2+RDu~ppa z|ED2ku8&~)ZS1wzodi0|RX#o>MKxf0sI^faY{Eo1lIZw%TWcdN;q0 za{1L>ApK*Ia_^>GYsvMIF0HwHKjgx)4C+3L?PyT_RBbGv{6^pAkH}^T10Kjwev5CL z%BL;U{-AkttlS_kgm)laOe!yd5fN-Z#^zU``L_Z>&jQ;G%FDpUmrnix+g?sx?eE&F zwARAvD(;WqX=o4HGo!3)?G5|kHHh!Awp~|Jp2_$tM(wMeAO|Lc=4{xxCR^2JWoUj#ZQtS+6L>&HKaIv+y1^j412S`YgwO0BG#3E{c4_U8`Yf{AvHt86L%7 zV{J74H$W!iq_(Dq#q8>^=?B_#8yj1cdb%g+P8r44wVB|?8kWXqA#81gZ?~Nzk=7a? z85Xmv!=^R-{VN#1?vm%Yv4*9w(VlGY&qrb$8|zbN`bl9i2X)xZfX23Sr0TszO!4>I zV9ahFyK5rGzaG0%cnLOx&fj!rk?t|NM`-WYI4y@Leb$_4@c!k-ZPVDD1vL@;-l;m+ z>F#qp41!Uhd(b`b5IhWuvka~Wy^HCcB=)@!se7o-kaT^RX5&jI@zoCWyi)nxMR|jF z>U6$?<@o3Z|4h@C?t>Qx>n6)%t9$UgG(MlCJmp==^^fg9miubO20j$qrC{$QdUiA60_Y2|Jq6hh z!tNB><2pxe&$XkT?h@<39hX_;6UNW2W7F8^98}y-f%@$FP+I%!zu*+rL24aL1J_Pt z|1;~eF_QYj!H(TKqalNVq7IdSBaqbw|L9{TLG} zxBL1kUsgy~XM49vmYHJd>k4Y~_93f1?+y=H<#}5rS9xA-DRM@oS66Jzg3iXPN46?5 zMa2ci%r7)1XNEC#{3}ydO!5y*mC7T(cSx4?lAN4X#!9I*x5Q+f>7P?UzRnb7ACiT> zzA($g^!&S1qBMrT{?SfKS#Ji%%InS4ybA2=>0t$NTIpqZ+qaNMR&6Op-r;SnJ|xS= zm&W>QV*TCiRn>XqJ#Vj#!H*kfA3V2Jd-^uHc2+C2l- zLZi<=>T17i2|D+*_a6uPwvqH6OqtGXon3k#)%{3k-R!9S!!{T6?l=j454ykT4y|+N zUC2w$J=)NIG;oJ8ED?fR_`4ew~e6jFNLk3IqLD%e31QMI|igRXWD_0gdT$XfSWkT?)b2ZTp(T zb3t=j&ukmmGFQHhel%!Kxq78Fw$H#C;51JBL3ag&jk)ToUpIs1XnW8+3i^K?-Q~~~ z{tQ81>YMh1ze3pm)TQdb+S&zYf##b#2W=dS(CaMF9-%d?`De>qxe9&!-O`Q%I?dD1 zlhjdt&0Vdl_fy!6r|dFNtik@<7%C`B_*SJD&<%mG=Vt4vOmjUrw`{rOeV}o0b-}dO zWPA^B`mcRi>nUjO=9Bfw+PqBtO=*1S{A^;|wGy57*{U>kZ9B=N=2*HI@3(Ebl6pG3 z)*fd2$>MVLliYS~ns$$d7gDsJY;SOVE3N(~8w0JIq~AIyy9a{)l-Jy!4Em0=6xM^D z)ehJWn?dVe&-NzJ9v9|EYqFp1b5K$?0>aj|){OnGo_XwTF9&>5xJ$3ZJ71f54V z2JQQ4zu94<=lh6X?|Ec{vqG_>&xggJc5NFwNvp2CUtUl80LbRbWPJ|mvF!k5kn}x; zvTV?K`~#?jYB(R_&zH2uVGfi+(z|o8{Y>-tE`e3h;4N3}!V!Jn!+%>C2=RA~O#AR< z*dO{n6Z?ID-_>4iPK~#+;(%9BS6pAp?<%jdLs`l8=Zv|o+L&WwpEX>KRZQ4?%2CMfL-g*}Y~X>51?kkT3ap4Xn+Zq!nui zKZgFK_kgXxnzZh`TYR1T=^dop&&zHN*!qg!`c|3J@?rhekiHjoIy%*lop;FY@PSii zW485m&Z%5_tE(Vw|L3_4X^oRD(^#pF%}Z*pb#+gYw`a1R{SvVD50X~@Zvj2uDKH$C zgS9CQ%)Rk`nVwtx?+~P0!wsOhQUZ!W_vN91`d!iKxoEz|_Gx4@_$BOudq6fiPhWws z_oP1Pi%zptd1EJ;s literal 0 HcmV?d00001 diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..1cf13b9f9d978896599290a74f77d5dbe7d1655c GIT binary patch literal 1870 zcmV-U2eJ5xP)Gc)JR9QMau)O=X#!i9;T z37kk-upj^(fsR36MHs_+1RCI)NNu9}lD0S{B^g8PN?Ww(5|~L#Ng*g{WsqleV}|#l zz8@ri&cTzw_h33bHI+12+kK6WN$h#n5cD8OQt`5kw6p~9H3()bUQ8OS4Q4HTQ=1Ol z_JAocz`fLbT2^{`8n~UAo=#AUOf=SOq4pYkt;XbC&f#7lb$*7=$na!mWCQ`dBQsO0 zLFBSPj*N?#u5&pf2t4XjEGH|=pPQ8xh7tpx;US5Cx_Ju;!O`ya-yF`)b%TEt5>eP1ZX~}sjjA%FJF?h7cX8=b!DZl<6%Cv z*G0uvvU+vmnpLZ2paivG-(cd*y3$hCIcsZcYOGh{$&)A6*XX&kXZd3G8m)G$Zz-LV z^GF3VAW^Mdv!)4OM8EgqRiz~*Cji;uzl2uC9^=8I84vNp;ltJ|q-*uQwGp2ma6cY7 z;`%`!9UXO@fr&Ebapfs34OmS9^u6$)bJxrucutf>`dKPKT%%*d3XlFVKunp9 zasduxjrjs>f8V=D|J=XNZp;_Zy^WgQ$9WDjgY=z@stwiEBm9u5*|34&1Na8BMjjgf3+SHcr`5~>oz1Y?SW^=K z^bTyO6>Gar#P_W2gEMwq)ot3; zREHn~U&Dp0l6YT0&k-wLwYjb?5zGK`W6S2v+K>AM(95m2C20L|3m~rN8dprPr@t)5lsk9Hu*W z?pS990s;Ez=+Rj{x7p``4>+c0G5^pYnB1^!TL=(?HLHZ+HicG{~4F1d^5Awl_2!1jICM-!9eoLhbbT^;yHcefyTAaqRcY zmuctDopPT!%k+}x%lZRKnzykr2}}XfG_ne?nRQO~?%hkzo;@RN{P6o`&mMUWBYMTe z6i8ChtjX&gXl`nvrU>jah)2iNM%JdjqoaeaU%yVn!^70x-flljp6Q5tK}5}&X8&&G zX3fpb3E(!rH=zVI_9Gjl45w@{(ITqngWFe7@9{mX;tO25Z_8 zQHEpI+FkTU#4xu>RkN>b3Tnc3UpWzPXWm#o55GKF09j^Mh~)K7{QqbO_~(@CVq! zS<8954|P8mXN2MRs86xZ&Q4EfM@JB94b=(YGuk)s&^jiSF=t3*oNK3`rD{H`yQ?d; ztE=laAUoZx5?RC8*WKOj`%LXEkgDd>&^Q4M^z`%u0rg-It=hLCVsq!Z%^6eB-OvOT zFZ28TN&cRmgU}Elrnk43)!>Z1FCPL2K$7}gwzIc48NX}#!A1BpJP?#v5wkNprhV** z?Cpalt1oH&{r!o3eSKc&ap)iz2BTn_VV`4>9M^b3;(YY}4>#ML6{~(4mH+?%07*qo IM6N<$f(jP3KmY&$ literal 0 HcmV?d00001 diff --git a/assets/javascripts/bundle.fe8b6f2b.min.js b/assets/javascripts/bundle.fe8b6f2b.min.js new file mode 100644 index 0000000..cf778d4 --- /dev/null +++ b/assets/javascripts/bundle.fe8b6f2b.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var Fi=Object.create;var gr=Object.defineProperty;var ji=Object.getOwnPropertyDescriptor;var Wi=Object.getOwnPropertyNames,Dt=Object.getOwnPropertySymbols,Ui=Object.getPrototypeOf,xr=Object.prototype.hasOwnProperty,no=Object.prototype.propertyIsEnumerable;var oo=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,R=(e,t)=>{for(var r in t||(t={}))xr.call(t,r)&&oo(e,r,t[r]);if(Dt)for(var r of Dt(t))no.call(t,r)&&oo(e,r,t[r]);return e};var io=(e,t)=>{var r={};for(var o in e)xr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Dt)for(var o of Dt(e))t.indexOf(o)<0&&no.call(e,o)&&(r[o]=e[o]);return r};var yr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Di=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Wi(t))!xr.call(e,n)&&n!==r&&gr(e,n,{get:()=>t[n],enumerable:!(o=ji(t,n))||o.enumerable});return e};var Vt=(e,t,r)=>(r=e!=null?Fi(Ui(e)):{},Di(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var ao=(e,t,r)=>new Promise((o,n)=>{var i=p=>{try{s(r.next(p))}catch(c){n(c)}},a=p=>{try{s(r.throw(p))}catch(c){n(c)}},s=p=>p.done?o(p.value):Promise.resolve(p.value).then(i,a);s((r=r.apply(e,t)).next())});var co=yr((Er,so)=>{(function(e,t){typeof Er=="object"&&typeof so!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(Er,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(H){return!!(H&&H!==document&&H.nodeName!=="HTML"&&H.nodeName!=="BODY"&&"classList"in H&&"contains"in H.classList)}function p(H){var mt=H.type,ze=H.tagName;return!!(ze==="INPUT"&&a[mt]&&!H.readOnly||ze==="TEXTAREA"&&!H.readOnly||H.isContentEditable)}function c(H){H.classList.contains("focus-visible")||(H.classList.add("focus-visible"),H.setAttribute("data-focus-visible-added",""))}function l(H){H.hasAttribute("data-focus-visible-added")&&(H.classList.remove("focus-visible"),H.removeAttribute("data-focus-visible-added"))}function f(H){H.metaKey||H.altKey||H.ctrlKey||(s(r.activeElement)&&c(r.activeElement),o=!0)}function u(H){o=!1}function h(H){s(H.target)&&(o||p(H.target))&&c(H.target)}function w(H){s(H.target)&&(H.target.classList.contains("focus-visible")||H.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(H.target))}function A(H){document.visibilityState==="hidden"&&(n&&(o=!0),te())}function te(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function ie(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(H){H.target.nodeName&&H.target.nodeName.toLowerCase()==="html"||(o=!1,ie())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",A,!0),te(),r.addEventListener("focus",h,!0),r.addEventListener("blur",w,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var Yr=yr((Rt,Kr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Rt=="object"&&typeof Kr=="object"?Kr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Rt=="object"?Rt.ClipboardJS=r():t.ClipboardJS=r()})(Rt,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return Ii}});var a=i(279),s=i.n(a),p=i(370),c=i.n(p),l=i(817),f=i.n(l);function u(V){try{return document.execCommand(V)}catch(_){return!1}}var h=function(_){var M=f()(_);return u("cut"),M},w=h;function A(V){var _=document.documentElement.getAttribute("dir")==="rtl",M=document.createElement("textarea");M.style.fontSize="12pt",M.style.border="0",M.style.padding="0",M.style.margin="0",M.style.position="absolute",M.style[_?"right":"left"]="-9999px";var j=window.pageYOffset||document.documentElement.scrollTop;return M.style.top="".concat(j,"px"),M.setAttribute("readonly",""),M.value=V,M}var te=function(_,M){var j=A(_);M.container.appendChild(j);var D=f()(j);return u("copy"),j.remove(),D},ie=function(_){var M=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},j="";return typeof _=="string"?j=te(_,M):_ instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(_==null?void 0:_.type)?j=te(_.value,M):(j=f()(_),u("copy")),j},J=ie;function H(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?H=function(M){return typeof M}:H=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},H(V)}var mt=function(){var _=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},M=_.action,j=M===void 0?"copy":M,D=_.container,Y=_.target,ke=_.text;if(j!=="copy"&&j!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Y!==void 0)if(Y&&H(Y)==="object"&&Y.nodeType===1){if(j==="copy"&&Y.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(j==="cut"&&(Y.hasAttribute("readonly")||Y.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(ke)return J(ke,{container:D});if(Y)return j==="cut"?w(Y):J(Y,{container:D})},ze=mt;function Ie(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Ie=function(M){return typeof M}:Ie=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},Ie(V)}function _i(V,_){if(!(V instanceof _))throw new TypeError("Cannot call a class as a function")}function ro(V,_){for(var M=0;M<_.length;M++){var j=_[M];j.enumerable=j.enumerable||!1,j.configurable=!0,"value"in j&&(j.writable=!0),Object.defineProperty(V,j.key,j)}}function Ai(V,_,M){return _&&ro(V.prototype,_),M&&ro(V,M),V}function Ci(V,_){if(typeof _!="function"&&_!==null)throw new TypeError("Super expression must either be null or a function");V.prototype=Object.create(_&&_.prototype,{constructor:{value:V,writable:!0,configurable:!0}}),_&&br(V,_)}function br(V,_){return br=Object.setPrototypeOf||function(j,D){return j.__proto__=D,j},br(V,_)}function Hi(V){var _=Pi();return function(){var j=Wt(V),D;if(_){var Y=Wt(this).constructor;D=Reflect.construct(j,arguments,Y)}else D=j.apply(this,arguments);return ki(this,D)}}function ki(V,_){return _&&(Ie(_)==="object"||typeof _=="function")?_:$i(V)}function $i(V){if(V===void 0)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return V}function Pi(){if(typeof Reflect=="undefined"||!Reflect.construct||Reflect.construct.sham)return!1;if(typeof Proxy=="function")return!0;try{return Date.prototype.toString.call(Reflect.construct(Date,[],function(){})),!0}catch(V){return!1}}function Wt(V){return Wt=Object.setPrototypeOf?Object.getPrototypeOf:function(M){return M.__proto__||Object.getPrototypeOf(M)},Wt(V)}function vr(V,_){var M="data-clipboard-".concat(V);if(_.hasAttribute(M))return _.getAttribute(M)}var Ri=function(V){Ci(M,V);var _=Hi(M);function M(j,D){var Y;return _i(this,M),Y=_.call(this),Y.resolveOptions(D),Y.listenClick(j),Y}return Ai(M,[{key:"resolveOptions",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof D.action=="function"?D.action:this.defaultAction,this.target=typeof D.target=="function"?D.target:this.defaultTarget,this.text=typeof D.text=="function"?D.text:this.defaultText,this.container=Ie(D.container)==="object"?D.container:document.body}},{key:"listenClick",value:function(D){var Y=this;this.listener=c()(D,"click",function(ke){return Y.onClick(ke)})}},{key:"onClick",value:function(D){var Y=D.delegateTarget||D.currentTarget,ke=this.action(Y)||"copy",Ut=ze({action:ke,container:this.container,target:this.target(Y),text:this.text(Y)});this.emit(Ut?"success":"error",{action:ke,text:Ut,trigger:Y,clearSelection:function(){Y&&Y.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(D){return vr("action",D)}},{key:"defaultTarget",value:function(D){var Y=vr("target",D);if(Y)return document.querySelector(Y)}},{key:"defaultText",value:function(D){return vr("text",D)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(D){var Y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(D,Y)}},{key:"cut",value:function(D){return w(D)}},{key:"isSupported",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Y=typeof D=="string"?[D]:D,ke=!!document.queryCommandSupported;return Y.forEach(function(Ut){ke=ke&&!!document.queryCommandSupported(Ut)}),ke}}]),M}(s()),Ii=Ri},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,p){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(p))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(l,f,u,h,w){var A=c.apply(this,arguments);return l.addEventListener(u,A,w),{destroy:function(){l.removeEventListener(u,A,w)}}}function p(l,f,u,h,w){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(A){return s(A,f,u,h,w)}))}function c(l,f,u,h){return function(w){w.delegateTarget=a(w.target,f),w.delegateTarget&&h.call(l,w)}}o.exports=p},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function p(u,h,w){if(!u&&!h&&!w)throw new Error("Missing required arguments");if(!a.string(h))throw new TypeError("Second argument must be a String");if(!a.fn(w))throw new TypeError("Third argument must be a Function");if(a.node(u))return c(u,h,w);if(a.nodeList(u))return l(u,h,w);if(a.string(u))return f(u,h,w);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(u,h,w){return u.addEventListener(h,w),{destroy:function(){u.removeEventListener(h,w)}}}function l(u,h,w){return Array.prototype.forEach.call(u,function(A){A.addEventListener(h,w)}),{destroy:function(){Array.prototype.forEach.call(u,function(A){A.removeEventListener(h,w)})}}}function f(u,h,w){return s(document.body,u,h,w)}o.exports=p},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var p=window.getSelection(),c=document.createRange();c.selectNodeContents(i),p.removeAllRanges(),p.addRange(c),a=p.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var p=this.e||(this.e={});return(p[i]||(p[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var p=this;function c(){p.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),p=0,c=s.length;for(p;p{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var ts=/["'&<>]/;ei.exports=rs;function rs(e){var t=""+e,r=ts.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function N(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function q(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||s(u,h)})})}function s(u,h){try{p(o[u](h))}catch(w){f(i[0][3],w)}}function p(u){u.value instanceof nt?Promise.resolve(u.value.v).then(c,l):f(i[0][2],u)}function c(u){s("next",u)}function l(u){s("throw",u)}function f(u,h){u(h),i.shift(),i.length&&s(i[0][0],i[0][1])}}function mo(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof de=="function"?de(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,p){a=e[i](a),n(s,p,a.done,a.value)})}}function n(i,a,s,p){Promise.resolve(p).then(function(c){i({value:c,done:s})},a)}}function k(e){return typeof e=="function"}function ft(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var zt=ft(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function qe(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Fe=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=de(a),p=s.next();!p.done;p=s.next()){var c=p.value;c.remove(this)}}catch(A){t={error:A}}finally{try{p&&!p.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(k(l))try{l()}catch(A){i=A instanceof zt?A.errors:[A]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=de(f),h=u.next();!h.done;h=u.next()){var w=h.value;try{fo(w)}catch(A){i=i!=null?i:[],A instanceof zt?i=q(q([],N(i)),N(A.errors)):i.push(A)}}}catch(A){o={error:A}}finally{try{h&&!h.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new zt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)fo(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&qe(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&qe(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Tr=Fe.EMPTY;function qt(e){return e instanceof Fe||e&&"closed"in e&&k(e.remove)&&k(e.add)&&k(e.unsubscribe)}function fo(e){k(e)?e():e.unsubscribe()}var $e={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var ut={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Tr:(this.currentObservers=null,s.push(r),new Fe(function(){o.currentObservers=null,qe(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,o){return new Eo(r,o)},t}(F);var Eo=function(e){re(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Tr},t}(g);var _r=function(e){re(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t}(g);var Lt={now:function(){return(Lt.delegate||Date).now()},delegate:void 0};var _t=function(e){re(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=Lt);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,p=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+p)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),p=0;p0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t}(vt);var So=function(e){re(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t}(gt);var Hr=new So(To);var Oo=function(e){re(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=bt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(bt.cancelAnimationFrame(o),r._scheduled=void 0)},t}(vt);var Mo=function(e){re(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(gt);var me=new Mo(Oo);var O=new F(function(e){return e.complete()});function Yt(e){return e&&k(e.schedule)}function kr(e){return e[e.length-1]}function Xe(e){return k(kr(e))?e.pop():void 0}function He(e){return Yt(kr(e))?e.pop():void 0}function Bt(e,t){return typeof kr(e)=="number"?e.pop():t}var xt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Gt(e){return k(e==null?void 0:e.then)}function Jt(e){return k(e[ht])}function Xt(e){return Symbol.asyncIterator&&k(e==null?void 0:e[Symbol.asyncIterator])}function Zt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Gi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var er=Gi();function tr(e){return k(e==null?void 0:e[er])}function rr(e){return lo(this,arguments,function(){var r,o,n,i;return Nt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,nt(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,nt(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,nt(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function or(e){return k(e==null?void 0:e.getReader)}function W(e){if(e instanceof F)return e;if(e!=null){if(Jt(e))return Ji(e);if(xt(e))return Xi(e);if(Gt(e))return Zi(e);if(Xt(e))return Lo(e);if(tr(e))return ea(e);if(or(e))return ta(e)}throw Zt(e)}function Ji(e){return new F(function(t){var r=e[ht]();if(k(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Xi(e){return new F(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):le,Te(1),r?Be(t):zo(function(){return new ir}))}}function Fr(e){return e<=0?function(){return O}:y(function(t,r){var o=[];t.subscribe(T(r,function(n){o.push(n),e=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,p=s===void 0?!0:s;return function(c){var l,f,u,h=0,w=!1,A=!1,te=function(){f==null||f.unsubscribe(),f=void 0},ie=function(){te(),l=u=void 0,w=A=!1},J=function(){var H=l;ie(),H==null||H.unsubscribe()};return y(function(H,mt){h++,!A&&!w&&te();var ze=u=u!=null?u:r();mt.add(function(){h--,h===0&&!A&&!w&&(f=Wr(J,p))}),ze.subscribe(mt),!l&&h>0&&(l=new at({next:function(Ie){return ze.next(Ie)},error:function(Ie){A=!0,te(),f=Wr(ie,n,Ie),ze.error(Ie)},complete:function(){w=!0,te(),f=Wr(ie,a),ze.complete()}}),W(H).subscribe(l))})(c)}}function Wr(e,t){for(var r=[],o=2;oe.next(document)),e}function $(e,t=document){return Array.from(t.querySelectorAll(e))}function P(e,t=document){let r=fe(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function fe(e,t=document){return t.querySelector(e)||void 0}function Re(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var xa=S(d(document.body,"focusin"),d(document.body,"focusout")).pipe(_e(1),Q(void 0),m(()=>Re()||document.body),G(1));function et(e){return xa.pipe(m(t=>e.contains(t)),K())}function kt(e,t){return C(()=>S(d(e,"mouseenter").pipe(m(()=>!0)),d(e,"mouseleave").pipe(m(()=>!1))).pipe(t?Ht(r=>Me(+!r*t)):le,Q(e.matches(":hover"))))}function Bo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Bo(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)Bo(o,n);return o}function sr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function wt(e){let t=x("script",{src:e});return C(()=>(document.head.appendChild(t),S(d(t,"load"),d(t,"error").pipe(v(()=>$r(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),L(()=>document.head.removeChild(t)),Te(1))))}var Go=new g,ya=C(()=>typeof ResizeObserver=="undefined"?wt("https://unpkg.com/resize-observer-polyfill"):I(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>Go.next(t)))),v(e=>S(Ke,I(e)).pipe(L(()=>e.disconnect()))),G(1));function ce(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return ya.pipe(E(r=>r.observe(t)),v(r=>Go.pipe(b(o=>o.target===t),L(()=>r.unobserve(t)))),m(()=>ce(e)),Q(ce(e)))}function Tt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function cr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function Jo(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Ue(e){return{x:e.offsetLeft,y:e.offsetTop}}function Xo(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function Zo(e){return S(d(window,"load"),d(window,"resize")).pipe(Le(0,me),m(()=>Ue(e)),Q(Ue(e)))}function pr(e){return{x:e.scrollLeft,y:e.scrollTop}}function De(e){return S(d(e,"scroll"),d(window,"scroll"),d(window,"resize")).pipe(Le(0,me),m(()=>pr(e)),Q(pr(e)))}var en=new g,Ea=C(()=>I(new IntersectionObserver(e=>{for(let t of e)en.next(t)},{threshold:0}))).pipe(v(e=>S(Ke,I(e)).pipe(L(()=>e.disconnect()))),G(1));function tt(e){return Ea.pipe(E(t=>t.observe(e)),v(t=>en.pipe(b(({target:r})=>r===e),L(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function tn(e,t=16){return De(e).pipe(m(({y:r})=>{let o=ce(e),n=Tt(e);return r>=n.height-o.height-t}),K())}var lr={drawer:P("[data-md-toggle=drawer]"),search:P("[data-md-toggle=search]")};function rn(e){return lr[e].checked}function Je(e,t){lr[e].checked!==t&&lr[e].click()}function Ve(e){let t=lr[e];return d(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function wa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ta(){return S(d(window,"compositionstart").pipe(m(()=>!0)),d(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function on(){let e=d(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:rn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Re();if(typeof o!="undefined")return!wa(o,r)}return!0}),pe());return Ta().pipe(v(t=>t?O:e))}function xe(){return new URL(location.href)}function pt(e,t=!1){if(B("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function nn(){return new g}function an(){return location.hash.slice(1)}function sn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Sa(e){return S(d(window,"hashchange"),e).pipe(m(an),Q(an()),b(t=>t.length>0),G(1))}function cn(e){return Sa(e).pipe(m(t=>fe(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function $t(e){let t=matchMedia(e);return ar(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function pn(){let e=matchMedia("print");return S(d(window,"beforeprint").pipe(m(()=>!0)),d(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function Nr(e,t){return e.pipe(v(r=>r?t():O))}function zr(e,t){return new F(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function Ne(e,t){return zr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),G(1))}function ln(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),G(1))}function mn(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),G(1))}function fn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function un(){return S(d(window,"scroll",{passive:!0}),d(window,"resize",{passive:!0})).pipe(m(fn),Q(fn()))}function dn(){return{width:innerWidth,height:innerHeight}}function hn(){return d(window,"resize",{passive:!0}).pipe(m(dn),Q(dn()))}function bn(){return z([un(),hn()]).pipe(m(([e,t])=>({offset:e,size:t})),G(1))}function mr(e,{viewport$:t,header$:r}){let o=t.pipe(Z("size")),n=z([o,r]).pipe(m(()=>Ue(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:p,y:c}])=>({offset:{x:a.x-p,y:a.y-c+i},size:s})))}function Oa(e){return d(e,"message",t=>t.data)}function Ma(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function vn(e,t=new Worker(e)){let r=Oa(t),o=Ma(t),n=new g;n.subscribe(o);let i=o.pipe(X(),ne(!0));return n.pipe(X(),Pe(r.pipe(U(i))),pe())}var La=P("#__config"),St=JSON.parse(La.textContent);St.base=`${new URL(St.base,xe())}`;function ye(){return St}function B(e){return St.features.includes(e)}function Ee(e,t){return typeof t!="undefined"?St.translations[e].replace("#",t.toString()):St.translations[e]}function Se(e,t=document){return P(`[data-md-component=${e}]`,t)}function ae(e,t=document){return $(`[data-md-component=${e}]`,t)}function _a(e){let t=P(".md-typeset > :first-child",e);return d(t,"click",{once:!0}).pipe(m(()=>P(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function gn(e){if(!B("announce.dismiss")||!e.childElementCount)return O;if(!e.hidden){let t=P(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return C(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),_a(e).pipe(E(r=>t.next(r)),L(()=>t.complete()),m(r=>R({ref:e},r)))})}function Aa(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function xn(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),Aa(e,t).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))}function Pt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function yn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function En(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function wn(e){return x("button",{class:"md-clipboard md-icon",title:Ee("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}function qr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(p=>!e.terms[p]).reduce((p,c)=>[...p,x("del",null,c)," "],[]).slice(0,-1),i=ye(),a=new URL(e.location,i.base);B("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,p])=>p).reduce((p,[c])=>`${p} ${c}`.trim(),""));let{tags:s}=ye();return x("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&e.tags.map(p=>{let c=s?p in s?`md-tag-icon md-tag--${s[p]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${c}`},p)}),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Ee("search.result.term.missing"),": ",...n)))}function Tn(e){let t=e[0].score,r=[...e],o=ye(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreqr(l,1)),...p.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,p.length>0&&p.length===1?Ee("search.result.more.one"):Ee("search.result.more.other",p.length))),...p.map(l=>qr(l,1)))]:[]];return x("li",{class:"md-search-result__item"},c)}function Sn(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?sr(r):r)))}function Qr(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function On(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Ca(e){var o;let t=ye(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Mn(e,t){var o;let r=ye();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Ee("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Ca)))}var Ha=0;function ka(e){let t=z([et(e),kt(e)]).pipe(m(([o,n])=>o||n),K()),r=C(()=>Jo(e)).pipe(oe(De),ct(1),m(()=>Xo(e)));return t.pipe(Ae(o=>o),v(()=>z([t,r])),m(([o,n])=>({active:o,offset:n})),pe())}function $a(e,t){let{content$:r,viewport$:o}=t,n=`__tooltip2_${Ha++}`;return C(()=>{let i=new g,a=new _r(!1);i.pipe(X(),ne(!1)).subscribe(a);let s=a.pipe(Ht(c=>Me(+!c*250,Hr)),K(),v(c=>c?r:O),E(c=>c.id=n),pe());z([i.pipe(m(({active:c})=>c)),s.pipe(v(c=>kt(c,250)),Q(!1))]).pipe(m(c=>c.some(l=>l))).subscribe(a);let p=a.pipe(b(c=>c),ee(s,o),m(([c,l,{size:f}])=>{let u=e.getBoundingClientRect(),h=u.width/2;if(l.role==="tooltip")return{x:h,y:8+u.height};if(u.y>=f.height/2){let{height:w}=ce(l);return{x:h,y:-16-w}}else return{x:h,y:16+u.height}}));return z([s,i,p]).subscribe(([c,{offset:l},f])=>{c.style.setProperty("--md-tooltip-host-x",`${l.x}px`),c.style.setProperty("--md-tooltip-host-y",`${l.y}px`),c.style.setProperty("--md-tooltip-x",`${f.x}px`),c.style.setProperty("--md-tooltip-y",`${f.y}px`),c.classList.toggle("md-tooltip2--top",f.y<0),c.classList.toggle("md-tooltip2--bottom",f.y>=0)}),a.pipe(b(c=>c),ee(s,(c,l)=>l),b(c=>c.role==="tooltip")).subscribe(c=>{let l=ce(P(":scope > *",c));c.style.setProperty("--md-tooltip-width",`${l.width}px`),c.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(K(),be(me),ee(s)).subscribe(([c,l])=>{l.classList.toggle("md-tooltip2--active",c)}),z([a.pipe(b(c=>c)),s]).subscribe(([c,l])=>{l.role==="dialog"?(e.setAttribute("aria-controls",n),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",n)}),a.pipe(b(c=>!c)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),ka(e).pipe(E(c=>i.next(c)),L(()=>i.complete()),m(c=>R({ref:e},c)))})}function lt(e,{viewport$:t},r=document.body){return $a(e,{content$:new F(o=>{let n=e.title,i=yn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t})}function Pa(e,t){let r=C(()=>z([Zo(e),De(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=ce(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return et(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),Te(+!o||1/0))))}function Ln(e,t,{target$:r}){let[o,n]=Array.from(e.children);return C(()=>{let i=new g,a=i.pipe(X(),ne(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),tt(e).pipe(U(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),S(i.pipe(b(({active:s})=>s)),i.pipe(_e(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Le(16,me)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(ct(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),d(n,"click").pipe(U(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),d(n,"mousedown").pipe(U(a),ee(i)).subscribe(([s,{active:p}])=>{var c;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(p){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(c=Re())==null||c.blur()}}),r.pipe(U(a),b(s=>s===o),Ge(125)).subscribe(()=>e.focus()),Pa(e,t).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))})}function Ra(e){return e.tagName==="CODE"?$(".c, .c1, .cm",e):[e]}function Ia(e){let t=[];for(let r of Ra(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,p]=a;if(typeof p=="undefined"){let c=i.splitText(a.index);i=c.splitText(s.length),t.push(c)}else{i.textContent=s,t.push(i);break}}}}return t}function _n(e,t){t.append(...Array.from(e.childNodes))}function fr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Ia(t)){let[,p]=s.textContent.match(/\((\d+)\)/);fe(`:scope > li:nth-child(${p})`,e)&&(a.set(p,En(p,i)),s.replaceWith(a.get(p)))}return a.size===0?O:C(()=>{let s=new g,p=s.pipe(X(),ne(!0)),c=[];for(let[l,f]of a)c.push([P(".md-typeset",f),P(`:scope > li:nth-child(${l})`,e)]);return o.pipe(U(p)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of c)l?_n(f,u):_n(u,f)}),S(...[...a].map(([,l])=>Ln(l,t,{target$:r}))).pipe(L(()=>s.complete()),pe())})}function An(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return An(t)}}function Cn(e,t){return C(()=>{let r=An(e);return typeof r!="undefined"?fr(r,e,t):O})}var Hn=Vt(Yr());var Fa=0;function kn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return kn(t)}}function ja(e){return ge(e).pipe(m(({width:t})=>({scrollable:Tt(e).width>t})),Z("scrollable"))}function $n(e,t){let{matches:r}=matchMedia("(hover)"),o=C(()=>{let n=new g,i=n.pipe(Fr(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Hn.default.isSupported()&&(e.closest(".copy")||B("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${Fa++}`;let l=wn(c.id);c.insertBefore(l,e),B("content.tooltips")&&a.push(lt(l,{viewport$}))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=kn(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||B("content.code.annotate"))){let l=fr(c,e,t);a.push(ge(s).pipe(U(i),m(({width:f,height:u})=>f&&u),K(),v(f=>f?l:O)))}}return $(":scope > span[id]",e).length&&e.classList.add("md-code__content"),ja(e).pipe(E(c=>n.next(c)),L(()=>n.complete()),m(c=>R({ref:e},c)),Pe(...a))});return B("content.lazy")?tt(e).pipe(b(n=>n),Te(1),v(()=>o)):o}function Wa(e,{target$:t,print$:r}){let o=!0;return S(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),E(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Pn(e,t){return C(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),Wa(e,t).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}var Rn=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel rect,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel rect{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var Br,Da=0;function Va(){return typeof mermaid=="undefined"||mermaid instanceof Element?wt("https://unpkg.com/mermaid@10/dist/mermaid.min.js"):I(void 0)}function In(e){return e.classList.remove("mermaid"),Br||(Br=Va().pipe(E(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Rn,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),G(1))),Br.subscribe(()=>ao(this,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${Da++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),Br.pipe(m(()=>({ref:e})))}var Fn=x("table");function jn(e){return e.replaceWith(Fn),Fn.replaceWith(On(e)),I({ref:e})}function Na(e){let t=e.find(r=>r.checked)||e[0];return S(...e.map(r=>d(r,"change").pipe(m(()=>P(`label[for="${r.id}"]`))))).pipe(Q(P(`label[for="${t.id}"]`)),m(r=>({active:r})))}function Wn(e,{viewport$:t,target$:r}){let o=P(".tabbed-labels",e),n=$(":scope > input",e),i=Qr("prev");e.append(i);let a=Qr("next");return e.append(a),C(()=>{let s=new g,p=s.pipe(X(),ne(!0));z([s,ge(e),tt(e)]).pipe(U(p),Le(1,me)).subscribe({next([{active:c},l]){let f=Ue(c),{width:u}=ce(c);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let h=pr(o);(f.xh.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([De(o),ge(o)]).pipe(U(p)).subscribe(([c,l])=>{let f=Tt(o);i.hidden=c.x<16,a.hidden=c.x>f.width-l.width-16}),S(d(i,"click").pipe(m(()=>-1)),d(a,"click").pipe(m(()=>1))).pipe(U(p)).subscribe(c=>{let{width:l}=ce(o);o.scrollBy({left:l*c,behavior:"smooth"})}),r.pipe(U(p),b(c=>n.includes(c))).subscribe(c=>c.click()),o.classList.add("tabbed-labels--linked");for(let c of n){let l=P(`label[for="${c.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),d(l.firstElementChild,"click").pipe(U(p),b(f=>!(f.metaKey||f.ctrlKey)),E(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return B("content.tabs.link")&&s.pipe(Ce(1),ee(t)).subscribe(([{active:c},{offset:l}])=>{let f=c.innerText.trim();if(c.hasAttribute("data-md-switching"))c.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let w of $("[data-tabs]"))for(let A of $(":scope > input",w)){let te=P(`label[for="${A.id}"]`);if(te!==c&&te.innerText.trim()===f){te.setAttribute("data-md-switching",""),A.click();break}}window.scrollTo({top:e.offsetTop-u});let h=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...h])])}}),s.pipe(U(p)).subscribe(()=>{for(let c of $("audio, video",e))c.pause()}),Na(n).pipe(E(c=>s.next(c)),L(()=>s.complete()),m(c=>R({ref:e},c)))}).pipe(Qe(se))}function Un(e,{viewport$:t,target$:r,print$:o}){return S(...$(".annotate:not(.highlight)",e).map(n=>Cn(n,{target$:r,print$:o})),...$("pre:not(.mermaid) > code",e).map(n=>$n(n,{target$:r,print$:o})),...$("pre.mermaid",e).map(n=>In(n)),...$("table:not([class])",e).map(n=>jn(n)),...$("details",e).map(n=>Pn(n,{target$:r,print$:o})),...$("[data-tabs]",e).map(n=>Wn(n,{viewport$:t,target$:r})),...$("[title]",e).filter(()=>B("content.tooltips")).map(n=>lt(n,{viewport$:t})))}function za(e,{alert$:t}){return t.pipe(v(r=>S(I(!0),I(!1).pipe(Ge(2e3))).pipe(m(o=>({message:r,active:o})))))}function Dn(e,t){let r=P(".md-typeset",e);return C(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),za(e,t).pipe(E(n=>o.next(n)),L(()=>o.complete()),m(n=>R({ref:e},n)))})}var qa=0;function Qa(e,t){document.body.append(e);let{width:r}=ce(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=cr(t),n=typeof o!="undefined"?De(o):I({x:0,y:0}),i=S(et(t),kt(t)).pipe(K());return z([i,n]).pipe(m(([a,s])=>{let{x:p,y:c}=Ue(t),l=ce(t),f=t.closest("table");return f&&t.parentElement&&(p+=f.offsetLeft+t.parentElement.offsetLeft,c+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:p-s.x+l.width/2-r/2,y:c-s.y+l.height+8}}}))}function Vn(e){let t=e.title;if(!t.length)return O;let r=`__tooltip_${qa++}`,o=Pt(r,"inline"),n=P(".md-typeset",o);return n.innerHTML=t,C(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),S(i.pipe(b(({active:a})=>a)),i.pipe(_e(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Le(16,me)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(ct(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Qa(o,e).pipe(E(a=>i.next(a)),L(()=>i.complete()),m(a=>R({ref:e},a)))}).pipe(Qe(se))}function Ka({viewport$:e}){if(!B("header.autohide"))return I(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Ye(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),K()),o=Ve("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),K(),v(n=>n?r:I(!1)),Q(!1))}function Nn(e,t){return C(()=>z([ge(e),Ka(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),K((r,o)=>r.height===o.height&&r.hidden===o.hidden),G(1))}function zn(e,{header$:t,main$:r}){return C(()=>{let o=new g,n=o.pipe(X(),ne(!0));o.pipe(Z("active"),We(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=ue($("[title]",e)).pipe(b(()=>B("content.tooltips")),oe(a=>Vn(a)));return r.subscribe(o),t.pipe(U(n),m(a=>R({ref:e},a)),Pe(i.pipe(U(n))))})}function Ya(e,{viewport$:t,header$:r}){return mr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=ce(e);return{active:o>=n}}),Z("active"))}function qn(e,t){return C(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=fe(".md-content h1");return typeof o=="undefined"?O:Ya(o,t).pipe(E(n=>r.next(n)),L(()=>r.complete()),m(n=>R({ref:e},n)))})}function Qn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),K()),n=o.pipe(v(()=>ge(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),Z("bottom"))));return z([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:p},size:{height:c}}])=>(c=Math.max(0,c-Math.max(0,a-p,i)-Math.max(0,c+p-s)),{offset:a-i,height:c,active:a-i<=p})),K((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function Ba(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return I(...e).pipe(oe(o=>d(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),G(1))}function Kn(e){let t=$("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=$t("(prefers-color-scheme: light)");return C(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),p=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=p.getAttribute("data-md-color-scheme"),a.color.primary=p.getAttribute("data-md-color-primary"),a.color.accent=p.getAttribute("data-md-color-accent")}for(let[s,p]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,p);for(let s=0;sa.key==="Enter"),ee(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Se("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(p=>(+p).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(be(se)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),Ba(t).pipe(U(n.pipe(Ce(1))),st(),E(a=>i.next(a)),L(()=>i.complete()),m(a=>R({ref:e},a)))})}function Yn(e,{progress$:t}){return C(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(E(o=>r.next({value:o})),L(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Gr=Vt(Yr());function Ga(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Bn({alert$:e}){Gr.default.isSupported()&&new F(t=>{new Gr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||Ga(P(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(E(t=>{t.trigger.focus()}),m(()=>Ee("clipboard.copied"))).subscribe(e)}function Gn(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function Ja(e,t){let r=new Map;for(let o of $("url",e)){let n=P("loc",o),i=[Gn(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of $("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(Gn(new URL(s),t))}}return r}function ur(e){return mn(new URL("sitemap.xml",e)).pipe(m(t=>Ja(t,new URL(e))),ve(()=>I(new Map)))}function Xa(e,t){if(!(e.target instanceof Element))return O;let r=e.target.closest("a");if(r===null)return O;if(r.target||e.metaKey||e.ctrlKey)return O;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),I(new URL(r.href))):O}function Jn(e){let t=new Map;for(let r of $(":scope > *",e.head))t.set(r.outerHTML,r);return t}function Xn(e){for(let t of $("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return I(e)}function Za(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...B("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=fe(o),i=fe(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=Jn(document);for(let[o,n]of Jn(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Se("container");return je($("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new F(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),O}),X(),ne(document))}function Zn({location$:e,viewport$:t,progress$:r}){let o=ye();if(location.protocol==="file:")return O;let n=ur(o.base);I(document).subscribe(Xn);let i=d(document.body,"click").pipe(We(n),v(([p,c])=>Xa(p,c)),pe()),a=d(window,"popstate").pipe(m(xe),pe());i.pipe(ee(t)).subscribe(([p,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",p)}),S(i,a).subscribe(e);let s=e.pipe(Z("pathname"),v(p=>ln(p,{progress$:r}).pipe(ve(()=>(pt(p,!0),O)))),v(Xn),v(Za),pe());return S(s.pipe(ee(e,(p,c)=>c)),s.pipe(v(()=>e),Z("pathname"),v(()=>e),Z("hash")),e.pipe(K((p,c)=>p.pathname===c.pathname&&p.hash===c.hash),v(()=>i),E(()=>history.back()))).subscribe(p=>{var c,l;history.state!==null||!p.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",sn(p.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),d(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(Z("offset"),_e(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),s}var ri=Vt(ti());function oi(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,ri.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function It(e){return e.type===1}function dr(e){return e.type===3}function ni(e,t){let r=vn(e);return S(I(location.protocol!=="file:"),Ve("search")).pipe(Ae(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:B("search.suggest")}}})),r}function ii({document$:e}){let t=ye(),r=Ne(new URL("../versions.json",t.base)).pipe(ve(()=>O)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>d(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),ee(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let p=s.href;return!i.target.closest(".md-version")&&n.get(p)===a?O:(i.preventDefault(),I(p))}}return O}),v(i=>ur(new URL(i)).pipe(m(a=>{let p=xe().href.replace(t.base,i);return a.has(p.split("#")[0])?new URL(p):new URL(i)})))))).subscribe(n=>pt(n,!0)),z([r,o]).subscribe(([n,i])=>{P(".md-header__topic").appendChild(Mn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var a;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let s=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(s)||(s=[s]);e:for(let p of s)for(let c of n.aliases.concat(n.version))if(new RegExp(p,"i").test(c)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let s of ae("outdated"))s.hidden=!1})}function ns(e,{worker$:t}){let{searchParams:r}=xe();r.has("q")&&(Je("search",!0),e.value=r.get("q"),e.focus(),Ve("search").pipe(Ae(i=>!i)).subscribe(()=>{let i=xe();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=et(e),n=S(t.pipe(Ae(It)),d(e,"keyup"),o).pipe(m(()=>e.value),K());return z([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),G(1))}function ai(e,{worker$:t}){let r=new g,o=r.pipe(X(),ne(!0));z([t.pipe(Ae(It)),r],(i,a)=>a).pipe(Z("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(Z("focus")).subscribe(({focus:i})=>{i&&Je("search",i)}),d(e.form,"reset").pipe(U(o)).subscribe(()=>e.focus());let n=P("header [for=__search]");return d(n,"click").subscribe(()=>e.focus()),ns(e,{worker$:t}).pipe(E(i=>r.next(i)),L(()=>r.complete()),m(i=>R({ref:e},i)),G(1))}function si(e,{worker$:t,query$:r}){let o=new g,n=tn(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=P(":scope > :first-child",e),s=P(":scope > :last-child",e);Ve("search").subscribe(l=>s.setAttribute("role",l?"list":"presentation")),o.pipe(ee(r),Ur(t.pipe(Ae(It)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?Ee("search.result.none"):Ee("search.result.placeholder");break;case 1:a.textContent=Ee("search.result.one");break;default:let u=sr(l.length);a.textContent=Ee("search.result.other",u)}});let p=o.pipe(E(()=>s.innerHTML=""),v(({items:l})=>S(I(...l.slice(0,10)),I(...l.slice(10)).pipe(Ye(4),Vr(n),v(([f])=>f)))),m(Tn),pe());return p.subscribe(l=>s.appendChild(l)),p.pipe(oe(l=>{let f=fe("details",l);return typeof f=="undefined"?O:d(f,"toggle").pipe(U(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(dr),m(({data:l})=>l)).pipe(E(l=>o.next(l)),L(()=>o.complete()),m(l=>R({ref:e},l)))}function is(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=xe();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function ci(e,t){let r=new g,o=r.pipe(X(),ne(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),d(e,"click").pipe(U(o)).subscribe(n=>n.preventDefault()),is(e,t).pipe(E(n=>r.next(n)),L(()=>r.complete()),m(n=>R({ref:e},n)))}function pi(e,{worker$:t,keyboard$:r}){let o=new g,n=Se("search-query"),i=S(d(n,"keydown"),d(n,"focus")).pipe(be(se),m(()=>n.value),K());return o.pipe(We(i),m(([{suggest:s},p])=>{let c=p.split(/([\s-]+)/);if(s!=null&&s.length&&c[c.length-1]){let l=s[s.length-1];l.startsWith(c[c.length-1])&&(c[c.length-1]=l)}else c.length=0;return c})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(dr),m(({data:s})=>s)).pipe(E(s=>o.next(s)),L(()=>o.complete()),m(()=>({ref:e})))}function li(e,{index$:t,keyboard$:r}){let o=ye();try{let n=ni(o.search,t),i=Se("search-query",e),a=Se("search-result",e);d(e,"click").pipe(b(({target:p})=>p instanceof Element&&!!p.closest("a"))).subscribe(()=>Je("search",!1)),r.pipe(b(({mode:p})=>p==="search")).subscribe(p=>{let c=Re();switch(p.type){case"Enter":if(c===i){let l=new Map;for(let f of $(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,h])=>h-u);f.click()}p.claim()}break;case"Escape":case"Tab":Je("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof c=="undefined")i.focus();else{let l=[i,...$(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(c))+l.length+(p.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}p.claim();break;default:i!==Re()&&i.focus()}}),r.pipe(b(({mode:p})=>p==="global")).subscribe(p=>{switch(p.type){case"f":case"s":case"/":i.focus(),i.select(),p.claim();break}});let s=ai(i,{worker$:n});return S(s,si(a,{worker$:n,query$:s})).pipe(Pe(...ae("search-share",e).map(p=>ci(p,{query$:s})),...ae("search-suggest",e).map(p=>pi(p,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ke}}function mi(e,{index$:t,location$:r}){return z([t,r.pipe(Q(xe()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>oi(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let p=s.textContent,c=o(p);c.length>p.length&&n.set(s,c)}for(let[s,p]of n){let{childNodes:c}=x("span",null,p);s.replaceWith(...Array.from(c))}return{ref:e,nodes:n}}))}function as(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),K((i,a)=>i.height===a.height&&i.locked===a.locked))}function Jr(e,o){var n=o,{header$:t}=n,r=io(n,["header$"]);let i=P(".md-sidebar__scrollwrap",e),{y:a}=Ue(i);return C(()=>{let s=new g,p=s.pipe(X(),ne(!0)),c=s.pipe(Le(0,me));return c.pipe(ee(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),c.pipe(Ae()).subscribe(()=>{for(let l of $(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=ce(f);f.scrollTo({top:u-h/2})}}}),ue($("label[tabindex]",e)).pipe(oe(l=>d(l,"click").pipe(be(se),m(()=>l),U(p)))).subscribe(l=>{let f=P(`[id="${l.htmlFor}"]`);P(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),as(e,r).pipe(E(l=>s.next(l)),L(()=>s.complete()),m(l=>R({ref:e},l)))})}function fi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return Ct(Ne(`${r}/releases/latest`).pipe(ve(()=>O),m(o=>({version:o.tag_name})),Be({})),Ne(r).pipe(ve(()=>O),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Be({}))).pipe(m(([o,n])=>R(R({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return Ne(r).pipe(m(o=>({repositories:o.public_repos})),Be({}))}}function ui(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return Ne(r).pipe(ve(()=>O),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Be({}))}function di(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return fi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return ui(r,o)}return O}var ss;function cs(e){return ss||(ss=C(()=>{let t=__md_get("__source",sessionStorage);if(t)return I(t);if(ae("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return O}return di(e.href).pipe(E(o=>__md_set("__source",o,sessionStorage)))}).pipe(ve(()=>O),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),G(1)))}function hi(e){let t=P(":scope > :last-child",e);return C(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(Sn(o)),t.classList.add("md-source__repository--active")}),cs(e).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}function ps(e,{viewport$:t,header$:r}){return ge(document.body).pipe(v(()=>mr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),Z("hidden"))}function bi(e,t){return C(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(B("navigation.tabs.sticky")?I({hidden:!1}):ps(e,t)).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}function ls(e,{viewport$:t,header$:r}){let o=new Map,n=$(".md-nav__link",e);for(let s of n){let p=decodeURIComponent(s.hash.substring(1)),c=fe(`[id="${p}"]`);typeof c!="undefined"&&o.set(s,c)}let i=r.pipe(Z("height"),m(({height:s})=>{let p=Se("main"),c=P(":scope > :first-child",p);return s+.8*(c.offsetTop-p.offsetTop)}),pe());return ge(document.body).pipe(Z("height"),v(s=>C(()=>{let p=[];return I([...o].reduce((c,[l,f])=>{for(;p.length&&o.get(p[p.length-1]).tagName>=f.tagName;)p.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let h=f.offsetParent;for(;h;h=h.offsetParent)u+=h.offsetTop;return c.set([...p=[...p,l]].reverse(),u)},new Map))}).pipe(m(p=>new Map([...p].sort(([,c],[,l])=>c-l))),We(i),v(([p,c])=>t.pipe(jr(([l,f],{offset:{y:u},size:h})=>{let w=u+h.height>=Math.floor(s.height);for(;f.length;){let[,A]=f[0];if(A-c=u&&!w)f=[l.pop(),...f];else break}return[l,f]},[[],[...p]]),K((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,p])=>({prev:s.map(([c])=>c),next:p.map(([c])=>c)})),Q({prev:[],next:[]}),Ye(2,1),m(([s,p])=>s.prev.length{let i=new g,a=i.pipe(X(),ne(!0));if(i.subscribe(({prev:s,next:p})=>{for(let[c]of p)c.classList.remove("md-nav__link--passed"),c.classList.remove("md-nav__link--active");for(let[c,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",c===s.length-1)}),B("toc.follow")){let s=S(t.pipe(_e(1),m(()=>{})),t.pipe(_e(250),m(()=>"smooth")));i.pipe(b(({prev:p})=>p.length>0),We(o.pipe(be(se))),ee(s)).subscribe(([[{prev:p}],c])=>{let[l]=p[p.length-1];if(l.offsetHeight){let f=cr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=ce(f);f.scrollTo({top:u-h/2,behavior:c})}}})}return B("navigation.tracking")&&t.pipe(U(a),Z("offset"),_e(250),Ce(1),U(n.pipe(Ce(1))),st({delay:250}),ee(i)).subscribe(([,{prev:s}])=>{let p=xe(),c=s[s.length-1];if(c&&c.length){let[l]=c,{hash:f}=new URL(l.href);p.hash!==f&&(p.hash=f,history.replaceState({},"",`${p}`))}else p.hash="",history.replaceState({},"",`${p}`)}),ls(e,{viewport$:t,header$:r}).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))})}function ms(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Ye(2,1),m(([a,s])=>a>s&&s>0),K()),i=r.pipe(m(({active:a})=>a));return z([i,n]).pipe(m(([a,s])=>!(a&&s)),K(),U(o.pipe(Ce(1))),ne(!0),st({delay:250}),m(a=>({hidden:a})))}function gi(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(X(),ne(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(U(a),Z("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),d(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),ms(e,{viewport$:t,main$:o,target$:n}).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))}function xi({document$:e,viewport$:t}){e.pipe(v(()=>$(".md-ellipsis")),oe(r=>tt(r).pipe(U(e.pipe(Ce(1))),b(o=>o),m(()=>r),Te(1))),b(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,B("content.tooltips")?lt(n,{viewport$:t}).pipe(U(e.pipe(Ce(1))),L(()=>n.removeAttribute("title"))):O})).subscribe(),B("content.tooltips")&&e.pipe(v(()=>$(".md-status")),oe(r=>lt(r,{viewport$:t}))).subscribe()}function yi({document$:e,tablet$:t}){e.pipe(v(()=>$(".md-toggle--indeterminate")),E(r=>{r.indeterminate=!0,r.checked=!1}),oe(r=>d(r,"change").pipe(Dr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),ee(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function fs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Ei({document$:e}){e.pipe(v(()=>$("[data-md-scrollfix]")),E(t=>t.removeAttribute("data-md-scrollfix")),b(fs),oe(t=>d(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function wi({viewport$:e,tablet$:t}){z([Ve("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>I(r).pipe(Ge(r?400:100))),ee(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function us(){return location.protocol==="file:"?wt(`${new URL("search/search_index.js",Xr.base)}`).pipe(m(()=>__index),G(1)):Ne(new URL("search/search_index.json",Xr.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ot=Yo(),jt=nn(),Ot=cn(jt),Zr=on(),Oe=bn(),hr=$t("(min-width: 960px)"),Si=$t("(min-width: 1220px)"),Oi=pn(),Xr=ye(),Mi=document.forms.namedItem("search")?us():Ke,eo=new g;Bn({alert$:eo});var to=new g;B("navigation.instant")&&Zn({location$:jt,viewport$:Oe,progress$:to}).subscribe(ot);var Ti;((Ti=Xr.version)==null?void 0:Ti.provider)==="mike"&&ii({document$:ot});S(jt,Ot).pipe(Ge(125)).subscribe(()=>{Je("drawer",!1),Je("search",!1)});Zr.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=fe("link[rel=prev]");typeof t!="undefined"&&pt(t);break;case"n":case".":let r=fe("link[rel=next]");typeof r!="undefined"&&pt(r);break;case"Enter":let o=Re();o instanceof HTMLLabelElement&&o.click()}});xi({viewport$:Oe,document$:ot});yi({document$:ot,tablet$:hr});Ei({document$:ot});wi({viewport$:Oe,tablet$:hr});var rt=Nn(Se("header"),{viewport$:Oe}),Ft=ot.pipe(m(()=>Se("main")),v(e=>Qn(e,{viewport$:Oe,header$:rt})),G(1)),ds=S(...ae("consent").map(e=>xn(e,{target$:Ot})),...ae("dialog").map(e=>Dn(e,{alert$:eo})),...ae("header").map(e=>zn(e,{viewport$:Oe,header$:rt,main$:Ft})),...ae("palette").map(e=>Kn(e)),...ae("progress").map(e=>Yn(e,{progress$:to})),...ae("search").map(e=>li(e,{index$:Mi,keyboard$:Zr})),...ae("source").map(e=>hi(e))),hs=C(()=>S(...ae("announce").map(e=>gn(e)),...ae("content").map(e=>Un(e,{viewport$:Oe,target$:Ot,print$:Oi})),...ae("content").map(e=>B("search.highlight")?mi(e,{index$:Mi,location$:jt}):O),...ae("header-title").map(e=>qn(e,{viewport$:Oe,header$:rt})),...ae("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Nr(Si,()=>Jr(e,{viewport$:Oe,header$:rt,main$:Ft})):Nr(hr,()=>Jr(e,{viewport$:Oe,header$:rt,main$:Ft}))),...ae("tabs").map(e=>bi(e,{viewport$:Oe,header$:rt})),...ae("toc").map(e=>vi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Ot})),...ae("top").map(e=>gi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Ot})))),Li=ot.pipe(v(()=>hs),Pe(ds),G(1));Li.subscribe();window.document$=ot;window.location$=jt;window.target$=Ot;window.keyboard$=Zr;window.viewport$=Oe;window.tablet$=hr;window.screen$=Si;window.print$=Oi;window.alert$=eo;window.progress$=to;window.component$=Li;})(); +//# sourceMappingURL=bundle.fe8b6f2b.min.js.map + diff --git a/assets/javascripts/bundle.fe8b6f2b.min.js.map b/assets/javascripts/bundle.fe8b6f2b.min.js.map new file mode 100644 index 0000000..8263585 --- /dev/null +++ b/assets/javascripts/bundle.fe8b6f2b.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/clipboard/dist/clipboard.js", "node_modules/escape-html/index.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/rxjs/node_modules/tslib/tslib.es6.js", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*\n * Copyright (c) 2016-2024 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/*! *****************************************************************************\r\nCopyright (c) Microsoft Corporation.\r\n\r\nPermission to use, copy, modify, and/or distribute this software for any\r\npurpose with or without fee is hereby granted.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\r\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\r\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\r\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\r\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\r\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\r\nPERFORMANCE OF THIS SOFTWARE.\r\n***************************************************************************** */\r\n/* global Reflect, Promise */\r\n\r\nvar extendStatics = function(d, b) {\r\n extendStatics = Object.setPrototypeOf ||\r\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\r\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\r\n return extendStatics(d, b);\r\n};\r\n\r\nexport function __extends(d, b) {\r\n if (typeof b !== \"function\" && b !== null)\r\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\r\n extendStatics(d, b);\r\n function __() { this.constructor = d; }\r\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\r\n}\r\n\r\nexport var __assign = function() {\r\n __assign = Object.assign || function __assign(t) {\r\n for (var s, i = 1, n = arguments.length; i < n; i++) {\r\n s = arguments[i];\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\r\n }\r\n return t;\r\n }\r\n return __assign.apply(this, arguments);\r\n}\r\n\r\nexport function __rest(s, e) {\r\n var t = {};\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\r\n t[p] = s[p];\r\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\r\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\r\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\r\n t[p[i]] = s[p[i]];\r\n }\r\n return t;\r\n}\r\n\r\nexport function __decorate(decorators, target, key, desc) {\r\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\r\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\r\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\r\n return c > 3 && r && Object.defineProperty(target, key, r), r;\r\n}\r\n\r\nexport function __param(paramIndex, decorator) {\r\n return function (target, key) { decorator(target, key, paramIndex); }\r\n}\r\n\r\nexport function __metadata(metadataKey, metadataValue) {\r\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\r\n}\r\n\r\nexport function __awaiter(thisArg, _arguments, P, generator) {\r\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\r\n return new (P || (P = Promise))(function (resolve, reject) {\r\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\r\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\r\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\r\n step((generator = generator.apply(thisArg, _arguments || [])).next());\r\n });\r\n}\r\n\r\nexport function __generator(thisArg, body) {\r\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;\r\n return g = { next: verb(0), \"throw\": verb(1), \"return\": verb(2) }, typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\r\n function verb(n) { return function (v) { return step([n, v]); }; }\r\n function step(op) {\r\n if (f) throw new TypeError(\"Generator is already executing.\");\r\n while (_) try {\r\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\r\n if (y = 0, t) op = [op[0] & 2, t.value];\r\n switch (op[0]) {\r\n case 0: case 1: t = op; break;\r\n case 4: _.label++; return { value: op[1], done: false };\r\n case 5: _.label++; y = op[1]; op = [0]; continue;\r\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\r\n default:\r\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\r\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\r\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\r\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\r\n if (t[2]) _.ops.pop();\r\n _.trys.pop(); continue;\r\n }\r\n op = body.call(thisArg, _);\r\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\r\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\r\n }\r\n}\r\n\r\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });\r\n}) : (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n o[k2] = m[k];\r\n});\r\n\r\nexport function __exportStar(m, o) {\r\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\r\n}\r\n\r\nexport function __values(o) {\r\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\r\n if (m) return m.call(o);\r\n if (o && typeof o.length === \"number\") return {\r\n next: function () {\r\n if (o && i >= o.length) o = void 0;\r\n return { value: o && o[i++], done: !o };\r\n }\r\n };\r\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\r\n}\r\n\r\nexport function __read(o, n) {\r\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\r\n if (!m) return o;\r\n var i = m.call(o), r, ar = [], e;\r\n try {\r\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\r\n }\r\n catch (error) { e = { error: error }; }\r\n finally {\r\n try {\r\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\r\n }\r\n finally { if (e) throw e.error; }\r\n }\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spread() {\r\n for (var ar = [], i = 0; i < arguments.length; i++)\r\n ar = ar.concat(__read(arguments[i]));\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spreadArrays() {\r\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\r\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\r\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\r\n r[k] = a[j];\r\n return r;\r\n}\r\n\r\nexport function __spreadArray(to, from, pack) {\r\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\r\n if (ar || !(i in from)) {\r\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\r\n ar[i] = from[i];\r\n }\r\n }\r\n return to.concat(ar || Array.prototype.slice.call(from));\r\n}\r\n\r\nexport function __await(v) {\r\n return this instanceof __await ? (this.v = v, this) : new __await(v);\r\n}\r\n\r\nexport function __asyncGenerator(thisArg, _arguments, generator) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\r\n return i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i;\r\n function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }\r\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\r\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\r\n function fulfill(value) { resume(\"next\", value); }\r\n function reject(value) { resume(\"throw\", value); }\r\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\r\n}\r\n\r\nexport function __asyncDelegator(o) {\r\n var i, p;\r\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\r\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === \"return\" } : f ? f(v) : v; } : f; }\r\n}\r\n\r\nexport function __asyncValues(o) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var m = o[Symbol.asyncIterator], i;\r\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\r\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\r\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\r\n}\r\n\r\nexport function __makeTemplateObject(cooked, raw) {\r\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\r\n return cooked;\r\n};\r\n\r\nvar __setModuleDefault = Object.create ? (function(o, v) {\r\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\r\n}) : function(o, v) {\r\n o[\"default\"] = v;\r\n};\r\n\r\nexport function __importStar(mod) {\r\n if (mod && mod.__esModule) return mod;\r\n var result = {};\r\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\r\n __setModuleDefault(result, mod);\r\n return result;\r\n}\r\n\r\nexport function __importDefault(mod) {\r\n return (mod && mod.__esModule) ? mod : { default: mod };\r\n}\r\n\r\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\r\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\r\n}\r\n\r\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\r\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\r\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\r\n}\r\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @nocollapse\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return {Observable} Observable that the Subject casts to\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\n/**\n * @class AnonymousSubject\n */\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n *\n * @class BehaviorSubject\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param bufferSize The size of the buffer to replay on subscription\n * @param windowTime The amount of time the buffered items will stay buffered\n * @param timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n *\n * @class Action\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler.\n * @return {void}\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n * @return {any}\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @class Scheduler\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return {number} A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param {function(state: ?T): ?Subscription} work A function representing a\n * task, or some unit of work to be executed by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler itself.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @return {Subscription} A subscription in order to be able to unsubscribe\n * the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @type {boolean}\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @type {any}\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n const flushId = this._scheduled;\n this._scheduled = undefined;\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an