-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathclient.py
3101 lines (2618 loc) · 105 KB
/
client.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
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
# This file was auto-generated by Fern from our API Definition.
import typing
from json.decoder import JSONDecodeError
from ..core.api_error import ApiError as core_api_error_ApiError
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ..core.jsonable_encoder import jsonable_encoder
from ..core.pydantic_utilities import pydantic_v1
from ..core.request_options import RequestOptions
from ..errors.bad_request_error import BadRequestError
from ..errors.conflict_error import ConflictError
from ..errors.internal_server_error import InternalServerError
from ..errors.not_found_error import NotFoundError
from ..types.add_memory_response import AddMemoryResponse
from ..types.api_error import ApiError as types_api_error_ApiError
from ..types.classify_session_request import ClassifySessionRequest
from ..types.end_session_response import EndSessionResponse
from ..types.end_sessions_response import EndSessionsResponse
from ..types.fact_rating_instruction import FactRatingInstruction
from ..types.fact_response import FactResponse
from ..types.facts_response import FactsResponse
from ..types.memory import Memory
from ..types.memory_search_result import MemorySearchResult
from ..types.message import Message
from ..types.message_list_response import MessageListResponse
from ..types.new_fact import NewFact
from ..types.question import Question
from ..types.search_scope import SearchScope
from ..types.search_type import SearchType
from ..types.session import Session
from ..types.session_classification import SessionClassification
from ..types.session_list_response import SessionListResponse
from ..types.session_search_response import SessionSearchResponse
from ..types.success_response import SuccessResponse
from ..types.summary_list_response import SummaryListResponse
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class MemoryClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._client_wrapper = client_wrapper
def get_fact(self, fact_uuid: str, *, request_options: typing.Optional[RequestOptions] = None) -> FactResponse:
"""
get fact by uuid
Parameters
----------
fact_uuid : str
Fact UUID
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
FactResponse
The fact with the specified UUID.
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.get_fact(
fact_uuid="factUUID",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"facts/{jsonable_encoder(fact_uuid)}", method="GET", request_options=request_options
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(FactResponse, _response.json()) # type: ignore
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def delete_fact(
self, fact_uuid: str, *, request_options: typing.Optional[RequestOptions] = None
) -> SuccessResponse:
"""
delete a fact
Parameters
----------
fact_uuid : str
Fact UUID
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SuccessResponse
Deleted
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.delete_fact(
fact_uuid="factUUID",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"facts/{jsonable_encoder(fact_uuid)}", method="DELETE", request_options=request_options
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(SuccessResponse, _response.json()) # type: ignore
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def add_session(
self,
*,
session_id: str,
user_id: str,
fact_rating_instruction: typing.Optional[FactRatingInstruction] = OMIT,
metadata: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Session:
"""
Create New Session
Parameters
----------
session_id : str
The unique identifier of the session.
user_id : str
The unique identifier of the user associated with the session
fact_rating_instruction : typing.Optional[FactRatingInstruction]
Optional instruction to use for fact rating.
metadata : typing.Optional[typing.Dict[str, typing.Any]]
The metadata associated with the session.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Session
The added session.
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.add_session(
session_id="session_id",
user_id="user_id",
)
"""
_response = self._client_wrapper.httpx_client.request(
"sessions",
method="POST",
json={
"fact_rating_instruction": fact_rating_instruction,
"metadata": metadata,
"session_id": session_id,
"user_id": user_id,
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(Session, _response.json()) # type: ignore
if _response.status_code == 400:
raise BadRequestError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def list_sessions(
self,
*,
page_number: typing.Optional[int] = None,
page_size: typing.Optional[int] = None,
order_by: typing.Optional[str] = None,
asc: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> SessionListResponse:
"""
Get all sessions with optional page number, page size, order by field and order direction for pagination.
Parameters
----------
page_number : typing.Optional[int]
Page number for pagination, starting from 1
page_size : typing.Optional[int]
Number of sessions to retrieve per page
order_by : typing.Optional[str]
Field to order the results by: created_at, updated_at, user_id, session_id
asc : typing.Optional[bool]
Order direction: true for ascending, false for descending
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SessionListResponse
List of sessions
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.list_sessions()
"""
_response = self._client_wrapper.httpx_client.request(
"sessions-ordered",
method="GET",
params={"page_number": page_number, "page_size": page_size, "order_by": order_by, "asc": asc},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(SessionListResponse, _response.json()) # type: ignore
if _response.status_code == 400:
raise BadRequestError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def end_sessions(
self,
*,
session_ids: typing.Sequence[str],
instruction: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> EndSessionsResponse:
"""
End multiple sessions by their IDs.
Parameters
----------
session_ids : typing.Sequence[str]
instruction : typing.Optional[str]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
EndSessionsResponse
OK
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.end_sessions(
session_ids=["session_ids"],
)
"""
_response = self._client_wrapper.httpx_client.request(
"sessions/end",
method="POST",
json={"instruction": instruction, "session_ids": session_ids},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(EndSessionsResponse, _response.json()) # type: ignore
if _response.status_code == 400:
raise BadRequestError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def search_sessions(
self,
*,
text: str,
limit: typing.Optional[int] = None,
min_fact_rating: typing.Optional[float] = OMIT,
min_score: typing.Optional[float] = OMIT,
mmr_lambda: typing.Optional[float] = OMIT,
record_filter: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
search_scope: typing.Optional[SearchScope] = OMIT,
search_type: typing.Optional[SearchType] = OMIT,
session_ids: typing.Optional[typing.Sequence[str]] = OMIT,
user_id: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> SessionSearchResponse:
"""
Search sessions for the specified query.
Parameters
----------
text : str
The search text.
limit : typing.Optional[int]
The maximum number of search results to return. Defaults to None (no limit).
min_fact_rating : typing.Optional[float]
The minimum fact rating to filter on. Only supported on cloud. Will be ignored on Community Edition.
min_score : typing.Optional[float]
The minimum score for search results. Only supported on cloud. Will be ignored on Community Edition.
mmr_lambda : typing.Optional[float]
The lambda parameter for the MMR Reranking Algorithm. Only supported on cloud. Will be ignored on Community Edition.
record_filter : typing.Optional[typing.Dict[str, typing.Any]]
Record filter on the metadata. Only supported on cloud. Will be ignored on Community Edition.
search_scope : typing.Optional[SearchScope]
Search scope. Only supported on cloud. On Community Edition the search scope is always "facts".
search_type : typing.Optional[SearchType]
Search type. Only supported on cloud. Will be ignored on Community Edition.
session_ids : typing.Optional[typing.Sequence[str]]
the session ids to search
user_id : typing.Optional[str]
User ID used to determine which sessions to search. Required on Community Edition.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SessionSearchResponse
A SessionSearchResponse object representing the search results.
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.search_sessions(
text="text",
)
"""
_response = self._client_wrapper.httpx_client.request(
"sessions/search",
method="POST",
params={"limit": limit},
json={
"min_fact_rating": min_fact_rating,
"min_score": min_score,
"mmr_lambda": mmr_lambda,
"record_filter": record_filter,
"search_scope": search_scope,
"search_type": search_type,
"session_ids": session_ids,
"text": text,
"user_id": user_id,
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(SessionSearchResponse, _response.json()) # type: ignore
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def get_session(self, session_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Session:
"""
get session by id
Parameters
----------
session_id : str
Session ID
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Session
The session with the specified ID.
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.get_session(
session_id="sessionId",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"sessions/{jsonable_encoder(session_id)}", method="GET", request_options=request_options
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(Session, _response.json()) # type: ignore
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def update_session(
self,
session_id: str,
*,
metadata: typing.Dict[str, typing.Any],
fact_rating_instruction: typing.Optional[FactRatingInstruction] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Session:
"""
Update Session Metadata
Parameters
----------
session_id : str
Session ID
metadata : typing.Dict[str, typing.Any]
The metadata to update
fact_rating_instruction : typing.Optional[FactRatingInstruction]
Optional instruction to use for fact rating.
Fact rating instructions can not be unset.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Session
The updated session.
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.update_session(
session_id="sessionId",
metadata={"key": "value"},
)
"""
_response = self._client_wrapper.httpx_client.request(
f"sessions/{jsonable_encoder(session_id)}",
method="PATCH",
json={"fact_rating_instruction": fact_rating_instruction, "metadata": metadata},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(Session, _response.json()) # type: ignore
if _response.status_code == 400:
raise BadRequestError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 409:
raise ConflictError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def classify_session(
self,
session_id: str,
*,
classes: typing.Sequence[str],
name: str,
instruction: typing.Optional[str] = OMIT,
last_n: typing.Optional[int] = OMIT,
persist: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> SessionClassification:
"""
classify a session by session id.
Parameters
----------
session_id : str
Session ID
classes : typing.Sequence[str]
The classes to use for classification.
name : str
The name of the classifier. Will be used to store the classification in session metadata if persist is True.
instruction : typing.Optional[str]
Custom instruction to use for classification.
last_n : typing.Optional[int]
The number of session messages to consider for classification. Defaults to 4.
persist : typing.Optional[bool]
Whether to persist the classification to session metadata. Defaults to True.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SessionClassification
A response object containing the name and classification result.
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.classify_session(
session_id="sessionId",
classes=["classes"],
name="name",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"sessions/{jsonable_encoder(session_id)}/classify",
method="POST",
json={"classes": classes, "instruction": instruction, "last_n": last_n, "name": name, "persist": persist},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(SessionClassification, _response.json()) # type: ignore
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def end_session(
self,
session_id: str,
*,
classify: typing.Optional[ClassifySessionRequest] = OMIT,
instruction: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> EndSessionResponse:
"""
End a session by ID.
Parameters
----------
session_id : str
Session ID
classify : typing.Optional[ClassifySessionRequest]
instruction : typing.Optional[str]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
EndSessionResponse
OK
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.end_session(
session_id="sessionId",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"sessions/{jsonable_encoder(session_id)}/end",
method="POST",
json={"classify": classify, "instruction": instruction},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(EndSessionResponse, _response.json()) # type: ignore
if _response.status_code == 400:
raise BadRequestError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def extract_data(
self,
session_id: str,
*,
last_n: int,
model_schema: str,
current_date_time: typing.Optional[str] = OMIT,
validate: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> typing.Dict[str, str]:
"""
extract data from a session by session id
Parameters
----------
session_id : str
Session ID
last_n : int
The number of messages in the chat history from which to extract data
model_schema : str
The schema describing the data to be extracted. See Zep's SDKs for more details.
current_date_time : typing.Optional[str]
Your current date and time in ISO 8601 format including timezone. This is used for determining relative dates.
validate : typing.Optional[bool]
Validate that the extracted data is present in the dialog and correct per the field description.
Mitigates hallucination, but is slower and may result in false negatives.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.Dict[str, str]
OK
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.extract_data(
session_id="sessionId",
last_n=1,
model_schema="model_schema",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"sessions/{jsonable_encoder(session_id)}/extract",
method="POST",
json={
"current_date_time": current_date_time,
"last_n": last_n,
"model_schema": model_schema,
"validate": validate,
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(typing.Dict[str, str], _response.json()) # type: ignore
if _response.status_code == 400:
raise BadRequestError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def get_session_facts(
self,
session_id: str,
*,
min_rating: typing.Optional[float] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> FactsResponse:
"""
get facts for a session
Parameters
----------
session_id : str
Session ID
min_rating : typing.Optional[float]
Minimum rating by which to filter facts (Zep Cloud only)
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
FactsResponse
The facts for the session.
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.get_session_facts(
session_id="sessionId",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"sessions/{jsonable_encoder(session_id)}/facts",
method="GET",
params={"minRating": min_rating},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(FactsResponse, _response.json()) # type: ignore
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def add_session_facts(
self,
session_id: str,
*,
facts: typing.Optional[typing.Sequence[NewFact]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> SuccessResponse:
"""
Adds facts to a session
Parameters
----------
session_id : str
Session ID
facts : typing.Optional[typing.Sequence[NewFact]]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SuccessResponse
OK
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.add_session_facts(
session_id="sessionId",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"sessions/{jsonable_encoder(session_id)}/facts",
method="POST",
json={"facts": facts},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(SuccessResponse, _response.json()) # type: ignore
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def get(
self,
session_id: str,
*,
lastn: typing.Optional[int] = None,
min_rating: typing.Optional[float] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> Memory:
"""
Returns a memory (latest summary, list of messages and facts) for a given session
Parameters
----------
session_id : str
The ID of the session for which to retrieve memory.
lastn : typing.Optional[int]
The number of most recent memory entries to retrieve.
min_rating : typing.Optional[float]
The minimum rating by which to filter facts
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Memory
OK
Examples
--------
from zep_cloud.client import Zep
client = Zep(
api_key="YOUR_API_KEY",
)
client.memory.get(
session_id="sessionId",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"sessions/{jsonable_encoder(session_id)}/memory",
method="GET",
params={"lastn": lastn, "minRating": min_rating},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return pydantic_v1.parse_obj_as(Memory, _response.json()) # type: ignore
if _response.status_code == 404:
raise NotFoundError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
if _response.status_code == 500:
raise InternalServerError(
pydantic_v1.parse_obj_as(types_api_error_ApiError, _response.json()) # type: ignore
)
_response_json = _response.json()
except JSONDecodeError:
raise core_api_error_ApiError(status_code=_response.status_code, body=_response.text)
raise core_api_error_ApiError(status_code=_response.status_code, body=_response_json)
def add(
self,
session_id: str,
*,
messages: typing.Sequence[Message],
fact_instruction: typing.Optional[str] = OMIT,
return_context: typing.Optional[bool] = OMIT,
summary_instruction: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> AddMemoryResponse:
"""
Add memory to the specified session.
Parameters
----------
session_id : str
The ID of the session to which memory should be added.
messages : typing.Sequence[Message]
A list of message objects, where each message contains a role and content.
fact_instruction : typing.Optional[str]
Additional instruction for generating the facts. Zep Cloud Only, will be ignored on Community Edition.
return_context : typing.Optional[bool]
Optionally return memory context relevant to the most recent messages.
summary_instruction : typing.Optional[str]
Additional instruction for generating the summary. Zep Cloud Only, will be ignored on Community Edition.