@getzep/zep-cloud 3.17.0 → 3.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +19 -14
- package/dist/cjs/api/errors/BadRequestError.d.ts +1 -2
- package/dist/cjs/api/errors/ConflictError.d.ts +9 -0
- package/dist/cjs/api/errors/ConflictError.js +52 -0
- package/dist/cjs/api/errors/index.d.ts +2 -1
- package/dist/cjs/api/errors/index.js +2 -1
- package/dist/cjs/api/resources/batch/client/Client.d.ts +161 -0
- package/dist/cjs/api/resources/batch/client/Client.js +777 -0
- package/dist/cjs/api/resources/batch/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/batch/client/index.js +17 -0
- package/dist/cjs/api/resources/batch/client/requests/ApidataAddBatchItemsRequest.d.ts +15 -0
- package/dist/cjs/api/resources/batch/client/requests/ApidataCreateBatchRequest.d.ts +10 -0
- package/dist/cjs/api/resources/batch/client/requests/ApidataCreateBatchRequest.js +5 -0
- package/dist/cjs/api/resources/batch/client/requests/BatchListItemsRequest.d.ts +25 -0
- package/dist/cjs/api/resources/batch/client/requests/BatchListItemsRequest.js +5 -0
- package/dist/cjs/api/resources/batch/client/requests/BatchListRequest.d.ts +25 -0
- package/dist/cjs/api/resources/batch/client/requests/BatchListRequest.js +5 -0
- package/dist/cjs/api/resources/batch/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/batch/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/batch/index.d.ts +1 -0
- package/dist/cjs/api/resources/batch/index.js +17 -0
- package/dist/cjs/api/resources/context/client/Client.js +5 -35
- package/dist/cjs/api/resources/graph/client/Client.d.ts +13 -0
- package/dist/cjs/api/resources/graph/client/Client.js +44 -82
- package/dist/cjs/api/resources/graph/client/requests/AddDataRequest.d.ts +2 -0
- package/dist/cjs/api/resources/graph/client/requests/AddTripleRequest.d.ts +5 -0
- package/dist/cjs/api/resources/graph/client/requests/DetectPatternsRequest.d.ts +12 -4
- package/dist/cjs/api/resources/graph/client/requests/GraphListAllRequest.d.ts +5 -0
- package/dist/cjs/api/resources/graph/client/requests/GraphSearchQuery.d.ts +14 -2
- package/dist/cjs/api/resources/graph/resources/edge/client/Client.js +5 -35
- package/dist/cjs/api/resources/graph/resources/episode/client/Client.d.ts +21 -0
- package/dist/cjs/api/resources/graph/resources/episode/client/Client.js +104 -30
- package/dist/cjs/api/resources/graph/resources/episode/client/requests/UpdateEpisodeRequest.d.ts +15 -0
- package/dist/cjs/api/resources/graph/resources/episode/client/requests/UpdateEpisodeRequest.js +5 -0
- package/dist/cjs/api/resources/graph/resources/episode/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/graph/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/graph/resources/index.js +3 -1
- package/dist/cjs/api/resources/graph/resources/node/client/Client.js +7 -49
- package/dist/cjs/api/resources/graph/resources/observation/client/Client.d.ts +81 -0
- package/dist/cjs/api/resources/graph/resources/observation/client/Client.js +333 -0
- package/dist/cjs/api/resources/graph/resources/observation/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/graph/resources/observation/client/index.js +2 -0
- package/dist/cjs/api/resources/graph/resources/observation/index.d.ts +1 -0
- package/dist/cjs/api/resources/graph/resources/observation/index.js +17 -0
- package/dist/cjs/api/resources/graph/resources/threadSummary/client/Client.d.ts +66 -0
- package/dist/cjs/api/resources/graph/resources/threadSummary/client/Client.js +249 -0
- package/dist/cjs/api/resources/graph/resources/threadSummary/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/graph/resources/threadSummary/client/index.js +2 -0
- package/dist/cjs/api/resources/graph/resources/threadSummary/index.d.ts +1 -0
- package/dist/cjs/api/resources/graph/resources/threadSummary/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/project/client/Client.js +1 -7
- package/dist/cjs/api/resources/thread/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/thread/client/Client.js +92 -14
- package/dist/cjs/api/resources/user/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/user/client/Client.js +15 -24
- package/dist/cjs/api/types/ApidataBatchAddItemRole.d.ts +12 -0
- package/dist/cjs/api/types/ApidataBatchAddItemRole.js +14 -0
- package/dist/cjs/api/types/ApidataBatchAddItemType.d.ts +8 -0
- package/dist/cjs/api/types/ApidataBatchAddItemType.js +10 -0
- package/dist/cjs/api/types/BatchAddItem.d.ts +18 -0
- package/dist/cjs/api/types/BatchAddItem.js +5 -0
- package/dist/cjs/api/types/BatchItemDetail.d.ts +18 -0
- package/dist/cjs/api/types/BatchItemDetail.js +5 -0
- package/dist/cjs/api/types/BatchItemKind.d.ts +8 -0
- package/dist/cjs/api/types/BatchItemKind.js +10 -0
- package/dist/cjs/api/types/BatchItemListResponse.d.ts +8 -0
- package/dist/cjs/api/types/BatchItemListResponse.js +5 -0
- package/dist/cjs/api/types/BatchItemStatus.d.ts +12 -0
- package/dist/cjs/api/types/BatchItemStatus.js +14 -0
- package/dist/cjs/api/types/BatchListResponse.d.ts +8 -0
- package/dist/cjs/api/types/BatchListResponse.js +5 -0
- package/dist/cjs/api/types/BatchProgress.d.ts +12 -0
- package/dist/cjs/api/types/BatchProgress.js +5 -0
- package/dist/cjs/api/types/BatchStatus.d.ts +13 -0
- package/dist/cjs/api/types/BatchStatus.js +15 -0
- package/dist/cjs/api/types/BatchSummary.d.ts +15 -0
- package/dist/cjs/api/types/BatchSummary.js +5 -0
- package/dist/cjs/api/types/ComparisonOperator.d.ts +2 -1
- package/dist/cjs/api/types/ComparisonOperator.js +1 -0
- package/dist/cjs/api/types/DateFilter.d.ts +1 -1
- package/dist/cjs/api/types/DerivedNode.d.ts +28 -0
- package/dist/cjs/api/types/DerivedNode.js +5 -0
- package/dist/cjs/api/types/DetectPatternsResponse.d.ts +2 -0
- package/dist/cjs/api/types/EntityEdge.d.ts +4 -0
- package/dist/cjs/api/types/EntityNode.d.ts +2 -0
- package/dist/cjs/api/types/Episode.d.ts +2 -0
- package/dist/cjs/api/types/EpisodeData.d.ts +2 -0
- package/dist/cjs/api/types/EpisodeMetadataFilter.d.ts +12 -0
- package/dist/cjs/api/types/EpisodeMetadataFilter.js +5 -0
- package/dist/cjs/api/types/GraphDataType.d.ts +2 -1
- package/dist/cjs/api/types/GraphDataType.js +1 -0
- package/dist/cjs/api/types/GraphObservationsRequest.d.ts +9 -0
- package/dist/cjs/api/types/GraphObservationsRequest.js +5 -0
- package/dist/cjs/api/types/GraphSearchResults.d.ts +3 -0
- package/dist/cjs/api/types/GraphSearchScope.d.ts +4 -1
- package/dist/cjs/api/types/GraphSearchScope.js +3 -0
- package/dist/cjs/api/types/GraphThreadSummariesRequest.d.ts +9 -0
- package/dist/cjs/api/types/GraphThreadSummariesRequest.js +5 -0
- package/dist/cjs/api/types/GraphitiMetadataFilterGroupType.d.ts +11 -0
- package/dist/cjs/api/types/GraphitiMetadataFilterGroupType.js +10 -0
- package/dist/cjs/api/types/GraphitiSagaNode.d.ts +26 -0
- package/dist/cjs/api/types/GraphitiSagaNode.js +5 -0
- package/dist/cjs/api/types/MetadataFilterGroup.d.ts +12 -0
- package/dist/cjs/api/types/MetadataFilterGroup.js +5 -0
- package/dist/cjs/api/types/PatternResult.d.ts +22 -5
- package/dist/cjs/api/types/PatternSeeds.d.ts +1 -1
- package/dist/cjs/api/types/PropertyFilter.d.ts +1 -1
- package/dist/cjs/api/types/SearchFilters.d.ts +14 -9
- package/dist/cjs/api/types/ThreadSummary.d.ts +20 -0
- package/dist/cjs/api/types/ThreadSummary.js +5 -0
- package/dist/cjs/api/types/index.d.ts +19 -1
- package/dist/cjs/api/types/index.js +19 -1
- package/dist/cjs/serialization/resources/batch/client/add.d.ts +11 -0
- package/dist/cjs/serialization/resources/batch/client/add.js +42 -0
- package/dist/cjs/serialization/resources/batch/client/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/batch/client/index.js +41 -0
- package/dist/cjs/serialization/resources/batch/client/requests/ApidataAddBatchItemsRequest.d.ts +13 -0
- package/dist/cjs/serialization/resources/batch/client/requests/ApidataAddBatchItemsRequest.js +44 -0
- package/dist/cjs/serialization/resources/batch/client/requests/ApidataCreateBatchRequest.d.ts +12 -0
- package/dist/cjs/serialization/resources/batch/client/requests/ApidataCreateBatchRequest.js +43 -0
- package/dist/cjs/serialization/resources/batch/client/requests/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/batch/client/requests/index.js +7 -0
- package/dist/cjs/serialization/resources/batch/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/batch/index.js +17 -0
- package/dist/cjs/serialization/resources/graph/client/requests/AddDataRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/graph/client/requests/AddDataRequest.js +1 -0
- package/dist/cjs/serialization/resources/graph/client/requests/AddTripleRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/graph/client/requests/AddTripleRequest.js +1 -0
- package/dist/cjs/serialization/resources/graph/client/requests/DetectPatternsRequest.d.ts +3 -1
- package/dist/cjs/serialization/resources/graph/client/requests/DetectPatternsRequest.js +3 -1
- package/dist/cjs/serialization/resources/graph/client/requests/GraphSearchQuery.d.ts +2 -0
- package/dist/cjs/serialization/resources/graph/client/requests/GraphSearchQuery.js +2 -0
- package/dist/cjs/serialization/resources/graph/resources/episode/client/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/graph/resources/episode/client/index.js +17 -0
- package/dist/cjs/serialization/resources/graph/resources/episode/client/requests/UpdateEpisodeRequest.d.ts +12 -0
- package/dist/cjs/serialization/resources/graph/resources/episode/client/requests/UpdateEpisodeRequest.js +43 -0
- package/dist/cjs/serialization/resources/graph/resources/episode/client/requests/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/graph/resources/episode/client/requests/index.js +5 -0
- package/dist/cjs/serialization/resources/graph/resources/episode/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/graph/resources/episode/index.js +17 -0
- package/dist/cjs/serialization/resources/graph/resources/index.d.ts +4 -0
- package/dist/cjs/serialization/resources/graph/resources/index.js +5 -1
- package/dist/cjs/serialization/resources/graph/resources/observation/client/getByGraphId.d.ts +11 -0
- package/dist/cjs/serialization/resources/graph/resources/observation/client/getByGraphId.js +42 -0
- package/dist/cjs/serialization/resources/graph/resources/observation/client/getByUserId.d.ts +11 -0
- package/dist/cjs/serialization/resources/graph/resources/observation/client/getByUserId.js +42 -0
- package/dist/cjs/serialization/resources/graph/resources/observation/client/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/graph/resources/observation/client/index.js +38 -0
- package/dist/cjs/serialization/resources/graph/resources/observation/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/graph/resources/observation/index.js +17 -0
- package/dist/cjs/serialization/resources/graph/resources/threadSummary/client/getByGraphId.d.ts +11 -0
- package/dist/cjs/serialization/resources/graph/resources/threadSummary/client/getByGraphId.js +42 -0
- package/dist/cjs/serialization/resources/graph/resources/threadSummary/client/getByUserId.d.ts +11 -0
- package/dist/cjs/serialization/resources/graph/resources/threadSummary/client/getByUserId.js +42 -0
- package/dist/cjs/serialization/resources/graph/resources/threadSummary/client/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/graph/resources/threadSummary/client/index.js +38 -0
- package/dist/cjs/serialization/resources/graph/resources/threadSummary/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/graph/resources/threadSummary/index.js +17 -0
- package/dist/cjs/serialization/resources/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/index.js +3 -1
- package/dist/cjs/serialization/types/ApidataBatchAddItemRole.d.ts +10 -0
- package/dist/cjs/serialization/types/ApidataBatchAddItemRole.js +41 -0
- package/dist/cjs/serialization/types/ApidataBatchAddItemType.d.ts +10 -0
- package/dist/cjs/serialization/types/ApidataBatchAddItemType.js +41 -0
- package/dist/cjs/serialization/types/BatchAddItem.d.ts +26 -0
- package/dist/cjs/serialization/types/BatchAddItem.js +57 -0
- package/dist/cjs/serialization/types/BatchItemDetail.d.ts +25 -0
- package/dist/cjs/serialization/types/BatchItemDetail.js +56 -0
- package/dist/cjs/serialization/types/BatchItemKind.d.ts +10 -0
- package/dist/cjs/serialization/types/BatchItemKind.js +41 -0
- package/dist/cjs/serialization/types/BatchItemListResponse.d.ts +14 -0
- package/dist/cjs/serialization/types/BatchItemListResponse.js +45 -0
- package/dist/cjs/serialization/types/BatchItemStatus.d.ts +10 -0
- package/dist/cjs/serialization/types/BatchItemStatus.js +41 -0
- package/dist/cjs/serialization/types/BatchListResponse.d.ts +14 -0
- package/dist/cjs/serialization/types/{PatternExample.js → BatchListResponse.js} +5 -4
- package/dist/cjs/serialization/types/BatchProgress.d.ts +18 -0
- package/dist/cjs/serialization/types/BatchProgress.js +49 -0
- package/dist/cjs/serialization/types/BatchStatus.d.ts +10 -0
- package/dist/cjs/serialization/types/BatchStatus.js +41 -0
- package/dist/cjs/serialization/types/BatchSummary.d.ts +22 -0
- package/dist/cjs/serialization/types/BatchSummary.js +53 -0
- package/dist/cjs/serialization/types/ComparisonOperator.d.ts +1 -1
- package/dist/cjs/serialization/types/ComparisonOperator.js +1 -1
- package/dist/cjs/serialization/types/DerivedNode.d.ts +21 -0
- package/dist/cjs/serialization/types/DerivedNode.js +52 -0
- package/dist/cjs/serialization/types/DetectPatternsResponse.d.ts +2 -0
- package/dist/cjs/serialization/types/DetectPatternsResponse.js +2 -0
- package/dist/cjs/serialization/types/EntityEdge.d.ts +2 -0
- package/dist/cjs/serialization/types/EntityEdge.js +2 -0
- package/dist/cjs/serialization/types/EntityNode.d.ts +1 -0
- package/dist/cjs/serialization/types/EntityNode.js +1 -0
- package/dist/cjs/serialization/types/Episode.d.ts +1 -0
- package/dist/cjs/serialization/types/Episode.js +1 -0
- package/dist/cjs/serialization/types/EpisodeData.d.ts +1 -0
- package/dist/cjs/serialization/types/EpisodeData.js +1 -0
- package/dist/cjs/serialization/types/EpisodeMetadataFilter.d.ts +15 -0
- package/dist/cjs/serialization/types/EpisodeMetadataFilter.js +46 -0
- package/dist/cjs/serialization/types/GraphDataType.d.ts +1 -1
- package/dist/cjs/serialization/types/GraphDataType.js +1 -1
- package/dist/cjs/serialization/types/GraphObservationsRequest.d.ts +13 -0
- package/dist/cjs/serialization/types/GraphObservationsRequest.js +44 -0
- package/dist/cjs/serialization/types/GraphSearchResults.d.ts +5 -0
- package/dist/cjs/serialization/types/GraphSearchResults.js +5 -0
- package/dist/cjs/serialization/types/GraphSearchScope.d.ts +1 -1
- package/dist/cjs/serialization/types/GraphSearchScope.js +1 -1
- package/dist/cjs/serialization/types/GraphThreadSummariesRequest.d.ts +13 -0
- package/dist/cjs/serialization/types/GraphThreadSummariesRequest.js +44 -0
- package/dist/cjs/serialization/types/GraphitiMetadataFilterGroupType.d.ts +10 -0
- package/dist/cjs/serialization/types/GraphitiMetadataFilterGroupType.js +41 -0
- package/dist/cjs/serialization/types/GraphitiSagaNode.d.ts +20 -0
- package/dist/cjs/serialization/types/GraphitiSagaNode.js +51 -0
- package/dist/cjs/serialization/types/MetadataFilterGroup.d.ts +16 -0
- package/dist/cjs/serialization/types/MetadataFilterGroup.js +48 -0
- package/dist/cjs/serialization/types/PatternResult.d.ts +3 -2
- package/dist/cjs/serialization/types/PatternResult.js +3 -2
- package/dist/cjs/serialization/types/SearchFilters.d.ts +1 -0
- package/dist/cjs/serialization/types/SearchFilters.js +2 -0
- package/dist/cjs/serialization/types/ThreadSummary.d.ts +16 -0
- package/dist/cjs/serialization/types/ThreadSummary.js +47 -0
- package/dist/cjs/serialization/types/index.d.ts +19 -1
- package/dist/cjs/serialization/types/index.js +19 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +7 -2
- package/dist/esm/api/errors/BadRequestError.d.mts +1 -2
- package/dist/esm/api/errors/ConflictError.d.mts +9 -0
- package/dist/esm/api/errors/ConflictError.mjs +15 -0
- package/dist/esm/api/errors/index.d.mts +2 -1
- package/dist/esm/api/errors/index.mjs +2 -1
- package/dist/esm/api/resources/batch/client/Client.d.mts +161 -0
- package/dist/esm/api/resources/batch/client/Client.mjs +740 -0
- package/dist/esm/api/resources/batch/client/index.d.mts +2 -0
- package/dist/esm/api/resources/batch/client/index.mjs +1 -0
- package/dist/esm/api/resources/batch/client/requests/ApidataAddBatchItemsRequest.d.mts +15 -0
- package/dist/esm/api/resources/batch/client/requests/ApidataCreateBatchRequest.d.mts +10 -0
- package/dist/esm/api/resources/batch/client/requests/ApidataCreateBatchRequest.mjs +4 -0
- package/dist/esm/api/resources/batch/client/requests/BatchListItemsRequest.d.mts +25 -0
- package/dist/esm/api/resources/batch/client/requests/BatchListItemsRequest.mjs +4 -0
- package/dist/esm/api/resources/batch/client/requests/BatchListRequest.d.mts +25 -0
- package/dist/esm/api/resources/batch/client/requests/BatchListRequest.mjs +4 -0
- package/dist/esm/api/resources/batch/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/batch/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/batch/index.d.mts +1 -0
- package/dist/esm/api/resources/batch/index.mjs +1 -0
- package/dist/esm/api/resources/context/client/Client.mjs +5 -35
- package/dist/esm/api/resources/graph/client/Client.d.mts +13 -0
- package/dist/esm/api/resources/graph/client/Client.mjs +44 -82
- package/dist/esm/api/resources/graph/client/requests/AddDataRequest.d.mts +2 -0
- package/dist/esm/api/resources/graph/client/requests/AddTripleRequest.d.mts +5 -0
- package/dist/esm/api/resources/graph/client/requests/DetectPatternsRequest.d.mts +12 -4
- package/dist/esm/api/resources/graph/client/requests/GraphListAllRequest.d.mts +5 -0
- package/dist/esm/api/resources/graph/client/requests/GraphSearchQuery.d.mts +14 -2
- package/dist/esm/api/resources/graph/resources/edge/client/Client.mjs +5 -35
- package/dist/esm/api/resources/graph/resources/episode/client/Client.d.mts +21 -0
- package/dist/esm/api/resources/graph/resources/episode/client/Client.mjs +104 -30
- package/dist/esm/api/resources/graph/resources/episode/client/requests/UpdateEpisodeRequest.d.mts +15 -0
- package/dist/esm/api/resources/graph/resources/episode/client/requests/UpdateEpisodeRequest.mjs +4 -0
- package/dist/esm/api/resources/graph/resources/episode/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/graph/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/graph/resources/index.mjs +2 -0
- package/dist/esm/api/resources/graph/resources/node/client/Client.mjs +7 -49
- package/dist/esm/api/resources/graph/resources/observation/client/Client.d.mts +81 -0
- package/dist/esm/api/resources/graph/resources/observation/client/Client.mjs +296 -0
- package/dist/esm/api/resources/graph/resources/observation/client/index.d.mts +1 -0
- package/dist/esm/api/resources/graph/resources/observation/client/index.mjs +1 -0
- package/dist/esm/api/resources/graph/resources/observation/index.d.mts +1 -0
- package/dist/esm/api/resources/graph/resources/observation/index.mjs +1 -0
- package/dist/esm/api/resources/graph/resources/threadSummary/client/Client.d.mts +66 -0
- package/dist/esm/api/resources/graph/resources/threadSummary/client/Client.mjs +212 -0
- package/dist/esm/api/resources/graph/resources/threadSummary/client/index.d.mts +1 -0
- package/dist/esm/api/resources/graph/resources/threadSummary/client/index.mjs +1 -0
- package/dist/esm/api/resources/graph/resources/threadSummary/index.d.mts +1 -0
- package/dist/esm/api/resources/graph/resources/threadSummary/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/project/client/Client.mjs +1 -7
- package/dist/esm/api/resources/thread/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/thread/client/Client.mjs +92 -14
- package/dist/esm/api/resources/user/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/user/client/Client.mjs +15 -24
- package/dist/esm/api/types/ApidataBatchAddItemRole.d.mts +12 -0
- package/dist/esm/api/types/ApidataBatchAddItemRole.mjs +11 -0
- package/dist/esm/api/types/ApidataBatchAddItemType.d.mts +8 -0
- package/dist/esm/api/types/ApidataBatchAddItemType.mjs +7 -0
- package/dist/esm/api/types/BatchAddItem.d.mts +18 -0
- package/dist/esm/api/types/BatchAddItem.mjs +4 -0
- package/dist/esm/api/types/BatchItemDetail.d.mts +18 -0
- package/dist/esm/api/types/BatchItemDetail.mjs +4 -0
- package/dist/esm/api/types/BatchItemKind.d.mts +8 -0
- package/dist/esm/api/types/BatchItemKind.mjs +7 -0
- package/dist/esm/api/types/BatchItemListResponse.d.mts +8 -0
- package/dist/esm/api/types/BatchItemListResponse.mjs +4 -0
- package/dist/esm/api/types/BatchItemStatus.d.mts +12 -0
- package/dist/esm/api/types/BatchItemStatus.mjs +11 -0
- package/dist/esm/api/types/BatchListResponse.d.mts +8 -0
- package/dist/esm/api/types/BatchListResponse.mjs +4 -0
- package/dist/esm/api/types/BatchProgress.d.mts +12 -0
- package/dist/esm/api/types/BatchProgress.mjs +4 -0
- package/dist/esm/api/types/BatchStatus.d.mts +13 -0
- package/dist/esm/api/types/BatchStatus.mjs +12 -0
- package/dist/esm/api/types/BatchSummary.d.mts +15 -0
- package/dist/esm/api/types/BatchSummary.mjs +4 -0
- package/dist/esm/api/types/ComparisonOperator.d.mts +2 -1
- package/dist/esm/api/types/ComparisonOperator.mjs +1 -0
- package/dist/esm/api/types/DateFilter.d.mts +1 -1
- package/dist/esm/api/types/DerivedNode.d.mts +28 -0
- package/dist/esm/api/types/DerivedNode.mjs +4 -0
- package/dist/esm/api/types/DetectPatternsResponse.d.mts +2 -0
- package/dist/esm/api/types/EntityEdge.d.mts +4 -0
- package/dist/esm/api/types/EntityNode.d.mts +2 -0
- package/dist/esm/api/types/Episode.d.mts +2 -0
- package/dist/esm/api/types/EpisodeData.d.mts +2 -0
- package/dist/esm/api/types/EpisodeMetadataFilter.d.mts +12 -0
- package/dist/esm/api/types/EpisodeMetadataFilter.mjs +4 -0
- package/dist/esm/api/types/GraphDataType.d.mts +2 -1
- package/dist/esm/api/types/GraphDataType.mjs +1 -0
- package/dist/esm/api/types/GraphObservationsRequest.d.mts +9 -0
- package/dist/esm/api/types/GraphObservationsRequest.mjs +4 -0
- package/dist/esm/api/types/GraphSearchResults.d.mts +3 -0
- package/dist/esm/api/types/GraphSearchScope.d.mts +4 -1
- package/dist/esm/api/types/GraphSearchScope.mjs +3 -0
- package/dist/esm/api/types/GraphThreadSummariesRequest.d.mts +9 -0
- package/dist/esm/api/types/GraphThreadSummariesRequest.mjs +4 -0
- package/dist/esm/api/types/GraphitiMetadataFilterGroupType.d.mts +11 -0
- package/dist/esm/api/types/GraphitiMetadataFilterGroupType.mjs +7 -0
- package/dist/esm/api/types/GraphitiSagaNode.d.mts +26 -0
- package/dist/esm/api/types/GraphitiSagaNode.mjs +4 -0
- package/dist/esm/api/types/MetadataFilterGroup.d.mts +12 -0
- package/dist/esm/api/types/MetadataFilterGroup.mjs +4 -0
- package/dist/esm/api/types/PatternResult.d.mts +22 -5
- package/dist/esm/api/types/PatternSeeds.d.mts +1 -1
- package/dist/esm/api/types/PropertyFilter.d.mts +1 -1
- package/dist/esm/api/types/SearchFilters.d.mts +14 -9
- package/dist/esm/api/types/ThreadSummary.d.mts +20 -0
- package/dist/esm/api/types/ThreadSummary.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +19 -1
- package/dist/esm/api/types/index.mjs +19 -1
- package/dist/esm/serialization/resources/batch/client/add.d.mts +11 -0
- package/dist/esm/serialization/resources/batch/client/add.mjs +6 -0
- package/dist/esm/serialization/resources/batch/client/index.d.mts +2 -0
- package/dist/esm/serialization/resources/batch/client/index.mjs +2 -0
- package/dist/esm/serialization/resources/batch/client/requests/ApidataAddBatchItemsRequest.d.mts +13 -0
- package/dist/esm/serialization/resources/batch/client/requests/ApidataAddBatchItemsRequest.mjs +8 -0
- package/dist/esm/serialization/resources/batch/client/requests/ApidataCreateBatchRequest.d.mts +12 -0
- package/dist/esm/serialization/resources/batch/client/requests/ApidataCreateBatchRequest.mjs +7 -0
- package/dist/esm/serialization/resources/batch/client/requests/index.d.mts +2 -0
- package/dist/esm/serialization/resources/batch/client/requests/index.mjs +2 -0
- package/dist/esm/serialization/resources/batch/index.d.mts +1 -0
- package/dist/esm/serialization/resources/batch/index.mjs +1 -0
- package/dist/esm/serialization/resources/graph/client/requests/AddDataRequest.d.mts +1 -0
- package/dist/esm/serialization/resources/graph/client/requests/AddDataRequest.mjs +1 -0
- package/dist/esm/serialization/resources/graph/client/requests/AddTripleRequest.d.mts +1 -0
- package/dist/esm/serialization/resources/graph/client/requests/AddTripleRequest.mjs +1 -0
- package/dist/esm/serialization/resources/graph/client/requests/DetectPatternsRequest.d.mts +3 -1
- package/dist/esm/serialization/resources/graph/client/requests/DetectPatternsRequest.mjs +3 -1
- package/dist/esm/serialization/resources/graph/client/requests/GraphSearchQuery.d.mts +2 -0
- package/dist/esm/serialization/resources/graph/client/requests/GraphSearchQuery.mjs +2 -0
- package/dist/esm/serialization/resources/graph/resources/episode/client/index.d.mts +1 -0
- package/dist/esm/serialization/resources/graph/resources/episode/client/index.mjs +1 -0
- package/dist/esm/serialization/resources/graph/resources/episode/client/requests/UpdateEpisodeRequest.d.mts +12 -0
- package/dist/esm/serialization/resources/graph/resources/episode/client/requests/UpdateEpisodeRequest.mjs +7 -0
- package/dist/esm/serialization/resources/graph/resources/episode/client/requests/index.d.mts +1 -0
- package/dist/esm/serialization/resources/graph/resources/episode/client/requests/index.mjs +1 -0
- package/dist/esm/serialization/resources/graph/resources/episode/index.d.mts +1 -0
- package/dist/esm/serialization/resources/graph/resources/episode/index.mjs +1 -0
- package/dist/esm/serialization/resources/graph/resources/index.d.mts +4 -0
- package/dist/esm/serialization/resources/graph/resources/index.mjs +4 -0
- package/dist/esm/serialization/resources/graph/resources/observation/client/getByGraphId.d.mts +11 -0
- package/dist/esm/serialization/resources/graph/resources/observation/client/getByGraphId.mjs +6 -0
- package/dist/esm/serialization/resources/graph/resources/observation/client/getByUserId.d.mts +11 -0
- package/dist/esm/serialization/resources/graph/resources/observation/client/getByUserId.mjs +6 -0
- package/dist/esm/serialization/resources/graph/resources/observation/client/index.d.mts +2 -0
- package/dist/esm/serialization/resources/graph/resources/observation/client/index.mjs +2 -0
- package/dist/esm/serialization/resources/graph/resources/observation/index.d.mts +1 -0
- package/dist/esm/serialization/resources/graph/resources/observation/index.mjs +1 -0
- package/dist/esm/serialization/resources/graph/resources/threadSummary/client/getByGraphId.d.mts +11 -0
- package/dist/esm/serialization/resources/graph/resources/threadSummary/client/getByGraphId.mjs +6 -0
- package/dist/esm/serialization/resources/graph/resources/threadSummary/client/getByUserId.d.mts +11 -0
- package/dist/esm/serialization/resources/graph/resources/threadSummary/client/getByUserId.mjs +6 -0
- package/dist/esm/serialization/resources/graph/resources/threadSummary/client/index.d.mts +2 -0
- package/dist/esm/serialization/resources/graph/resources/threadSummary/client/index.mjs +2 -0
- package/dist/esm/serialization/resources/graph/resources/threadSummary/index.d.mts +1 -0
- package/dist/esm/serialization/resources/graph/resources/threadSummary/index.mjs +1 -0
- package/dist/esm/serialization/resources/index.d.mts +2 -0
- package/dist/esm/serialization/resources/index.mjs +2 -0
- package/dist/esm/serialization/types/ApidataBatchAddItemRole.d.mts +10 -0
- package/dist/esm/serialization/types/ApidataBatchAddItemRole.mjs +5 -0
- package/dist/esm/serialization/types/ApidataBatchAddItemType.d.mts +10 -0
- package/dist/esm/serialization/types/ApidataBatchAddItemType.mjs +5 -0
- package/dist/esm/serialization/types/BatchAddItem.d.mts +26 -0
- package/dist/esm/serialization/types/BatchAddItem.mjs +21 -0
- package/dist/esm/serialization/types/BatchItemDetail.d.mts +25 -0
- package/dist/esm/serialization/types/BatchItemDetail.mjs +20 -0
- package/dist/esm/serialization/types/BatchItemKind.d.mts +10 -0
- package/dist/esm/serialization/types/BatchItemKind.mjs +5 -0
- package/dist/esm/serialization/types/BatchItemListResponse.d.mts +14 -0
- package/dist/esm/serialization/types/BatchItemListResponse.mjs +9 -0
- package/dist/esm/serialization/types/BatchItemStatus.d.mts +10 -0
- package/dist/esm/serialization/types/BatchItemStatus.mjs +5 -0
- package/dist/esm/serialization/types/BatchListResponse.d.mts +14 -0
- package/dist/esm/serialization/types/BatchListResponse.mjs +9 -0
- package/dist/esm/serialization/types/BatchProgress.d.mts +18 -0
- package/dist/esm/serialization/types/BatchProgress.mjs +13 -0
- package/dist/esm/serialization/types/BatchStatus.d.mts +10 -0
- package/dist/esm/serialization/types/BatchStatus.mjs +5 -0
- package/dist/esm/serialization/types/BatchSummary.d.mts +22 -0
- package/dist/esm/serialization/types/BatchSummary.mjs +17 -0
- package/dist/esm/serialization/types/ComparisonOperator.d.mts +1 -1
- package/dist/esm/serialization/types/ComparisonOperator.mjs +1 -1
- package/dist/esm/serialization/types/DerivedNode.d.mts +21 -0
- package/dist/esm/serialization/types/DerivedNode.mjs +16 -0
- package/dist/esm/serialization/types/DetectPatternsResponse.d.mts +2 -0
- package/dist/esm/serialization/types/DetectPatternsResponse.mjs +2 -0
- package/dist/esm/serialization/types/EntityEdge.d.mts +2 -0
- package/dist/esm/serialization/types/EntityEdge.mjs +2 -0
- package/dist/esm/serialization/types/EntityNode.d.mts +1 -0
- package/dist/esm/serialization/types/EntityNode.mjs +1 -0
- package/dist/esm/serialization/types/Episode.d.mts +1 -0
- package/dist/esm/serialization/types/Episode.mjs +1 -0
- package/dist/esm/serialization/types/EpisodeData.d.mts +1 -0
- package/dist/esm/serialization/types/EpisodeData.mjs +1 -0
- package/dist/esm/serialization/types/EpisodeMetadataFilter.d.mts +15 -0
- package/dist/esm/serialization/types/EpisodeMetadataFilter.mjs +10 -0
- package/dist/esm/serialization/types/GraphDataType.d.mts +1 -1
- package/dist/esm/serialization/types/GraphDataType.mjs +1 -1
- package/dist/esm/serialization/types/GraphObservationsRequest.d.mts +13 -0
- package/dist/esm/serialization/types/GraphObservationsRequest.mjs +8 -0
- package/dist/esm/serialization/types/GraphSearchResults.d.mts +5 -0
- package/dist/esm/serialization/types/GraphSearchResults.mjs +5 -0
- package/dist/esm/serialization/types/GraphSearchScope.d.mts +1 -1
- package/dist/esm/serialization/types/GraphSearchScope.mjs +1 -1
- package/dist/esm/serialization/types/GraphThreadSummariesRequest.d.mts +13 -0
- package/dist/esm/serialization/types/GraphThreadSummariesRequest.mjs +8 -0
- package/dist/esm/serialization/types/GraphitiMetadataFilterGroupType.d.mts +10 -0
- package/dist/esm/serialization/types/GraphitiMetadataFilterGroupType.mjs +5 -0
- package/dist/esm/serialization/types/GraphitiSagaNode.d.mts +20 -0
- package/dist/esm/serialization/types/GraphitiSagaNode.mjs +15 -0
- package/dist/esm/serialization/types/MetadataFilterGroup.d.mts +16 -0
- package/dist/esm/serialization/types/MetadataFilterGroup.mjs +12 -0
- package/dist/esm/serialization/types/PatternResult.d.mts +3 -2
- package/dist/esm/serialization/types/PatternResult.mjs +3 -2
- package/dist/esm/serialization/types/SearchFilters.d.mts +1 -0
- package/dist/esm/serialization/types/SearchFilters.mjs +2 -0
- package/dist/esm/serialization/types/ThreadSummary.d.mts +16 -0
- package/dist/esm/serialization/types/ThreadSummary.mjs +11 -0
- package/dist/esm/serialization/types/index.d.mts +19 -1
- package/dist/esm/serialization/types/index.mjs +19 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +16 -9
- package/reference.md +1414 -449
- package/dist/cjs/api/types/PatternExample.d.ts +0 -9
- package/dist/cjs/serialization/types/PatternExample.d.ts +0 -13
- package/dist/esm/api/types/PatternExample.d.mts +0 -9
- package/dist/esm/serialization/types/PatternExample.d.mts +0 -13
- package/dist/esm/serialization/types/PatternExample.mjs +0 -8
- /package/dist/cjs/api/{types/PatternExample.js → resources/batch/client/requests/ApidataAddBatchItemsRequest.js} +0 -0
- /package/dist/esm/api/{types/PatternExample.mjs → resources/batch/client/requests/ApidataAddBatchItemsRequest.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Batch
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.
|
|
5
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">list</a>({ ...params }) -> Zep.BatchListResponse</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
List batches for the current project, optionally filtered by batch status.
|
|
18
18
|
|
|
19
19
|
</dd>
|
|
20
20
|
</dl>
|
|
@@ -30,7 +30,11 @@ Lists all context templates.
|
|
|
30
30
|
<dd>
|
|
31
31
|
|
|
32
32
|
```typescript
|
|
33
|
-
await client.
|
|
33
|
+
await client.batch.list({
|
|
34
|
+
limit: 1,
|
|
35
|
+
cursor: 1,
|
|
36
|
+
status: "status",
|
|
37
|
+
});
|
|
34
38
|
```
|
|
35
39
|
|
|
36
40
|
</dd>
|
|
@@ -46,7 +50,15 @@ await client.context.listContextTemplates();
|
|
|
46
50
|
<dl>
|
|
47
51
|
<dd>
|
|
48
52
|
|
|
49
|
-
**
|
|
53
|
+
**request:** `Zep.BatchListRequest`
|
|
54
|
+
|
|
55
|
+
</dd>
|
|
56
|
+
</dl>
|
|
57
|
+
|
|
58
|
+
<dl>
|
|
59
|
+
<dd>
|
|
60
|
+
|
|
61
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
50
62
|
|
|
51
63
|
</dd>
|
|
52
64
|
</dl>
|
|
@@ -57,7 +69,7 @@ await client.context.listContextTemplates();
|
|
|
57
69
|
</dl>
|
|
58
70
|
</details>
|
|
59
71
|
|
|
60
|
-
<details><summary><code>client.
|
|
72
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">create</a>({ ...params }) -> Zep.BatchSummary</code></summary>
|
|
61
73
|
<dl>
|
|
62
74
|
<dd>
|
|
63
75
|
|
|
@@ -69,7 +81,7 @@ await client.context.listContextTemplates();
|
|
|
69
81
|
<dl>
|
|
70
82
|
<dd>
|
|
71
83
|
|
|
72
|
-
|
|
84
|
+
Create a draft batch that can be filled with graph episodes and thread messages.
|
|
73
85
|
|
|
74
86
|
</dd>
|
|
75
87
|
</dl>
|
|
@@ -85,10 +97,7 @@ Creates a new context template.
|
|
|
85
97
|
<dd>
|
|
86
98
|
|
|
87
99
|
```typescript
|
|
88
|
-
await client.
|
|
89
|
-
template: "template",
|
|
90
|
-
templateId: "template_id",
|
|
91
|
-
});
|
|
100
|
+
await client.batch.create();
|
|
92
101
|
```
|
|
93
102
|
|
|
94
103
|
</dd>
|
|
@@ -104,7 +113,7 @@ await client.context.createContextTemplate({
|
|
|
104
113
|
<dl>
|
|
105
114
|
<dd>
|
|
106
115
|
|
|
107
|
-
**request:** `Zep.
|
|
116
|
+
**request:** `Zep.ApidataCreateBatchRequest`
|
|
108
117
|
|
|
109
118
|
</dd>
|
|
110
119
|
</dl>
|
|
@@ -112,7 +121,7 @@ await client.context.createContextTemplate({
|
|
|
112
121
|
<dl>
|
|
113
122
|
<dd>
|
|
114
123
|
|
|
115
|
-
**requestOptions:** `
|
|
124
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
116
125
|
|
|
117
126
|
</dd>
|
|
118
127
|
</dl>
|
|
@@ -123,7 +132,7 @@ await client.context.createContextTemplate({
|
|
|
123
132
|
</dl>
|
|
124
133
|
</details>
|
|
125
134
|
|
|
126
|
-
<details><summary><code>client.
|
|
135
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">get</a>(batchId) -> Zep.BatchSummary</code></summary>
|
|
127
136
|
<dl>
|
|
128
137
|
<dd>
|
|
129
138
|
|
|
@@ -135,7 +144,7 @@ await client.context.createContextTemplate({
|
|
|
135
144
|
<dl>
|
|
136
145
|
<dd>
|
|
137
146
|
|
|
138
|
-
|
|
147
|
+
Get a batch summary, including runtime progress when the batch has been processed.
|
|
139
148
|
|
|
140
149
|
</dd>
|
|
141
150
|
</dl>
|
|
@@ -151,7 +160,7 @@ Retrieves a context template by template_id.
|
|
|
151
160
|
<dd>
|
|
152
161
|
|
|
153
162
|
```typescript
|
|
154
|
-
await client.
|
|
163
|
+
await client.batch.get("batchId");
|
|
155
164
|
```
|
|
156
165
|
|
|
157
166
|
</dd>
|
|
@@ -167,7 +176,7 @@ await client.context.getContextTemplate("template_id");
|
|
|
167
176
|
<dl>
|
|
168
177
|
<dd>
|
|
169
178
|
|
|
170
|
-
**
|
|
179
|
+
**batchId:** `string` — The batch ID.
|
|
171
180
|
|
|
172
181
|
</dd>
|
|
173
182
|
</dl>
|
|
@@ -175,7 +184,7 @@ await client.context.getContextTemplate("template_id");
|
|
|
175
184
|
<dl>
|
|
176
185
|
<dd>
|
|
177
186
|
|
|
178
|
-
**requestOptions:** `
|
|
187
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
179
188
|
|
|
180
189
|
</dd>
|
|
181
190
|
</dl>
|
|
@@ -186,7 +195,7 @@ await client.context.getContextTemplate("template_id");
|
|
|
186
195
|
</dl>
|
|
187
196
|
</details>
|
|
188
197
|
|
|
189
|
-
<details><summary><code>client.
|
|
198
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">delete</a>(batchId) -> Zep.SuccessResponse</code></summary>
|
|
190
199
|
<dl>
|
|
191
200
|
<dd>
|
|
192
201
|
|
|
@@ -198,7 +207,7 @@ await client.context.getContextTemplate("template_id");
|
|
|
198
207
|
<dl>
|
|
199
208
|
<dd>
|
|
200
209
|
|
|
201
|
-
|
|
210
|
+
Delete a draft or invalid unprocessed batch. Processed batches cannot be deleted.
|
|
202
211
|
|
|
203
212
|
</dd>
|
|
204
213
|
</dl>
|
|
@@ -214,9 +223,7 @@ Updates an existing context template by template_id.
|
|
|
214
223
|
<dd>
|
|
215
224
|
|
|
216
225
|
```typescript
|
|
217
|
-
await client.
|
|
218
|
-
template: "template",
|
|
219
|
-
});
|
|
226
|
+
await client.batch.delete("batchId");
|
|
220
227
|
```
|
|
221
228
|
|
|
222
229
|
</dd>
|
|
@@ -232,15 +239,7 @@ await client.context.updateContextTemplate("template_id", {
|
|
|
232
239
|
<dl>
|
|
233
240
|
<dd>
|
|
234
241
|
|
|
235
|
-
**
|
|
236
|
-
|
|
237
|
-
</dd>
|
|
238
|
-
</dl>
|
|
239
|
-
|
|
240
|
-
<dl>
|
|
241
|
-
<dd>
|
|
242
|
-
|
|
243
|
-
**request:** `Zep.UpdateContextTemplateRequest`
|
|
242
|
+
**batchId:** `string` — The batch ID.
|
|
244
243
|
|
|
245
244
|
</dd>
|
|
246
245
|
</dl>
|
|
@@ -248,7 +247,7 @@ await client.context.updateContextTemplate("template_id", {
|
|
|
248
247
|
<dl>
|
|
249
248
|
<dd>
|
|
250
249
|
|
|
251
|
-
**requestOptions:** `
|
|
250
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
252
251
|
|
|
253
252
|
</dd>
|
|
254
253
|
</dl>
|
|
@@ -259,7 +258,7 @@ await client.context.updateContextTemplate("template_id", {
|
|
|
259
258
|
</dl>
|
|
260
259
|
</details>
|
|
261
260
|
|
|
262
|
-
<details><summary><code>client.
|
|
261
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">listItems</a>(batchId, { ...params }) -> Zep.BatchItemListResponse</code></summary>
|
|
263
262
|
<dl>
|
|
264
263
|
<dd>
|
|
265
264
|
|
|
@@ -271,7 +270,7 @@ await client.context.updateContextTemplate("template_id", {
|
|
|
271
270
|
<dl>
|
|
272
271
|
<dd>
|
|
273
272
|
|
|
274
|
-
|
|
273
|
+
List items in a batch, including derived runtime status when the batch has been processed.
|
|
275
274
|
|
|
276
275
|
</dd>
|
|
277
276
|
</dl>
|
|
@@ -287,7 +286,11 @@ Deletes a context template by template_id.
|
|
|
287
286
|
<dd>
|
|
288
287
|
|
|
289
288
|
```typescript
|
|
290
|
-
await client.
|
|
289
|
+
await client.batch.listItems("batchId", {
|
|
290
|
+
limit: 1,
|
|
291
|
+
cursor: 1,
|
|
292
|
+
status: "status",
|
|
293
|
+
});
|
|
291
294
|
```
|
|
292
295
|
|
|
293
296
|
</dd>
|
|
@@ -303,7 +306,7 @@ await client.context.deleteContextTemplate("template_id");
|
|
|
303
306
|
<dl>
|
|
304
307
|
<dd>
|
|
305
308
|
|
|
306
|
-
**
|
|
309
|
+
**batchId:** `string` — The batch ID.
|
|
307
310
|
|
|
308
311
|
</dd>
|
|
309
312
|
</dl>
|
|
@@ -311,7 +314,15 @@ await client.context.deleteContextTemplate("template_id");
|
|
|
311
314
|
<dl>
|
|
312
315
|
<dd>
|
|
313
316
|
|
|
314
|
-
**
|
|
317
|
+
**request:** `Zep.BatchListItemsRequest`
|
|
318
|
+
|
|
319
|
+
</dd>
|
|
320
|
+
</dl>
|
|
321
|
+
|
|
322
|
+
<dl>
|
|
323
|
+
<dd>
|
|
324
|
+
|
|
325
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
315
326
|
|
|
316
327
|
</dd>
|
|
317
328
|
</dl>
|
|
@@ -322,9 +333,7 @@ await client.context.deleteContextTemplate("template_id");
|
|
|
322
333
|
</dl>
|
|
323
334
|
</details>
|
|
324
335
|
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">listCustomInstructions</a>({ ...params }) -> Zep.ListCustomInstructionsResponse</code></summary>
|
|
336
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">add</a>(batchId, { ...params }) -> Zep.BatchItemDetail[]</code></summary>
|
|
328
337
|
<dl>
|
|
329
338
|
<dd>
|
|
330
339
|
|
|
@@ -336,7 +345,7 @@ await client.context.deleteContextTemplate("template_id");
|
|
|
336
345
|
<dl>
|
|
337
346
|
<dd>
|
|
338
347
|
|
|
339
|
-
|
|
348
|
+
Add graph episodes and thread messages to a draft batch. Items are appended in request order.
|
|
340
349
|
|
|
341
350
|
</dd>
|
|
342
351
|
</dl>
|
|
@@ -352,9 +361,12 @@ Lists all custom instructions for a project, user, or graph.
|
|
|
352
361
|
<dd>
|
|
353
362
|
|
|
354
363
|
```typescript
|
|
355
|
-
await client.
|
|
356
|
-
|
|
357
|
-
|
|
364
|
+
await client.batch.add("batchId", {
|
|
365
|
+
items: [
|
|
366
|
+
{
|
|
367
|
+
type: "graph_episode",
|
|
368
|
+
},
|
|
369
|
+
],
|
|
358
370
|
});
|
|
359
371
|
```
|
|
360
372
|
|
|
@@ -371,7 +383,7 @@ await client.graph.listCustomInstructions({
|
|
|
371
383
|
<dl>
|
|
372
384
|
<dd>
|
|
373
385
|
|
|
374
|
-
**
|
|
386
|
+
**batchId:** `string` — The batch ID.
|
|
375
387
|
|
|
376
388
|
</dd>
|
|
377
389
|
</dl>
|
|
@@ -379,7 +391,15 @@ await client.graph.listCustomInstructions({
|
|
|
379
391
|
<dl>
|
|
380
392
|
<dd>
|
|
381
393
|
|
|
382
|
-
**
|
|
394
|
+
**request:** `Zep.ApidataAddBatchItemsRequest`
|
|
395
|
+
|
|
396
|
+
</dd>
|
|
397
|
+
</dl>
|
|
398
|
+
|
|
399
|
+
<dl>
|
|
400
|
+
<dd>
|
|
401
|
+
|
|
402
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
383
403
|
|
|
384
404
|
</dd>
|
|
385
405
|
</dl>
|
|
@@ -390,7 +410,7 @@ await client.graph.listCustomInstructions({
|
|
|
390
410
|
</dl>
|
|
391
411
|
</details>
|
|
392
412
|
|
|
393
|
-
<details><summary><code>client.
|
|
413
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">process</a>(batchId) -> Zep.BatchSummary</code></summary>
|
|
394
414
|
<dl>
|
|
395
415
|
<dd>
|
|
396
416
|
|
|
@@ -402,7 +422,7 @@ await client.graph.listCustomInstructions({
|
|
|
402
422
|
<dl>
|
|
403
423
|
<dd>
|
|
404
424
|
|
|
405
|
-
|
|
425
|
+
Start processing a filled batch. Repeated calls return the existing batch run.
|
|
406
426
|
|
|
407
427
|
</dd>
|
|
408
428
|
</dl>
|
|
@@ -418,14 +438,7 @@ Adds new custom instructions for graphs without removing existing ones. If user_
|
|
|
418
438
|
<dd>
|
|
419
439
|
|
|
420
440
|
```typescript
|
|
421
|
-
await client.
|
|
422
|
-
instructions: [
|
|
423
|
-
{
|
|
424
|
-
name: "name",
|
|
425
|
-
text: "text",
|
|
426
|
-
},
|
|
427
|
-
],
|
|
428
|
-
});
|
|
441
|
+
await client.batch.process("batchId");
|
|
429
442
|
```
|
|
430
443
|
|
|
431
444
|
</dd>
|
|
@@ -441,7 +454,7 @@ await client.graph.addCustomInstructions({
|
|
|
441
454
|
<dl>
|
|
442
455
|
<dd>
|
|
443
456
|
|
|
444
|
-
**
|
|
457
|
+
**batchId:** `string` — The batch ID.
|
|
445
458
|
|
|
446
459
|
</dd>
|
|
447
460
|
</dl>
|
|
@@ -449,7 +462,7 @@ await client.graph.addCustomInstructions({
|
|
|
449
462
|
<dl>
|
|
450
463
|
<dd>
|
|
451
464
|
|
|
452
|
-
**requestOptions:** `
|
|
465
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
453
466
|
|
|
454
467
|
</dd>
|
|
455
468
|
</dl>
|
|
@@ -460,7 +473,9 @@ await client.graph.addCustomInstructions({
|
|
|
460
473
|
</dl>
|
|
461
474
|
</details>
|
|
462
475
|
|
|
463
|
-
|
|
476
|
+
## Context
|
|
477
|
+
|
|
478
|
+
<details><summary><code>client.context.<a href="/src/api/resources/context/client/Client.ts">listContextTemplates</a>() -> Zep.ListContextTemplatesResponse</code></summary>
|
|
464
479
|
<dl>
|
|
465
480
|
<dd>
|
|
466
481
|
|
|
@@ -472,7 +487,7 @@ await client.graph.addCustomInstructions({
|
|
|
472
487
|
<dl>
|
|
473
488
|
<dd>
|
|
474
489
|
|
|
475
|
-
|
|
490
|
+
Lists all context templates.
|
|
476
491
|
|
|
477
492
|
</dd>
|
|
478
493
|
</dl>
|
|
@@ -488,7 +503,7 @@ Deletes custom instructions for graphs or project wide defaults.
|
|
|
488
503
|
<dd>
|
|
489
504
|
|
|
490
505
|
```typescript
|
|
491
|
-
await client.
|
|
506
|
+
await client.context.listContextTemplates();
|
|
492
507
|
```
|
|
493
508
|
|
|
494
509
|
</dd>
|
|
@@ -504,15 +519,7 @@ await client.graph.deleteCustomInstructions();
|
|
|
504
519
|
<dl>
|
|
505
520
|
<dd>
|
|
506
521
|
|
|
507
|
-
**
|
|
508
|
-
|
|
509
|
-
</dd>
|
|
510
|
-
</dl>
|
|
511
|
-
|
|
512
|
-
<dl>
|
|
513
|
-
<dd>
|
|
514
|
-
|
|
515
|
-
**requestOptions:** `Graph.RequestOptions`
|
|
522
|
+
**requestOptions:** `Context.RequestOptions`
|
|
516
523
|
|
|
517
524
|
</dd>
|
|
518
525
|
</dl>
|
|
@@ -523,7 +530,7 @@ await client.graph.deleteCustomInstructions();
|
|
|
523
530
|
</dl>
|
|
524
531
|
</details>
|
|
525
532
|
|
|
526
|
-
<details><summary><code>client.
|
|
533
|
+
<details><summary><code>client.context.<a href="/src/api/resources/context/client/Client.ts">createContextTemplate</a>({ ...params }) -> Zep.ContextTemplateResponse</code></summary>
|
|
527
534
|
<dl>
|
|
528
535
|
<dd>
|
|
529
536
|
|
|
@@ -535,7 +542,7 @@ await client.graph.deleteCustomInstructions();
|
|
|
535
542
|
<dl>
|
|
536
543
|
<dd>
|
|
537
544
|
|
|
538
|
-
|
|
545
|
+
Creates a new context template.
|
|
539
546
|
|
|
540
547
|
</dd>
|
|
541
548
|
</dl>
|
|
@@ -551,9 +558,9 @@ Returns all entity types for a project, user, or graph.
|
|
|
551
558
|
<dd>
|
|
552
559
|
|
|
553
560
|
```typescript
|
|
554
|
-
await client.
|
|
555
|
-
|
|
556
|
-
|
|
561
|
+
await client.context.createContextTemplate({
|
|
562
|
+
template: "template",
|
|
563
|
+
templateId: "template_id",
|
|
557
564
|
});
|
|
558
565
|
```
|
|
559
566
|
|
|
@@ -570,7 +577,7 @@ await client.graph.listEntityTypes({
|
|
|
570
577
|
<dl>
|
|
571
578
|
<dd>
|
|
572
579
|
|
|
573
|
-
**request:** `Zep.
|
|
580
|
+
**request:** `Zep.CreateContextTemplateRequest`
|
|
574
581
|
|
|
575
582
|
</dd>
|
|
576
583
|
</dl>
|
|
@@ -578,7 +585,7 @@ await client.graph.listEntityTypes({
|
|
|
578
585
|
<dl>
|
|
579
586
|
<dd>
|
|
580
587
|
|
|
581
|
-
**requestOptions:** `
|
|
588
|
+
**requestOptions:** `Context.RequestOptions`
|
|
582
589
|
|
|
583
590
|
</dd>
|
|
584
591
|
</dl>
|
|
@@ -589,7 +596,7 @@ await client.graph.listEntityTypes({
|
|
|
589
596
|
</dl>
|
|
590
597
|
</details>
|
|
591
598
|
|
|
592
|
-
<details><summary><code>client.
|
|
599
|
+
<details><summary><code>client.context.<a href="/src/api/resources/context/client/Client.ts">getContextTemplate</a>(templateId) -> Zep.ContextTemplateResponse</code></summary>
|
|
593
600
|
<dl>
|
|
594
601
|
<dd>
|
|
595
602
|
|
|
@@ -601,7 +608,7 @@ await client.graph.listEntityTypes({
|
|
|
601
608
|
<dl>
|
|
602
609
|
<dd>
|
|
603
610
|
|
|
604
|
-
|
|
611
|
+
Retrieves a context template by template_id.
|
|
605
612
|
|
|
606
613
|
</dd>
|
|
607
614
|
</dl>
|
|
@@ -617,7 +624,7 @@ Sets the entity types for multiple users and graphs, replacing any existing ones
|
|
|
617
624
|
<dd>
|
|
618
625
|
|
|
619
626
|
```typescript
|
|
620
|
-
await client.
|
|
627
|
+
await client.context.getContextTemplate("template_id");
|
|
621
628
|
```
|
|
622
629
|
|
|
623
630
|
</dd>
|
|
@@ -633,7 +640,7 @@ await client.graph.setEntityTypesInternal();
|
|
|
633
640
|
<dl>
|
|
634
641
|
<dd>
|
|
635
642
|
|
|
636
|
-
**
|
|
643
|
+
**templateId:** `string` — Template ID
|
|
637
644
|
|
|
638
645
|
</dd>
|
|
639
646
|
</dl>
|
|
@@ -641,7 +648,7 @@ await client.graph.setEntityTypesInternal();
|
|
|
641
648
|
<dl>
|
|
642
649
|
<dd>
|
|
643
650
|
|
|
644
|
-
**requestOptions:** `
|
|
651
|
+
**requestOptions:** `Context.RequestOptions`
|
|
645
652
|
|
|
646
653
|
</dd>
|
|
647
654
|
</dl>
|
|
@@ -652,7 +659,7 @@ await client.graph.setEntityTypesInternal();
|
|
|
652
659
|
</dl>
|
|
653
660
|
</details>
|
|
654
661
|
|
|
655
|
-
<details><summary><code>client.
|
|
662
|
+
<details><summary><code>client.context.<a href="/src/api/resources/context/client/Client.ts">updateContextTemplate</a>(templateId, { ...params }) -> Zep.ContextTemplateResponse</code></summary>
|
|
656
663
|
<dl>
|
|
657
664
|
<dd>
|
|
658
665
|
|
|
@@ -664,7 +671,7 @@ await client.graph.setEntityTypesInternal();
|
|
|
664
671
|
<dl>
|
|
665
672
|
<dd>
|
|
666
673
|
|
|
667
|
-
|
|
674
|
+
Updates an existing context template by template_id.
|
|
668
675
|
|
|
669
676
|
</dd>
|
|
670
677
|
</dl>
|
|
@@ -680,9 +687,8 @@ Add data to the graph.
|
|
|
680
687
|
<dd>
|
|
681
688
|
|
|
682
689
|
```typescript
|
|
683
|
-
await client.
|
|
684
|
-
|
|
685
|
-
type: "text",
|
|
690
|
+
await client.context.updateContextTemplate("template_id", {
|
|
691
|
+
template: "template",
|
|
686
692
|
});
|
|
687
693
|
```
|
|
688
694
|
|
|
@@ -699,7 +705,7 @@ await client.graph.add({
|
|
|
699
705
|
<dl>
|
|
700
706
|
<dd>
|
|
701
707
|
|
|
702
|
-
**
|
|
708
|
+
**templateId:** `string` — Template ID
|
|
703
709
|
|
|
704
710
|
</dd>
|
|
705
711
|
</dl>
|
|
@@ -707,7 +713,15 @@ await client.graph.add({
|
|
|
707
713
|
<dl>
|
|
708
714
|
<dd>
|
|
709
715
|
|
|
710
|
-
**
|
|
716
|
+
**request:** `Zep.UpdateContextTemplateRequest`
|
|
717
|
+
|
|
718
|
+
</dd>
|
|
719
|
+
</dl>
|
|
720
|
+
|
|
721
|
+
<dl>
|
|
722
|
+
<dd>
|
|
723
|
+
|
|
724
|
+
**requestOptions:** `Context.RequestOptions`
|
|
711
725
|
|
|
712
726
|
</dd>
|
|
713
727
|
</dl>
|
|
@@ -718,7 +732,7 @@ await client.graph.add({
|
|
|
718
732
|
</dl>
|
|
719
733
|
</details>
|
|
720
734
|
|
|
721
|
-
<details><summary><code>client.
|
|
735
|
+
<details><summary><code>client.context.<a href="/src/api/resources/context/client/Client.ts">deleteContextTemplate</a>(templateId) -> Zep.SuccessResponse</code></summary>
|
|
722
736
|
<dl>
|
|
723
737
|
<dd>
|
|
724
738
|
|
|
@@ -730,7 +744,7 @@ await client.graph.add({
|
|
|
730
744
|
<dl>
|
|
731
745
|
<dd>
|
|
732
746
|
|
|
733
|
-
|
|
747
|
+
Deletes a context template by template_id.
|
|
734
748
|
|
|
735
749
|
</dd>
|
|
736
750
|
</dl>
|
|
@@ -746,14 +760,7 @@ Add data to the graph in batch mode. Episodes are processed sequentially in the
|
|
|
746
760
|
<dd>
|
|
747
761
|
|
|
748
762
|
```typescript
|
|
749
|
-
await client.
|
|
750
|
-
episodes: [
|
|
751
|
-
{
|
|
752
|
-
data: "data",
|
|
753
|
-
type: "text",
|
|
754
|
-
},
|
|
755
|
-
],
|
|
756
|
-
});
|
|
763
|
+
await client.context.deleteContextTemplate("template_id");
|
|
757
764
|
```
|
|
758
765
|
|
|
759
766
|
</dd>
|
|
@@ -769,7 +776,7 @@ await client.graph.addBatch({
|
|
|
769
776
|
<dl>
|
|
770
777
|
<dd>
|
|
771
778
|
|
|
772
|
-
**
|
|
779
|
+
**templateId:** `string` — Template ID
|
|
773
780
|
|
|
774
781
|
</dd>
|
|
775
782
|
</dl>
|
|
@@ -777,7 +784,7 @@ await client.graph.addBatch({
|
|
|
777
784
|
<dl>
|
|
778
785
|
<dd>
|
|
779
786
|
|
|
780
|
-
**requestOptions:** `
|
|
787
|
+
**requestOptions:** `Context.RequestOptions`
|
|
781
788
|
|
|
782
789
|
</dd>
|
|
783
790
|
</dl>
|
|
@@ -788,7 +795,9 @@ await client.graph.addBatch({
|
|
|
788
795
|
</dl>
|
|
789
796
|
</details>
|
|
790
797
|
|
|
791
|
-
|
|
798
|
+
## Graph
|
|
799
|
+
|
|
800
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">listCustomInstructions</a>({ ...params }) -> Zep.ListCustomInstructionsResponse</code></summary>
|
|
792
801
|
<dl>
|
|
793
802
|
<dd>
|
|
794
803
|
|
|
@@ -800,7 +809,7 @@ await client.graph.addBatch({
|
|
|
800
809
|
<dl>
|
|
801
810
|
<dd>
|
|
802
811
|
|
|
803
|
-
|
|
812
|
+
Lists all custom instructions for a project, user, or graph.
|
|
804
813
|
|
|
805
814
|
</dd>
|
|
806
815
|
</dl>
|
|
@@ -816,9 +825,9 @@ Add a fact triple for a user or group
|
|
|
816
825
|
<dd>
|
|
817
826
|
|
|
818
827
|
```typescript
|
|
819
|
-
await client.graph.
|
|
820
|
-
|
|
821
|
-
|
|
828
|
+
await client.graph.listCustomInstructions({
|
|
829
|
+
userId: "user_id",
|
|
830
|
+
graphId: "graph_id",
|
|
822
831
|
});
|
|
823
832
|
```
|
|
824
833
|
|
|
@@ -835,7 +844,7 @@ await client.graph.addFactTriple({
|
|
|
835
844
|
<dl>
|
|
836
845
|
<dd>
|
|
837
846
|
|
|
838
|
-
**request:** `Zep.
|
|
847
|
+
**request:** `Zep.GraphListCustomInstructionsRequest`
|
|
839
848
|
|
|
840
849
|
</dd>
|
|
841
850
|
</dl>
|
|
@@ -854,7 +863,7 @@ await client.graph.addFactTriple({
|
|
|
854
863
|
</dl>
|
|
855
864
|
</details>
|
|
856
865
|
|
|
857
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">
|
|
866
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">addCustomInstructions</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
|
|
858
867
|
<dl>
|
|
859
868
|
<dd>
|
|
860
869
|
|
|
@@ -866,7 +875,7 @@ await client.graph.addFactTriple({
|
|
|
866
875
|
<dl>
|
|
867
876
|
<dd>
|
|
868
877
|
|
|
869
|
-
|
|
878
|
+
Adds new custom instructions for graphs without removing existing ones. If user_ids or graph_ids is empty, adds to project-wide default instructions.
|
|
870
879
|
|
|
871
880
|
</dd>
|
|
872
881
|
</dl>
|
|
@@ -882,7 +891,14 @@ Clone a user or group graph.
|
|
|
882
891
|
<dd>
|
|
883
892
|
|
|
884
893
|
```typescript
|
|
885
|
-
await client.graph.
|
|
894
|
+
await client.graph.addCustomInstructions({
|
|
895
|
+
instructions: [
|
|
896
|
+
{
|
|
897
|
+
name: "name",
|
|
898
|
+
text: "text",
|
|
899
|
+
},
|
|
900
|
+
],
|
|
901
|
+
});
|
|
886
902
|
```
|
|
887
903
|
|
|
888
904
|
</dd>
|
|
@@ -898,7 +914,7 @@ await client.graph.clone();
|
|
|
898
914
|
<dl>
|
|
899
915
|
<dd>
|
|
900
916
|
|
|
901
|
-
**request:** `Zep.
|
|
917
|
+
**request:** `Zep.AddCustomInstructionsRequest`
|
|
902
918
|
|
|
903
919
|
</dd>
|
|
904
920
|
</dl>
|
|
@@ -917,7 +933,7 @@ await client.graph.clone();
|
|
|
917
933
|
</dl>
|
|
918
934
|
</details>
|
|
919
935
|
|
|
920
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">
|
|
936
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">deleteCustomInstructions</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
|
|
921
937
|
<dl>
|
|
922
938
|
<dd>
|
|
923
939
|
|
|
@@ -929,7 +945,7 @@ await client.graph.clone();
|
|
|
929
945
|
<dl>
|
|
930
946
|
<dd>
|
|
931
947
|
|
|
932
|
-
|
|
948
|
+
Deletes custom instructions for graphs or project wide defaults.
|
|
933
949
|
|
|
934
950
|
</dd>
|
|
935
951
|
</dl>
|
|
@@ -945,9 +961,7 @@ Creates a new graph.
|
|
|
945
961
|
<dd>
|
|
946
962
|
|
|
947
963
|
```typescript
|
|
948
|
-
await client.graph.
|
|
949
|
-
graphId: "graph_id",
|
|
950
|
-
});
|
|
964
|
+
await client.graph.deleteCustomInstructions();
|
|
951
965
|
```
|
|
952
966
|
|
|
953
967
|
</dd>
|
|
@@ -963,7 +977,7 @@ await client.graph.create({
|
|
|
963
977
|
<dl>
|
|
964
978
|
<dd>
|
|
965
979
|
|
|
966
|
-
**request:** `Zep.
|
|
980
|
+
**request:** `Zep.DeleteCustomInstructionsRequest`
|
|
967
981
|
|
|
968
982
|
</dd>
|
|
969
983
|
</dl>
|
|
@@ -982,7 +996,7 @@ await client.graph.create({
|
|
|
982
996
|
</dl>
|
|
983
997
|
</details>
|
|
984
998
|
|
|
985
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">
|
|
999
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">listEntityTypes</a>({ ...params }) -> Zep.EntityTypeResponse</code></summary>
|
|
986
1000
|
<dl>
|
|
987
1001
|
<dd>
|
|
988
1002
|
|
|
@@ -994,7 +1008,7 @@ await client.graph.create({
|
|
|
994
1008
|
<dl>
|
|
995
1009
|
<dd>
|
|
996
1010
|
|
|
997
|
-
Returns all
|
|
1011
|
+
Returns all entity types for a project, user, or graph.
|
|
998
1012
|
|
|
999
1013
|
</dd>
|
|
1000
1014
|
</dl>
|
|
@@ -1010,11 +1024,9 @@ Returns all graphs. In order to list users, use user.list_ordered instead
|
|
|
1010
1024
|
<dd>
|
|
1011
1025
|
|
|
1012
1026
|
```typescript
|
|
1013
|
-
await client.graph.
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
orderBy: "order_by",
|
|
1017
|
-
asc: true,
|
|
1027
|
+
await client.graph.listEntityTypes({
|
|
1028
|
+
userId: "user_id",
|
|
1029
|
+
graphId: "graph_id",
|
|
1018
1030
|
});
|
|
1019
1031
|
```
|
|
1020
1032
|
|
|
@@ -1031,7 +1043,7 @@ await client.graph.listAll({
|
|
|
1031
1043
|
<dl>
|
|
1032
1044
|
<dd>
|
|
1033
1045
|
|
|
1034
|
-
**request:** `Zep.
|
|
1046
|
+
**request:** `Zep.GraphListEntityTypesRequest`
|
|
1035
1047
|
|
|
1036
1048
|
</dd>
|
|
1037
1049
|
</dl>
|
|
@@ -1050,7 +1062,7 @@ await client.graph.listAll({
|
|
|
1050
1062
|
</dl>
|
|
1051
1063
|
</details>
|
|
1052
1064
|
|
|
1053
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">
|
|
1065
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">setEntityTypesInternal</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
|
|
1054
1066
|
<dl>
|
|
1055
1067
|
<dd>
|
|
1056
1068
|
|
|
@@ -1062,8 +1074,7 @@ await client.graph.listAll({
|
|
|
1062
1074
|
<dl>
|
|
1063
1075
|
<dd>
|
|
1064
1076
|
|
|
1065
|
-
|
|
1066
|
-
multi-hop paths, co-occurrences, hubs, and clusters.
|
|
1077
|
+
Sets the entity types for multiple users and graphs, replacing any existing ones.
|
|
1067
1078
|
|
|
1068
1079
|
</dd>
|
|
1069
1080
|
</dl>
|
|
@@ -1079,7 +1090,7 @@ multi-hop paths, co-occurrences, hubs, and clusters.
|
|
|
1079
1090
|
<dd>
|
|
1080
1091
|
|
|
1081
1092
|
```typescript
|
|
1082
|
-
await client.graph.
|
|
1093
|
+
await client.graph.setEntityTypesInternal();
|
|
1083
1094
|
```
|
|
1084
1095
|
|
|
1085
1096
|
</dd>
|
|
@@ -1095,7 +1106,7 @@ await client.graph.detectPatterns();
|
|
|
1095
1106
|
<dl>
|
|
1096
1107
|
<dd>
|
|
1097
1108
|
|
|
1098
|
-
**request:** `Zep.
|
|
1109
|
+
**request:** `Zep.EntityTypeRequest`
|
|
1099
1110
|
|
|
1100
1111
|
</dd>
|
|
1101
1112
|
</dl>
|
|
@@ -1114,7 +1125,7 @@ await client.graph.detectPatterns();
|
|
|
1114
1125
|
</dl>
|
|
1115
1126
|
</details>
|
|
1116
1127
|
|
|
1117
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">
|
|
1128
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">add</a>({ ...params }) -> Zep.Episode</code></summary>
|
|
1118
1129
|
<dl>
|
|
1119
1130
|
<dd>
|
|
1120
1131
|
|
|
@@ -1126,7 +1137,7 @@ await client.graph.detectPatterns();
|
|
|
1126
1137
|
<dl>
|
|
1127
1138
|
<dd>
|
|
1128
1139
|
|
|
1129
|
-
|
|
1140
|
+
Add data to the graph.
|
|
1130
1141
|
|
|
1131
1142
|
</dd>
|
|
1132
1143
|
</dl>
|
|
@@ -1142,8 +1153,9 @@ Perform a graph search query.
|
|
|
1142
1153
|
<dd>
|
|
1143
1154
|
|
|
1144
1155
|
```typescript
|
|
1145
|
-
await client.graph.
|
|
1146
|
-
|
|
1156
|
+
await client.graph.add({
|
|
1157
|
+
data: "data",
|
|
1158
|
+
type: "text",
|
|
1147
1159
|
});
|
|
1148
1160
|
```
|
|
1149
1161
|
|
|
@@ -1160,7 +1172,7 @@ await client.graph.search({
|
|
|
1160
1172
|
<dl>
|
|
1161
1173
|
<dd>
|
|
1162
1174
|
|
|
1163
|
-
**request:** `Zep.
|
|
1175
|
+
**request:** `Zep.AddDataRequest`
|
|
1164
1176
|
|
|
1165
1177
|
</dd>
|
|
1166
1178
|
</dl>
|
|
@@ -1179,7 +1191,7 @@ await client.graph.search({
|
|
|
1179
1191
|
</dl>
|
|
1180
1192
|
</details>
|
|
1181
1193
|
|
|
1182
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">
|
|
1194
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">addBatch</a>({ ...params }) -> Zep.Episode[]</code></summary>
|
|
1183
1195
|
<dl>
|
|
1184
1196
|
<dd>
|
|
1185
1197
|
|
|
@@ -1191,7 +1203,7 @@ await client.graph.search({
|
|
|
1191
1203
|
<dl>
|
|
1192
1204
|
<dd>
|
|
1193
1205
|
|
|
1194
|
-
|
|
1206
|
+
Add data to the graph in batch mode. Episodes are processed sequentially in the order provided.
|
|
1195
1207
|
|
|
1196
1208
|
</dd>
|
|
1197
1209
|
</dl>
|
|
@@ -1207,7 +1219,14 @@ Returns a graph.
|
|
|
1207
1219
|
<dd>
|
|
1208
1220
|
|
|
1209
1221
|
```typescript
|
|
1210
|
-
await client.graph.
|
|
1222
|
+
await client.graph.addBatch({
|
|
1223
|
+
episodes: [
|
|
1224
|
+
{
|
|
1225
|
+
data: "data",
|
|
1226
|
+
type: "text",
|
|
1227
|
+
},
|
|
1228
|
+
],
|
|
1229
|
+
});
|
|
1211
1230
|
```
|
|
1212
1231
|
|
|
1213
1232
|
</dd>
|
|
@@ -1223,7 +1242,7 @@ await client.graph.get("graphId");
|
|
|
1223
1242
|
<dl>
|
|
1224
1243
|
<dd>
|
|
1225
1244
|
|
|
1226
|
-
**
|
|
1245
|
+
**request:** `Zep.AddDataBatchRequest`
|
|
1227
1246
|
|
|
1228
1247
|
</dd>
|
|
1229
1248
|
</dl>
|
|
@@ -1242,7 +1261,7 @@ await client.graph.get("graphId");
|
|
|
1242
1261
|
</dl>
|
|
1243
1262
|
</details>
|
|
1244
1263
|
|
|
1245
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">
|
|
1264
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">addFactTriple</a>({ ...params }) -> Zep.AddTripleResponse</code></summary>
|
|
1246
1265
|
<dl>
|
|
1247
1266
|
<dd>
|
|
1248
1267
|
|
|
@@ -1254,7 +1273,7 @@ await client.graph.get("graphId");
|
|
|
1254
1273
|
<dl>
|
|
1255
1274
|
<dd>
|
|
1256
1275
|
|
|
1257
|
-
|
|
1276
|
+
Add a fact triple for a user or group
|
|
1258
1277
|
|
|
1259
1278
|
</dd>
|
|
1260
1279
|
</dl>
|
|
@@ -1270,7 +1289,10 @@ Deletes a graph. If you would like to delete a user graph, make sure to use user
|
|
|
1270
1289
|
<dd>
|
|
1271
1290
|
|
|
1272
1291
|
```typescript
|
|
1273
|
-
await client.graph.
|
|
1292
|
+
await client.graph.addFactTriple({
|
|
1293
|
+
fact: "fact",
|
|
1294
|
+
factName: "fact_name",
|
|
1295
|
+
});
|
|
1274
1296
|
```
|
|
1275
1297
|
|
|
1276
1298
|
</dd>
|
|
@@ -1286,7 +1308,7 @@ await client.graph.delete("graphId");
|
|
|
1286
1308
|
<dl>
|
|
1287
1309
|
<dd>
|
|
1288
1310
|
|
|
1289
|
-
**
|
|
1311
|
+
**request:** `Zep.AddTripleRequest`
|
|
1290
1312
|
|
|
1291
1313
|
</dd>
|
|
1292
1314
|
</dl>
|
|
@@ -1305,7 +1327,7 @@ await client.graph.delete("graphId");
|
|
|
1305
1327
|
</dl>
|
|
1306
1328
|
</details>
|
|
1307
1329
|
|
|
1308
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">
|
|
1330
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">clone</a>({ ...params }) -> Zep.CloneGraphResponse</code></summary>
|
|
1309
1331
|
<dl>
|
|
1310
1332
|
<dd>
|
|
1311
1333
|
|
|
@@ -1317,7 +1339,7 @@ await client.graph.delete("graphId");
|
|
|
1317
1339
|
<dl>
|
|
1318
1340
|
<dd>
|
|
1319
1341
|
|
|
1320
|
-
|
|
1342
|
+
Clone a user or group graph.
|
|
1321
1343
|
|
|
1322
1344
|
</dd>
|
|
1323
1345
|
</dl>
|
|
@@ -1333,7 +1355,7 @@ Updates information about a graph.
|
|
|
1333
1355
|
<dd>
|
|
1334
1356
|
|
|
1335
1357
|
```typescript
|
|
1336
|
-
await client.graph.
|
|
1358
|
+
await client.graph.clone();
|
|
1337
1359
|
```
|
|
1338
1360
|
|
|
1339
1361
|
</dd>
|
|
@@ -1349,7 +1371,7 @@ await client.graph.update("graphId");
|
|
|
1349
1371
|
<dl>
|
|
1350
1372
|
<dd>
|
|
1351
1373
|
|
|
1352
|
-
**
|
|
1374
|
+
**request:** `Zep.CloneGraphRequest`
|
|
1353
1375
|
|
|
1354
1376
|
</dd>
|
|
1355
1377
|
</dl>
|
|
@@ -1357,7 +1379,64 @@ await client.graph.update("graphId");
|
|
|
1357
1379
|
<dl>
|
|
1358
1380
|
<dd>
|
|
1359
1381
|
|
|
1360
|
-
**
|
|
1382
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1383
|
+
|
|
1384
|
+
</dd>
|
|
1385
|
+
</dl>
|
|
1386
|
+
</dd>
|
|
1387
|
+
</dl>
|
|
1388
|
+
|
|
1389
|
+
</dd>
|
|
1390
|
+
</dl>
|
|
1391
|
+
</details>
|
|
1392
|
+
|
|
1393
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">create</a>({ ...params }) -> Zep.Graph</code></summary>
|
|
1394
|
+
<dl>
|
|
1395
|
+
<dd>
|
|
1396
|
+
|
|
1397
|
+
#### 📝 Description
|
|
1398
|
+
|
|
1399
|
+
<dl>
|
|
1400
|
+
<dd>
|
|
1401
|
+
|
|
1402
|
+
<dl>
|
|
1403
|
+
<dd>
|
|
1404
|
+
|
|
1405
|
+
Creates a new graph.
|
|
1406
|
+
|
|
1407
|
+
</dd>
|
|
1408
|
+
</dl>
|
|
1409
|
+
</dd>
|
|
1410
|
+
</dl>
|
|
1411
|
+
|
|
1412
|
+
#### 🔌 Usage
|
|
1413
|
+
|
|
1414
|
+
<dl>
|
|
1415
|
+
<dd>
|
|
1416
|
+
|
|
1417
|
+
<dl>
|
|
1418
|
+
<dd>
|
|
1419
|
+
|
|
1420
|
+
```typescript
|
|
1421
|
+
await client.graph.create({
|
|
1422
|
+
graphId: "graph_id",
|
|
1423
|
+
});
|
|
1424
|
+
```
|
|
1425
|
+
|
|
1426
|
+
</dd>
|
|
1427
|
+
</dl>
|
|
1428
|
+
</dd>
|
|
1429
|
+
</dl>
|
|
1430
|
+
|
|
1431
|
+
#### ⚙️ Parameters
|
|
1432
|
+
|
|
1433
|
+
<dl>
|
|
1434
|
+
<dd>
|
|
1435
|
+
|
|
1436
|
+
<dl>
|
|
1437
|
+
<dd>
|
|
1438
|
+
|
|
1439
|
+
**request:** `Zep.CreateGraphRequest`
|
|
1361
1440
|
|
|
1362
1441
|
</dd>
|
|
1363
1442
|
</dl>
|
|
@@ -1376,9 +1455,7 @@ await client.graph.update("graphId");
|
|
|
1376
1455
|
</dl>
|
|
1377
1456
|
</details>
|
|
1378
1457
|
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
<details><summary><code>client.project.<a href="/src/api/resources/project/client/Client.ts">get</a>() -> Zep.ProjectInfoResponse</code></summary>
|
|
1458
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">listAll</a>({ ...params }) -> Zep.GraphListResponse</code></summary>
|
|
1382
1459
|
<dl>
|
|
1383
1460
|
<dd>
|
|
1384
1461
|
|
|
@@ -1390,7 +1467,7 @@ await client.graph.update("graphId");
|
|
|
1390
1467
|
<dl>
|
|
1391
1468
|
<dd>
|
|
1392
1469
|
|
|
1393
|
-
|
|
1470
|
+
Returns all graphs. In order to list users, use user.list_ordered instead
|
|
1394
1471
|
|
|
1395
1472
|
</dd>
|
|
1396
1473
|
</dl>
|
|
@@ -1406,7 +1483,13 @@ Retrieve project info based on the provided api key.
|
|
|
1406
1483
|
<dd>
|
|
1407
1484
|
|
|
1408
1485
|
```typescript
|
|
1409
|
-
await client.
|
|
1486
|
+
await client.graph.listAll({
|
|
1487
|
+
pageNumber: 1,
|
|
1488
|
+
pageSize: 1,
|
|
1489
|
+
search: "search",
|
|
1490
|
+
orderBy: "order_by",
|
|
1491
|
+
asc: true,
|
|
1492
|
+
});
|
|
1410
1493
|
```
|
|
1411
1494
|
|
|
1412
1495
|
</dd>
|
|
@@ -1422,7 +1505,15 @@ await client.project.get();
|
|
|
1422
1505
|
<dl>
|
|
1423
1506
|
<dd>
|
|
1424
1507
|
|
|
1425
|
-
**
|
|
1508
|
+
**request:** `Zep.GraphListAllRequest`
|
|
1509
|
+
|
|
1510
|
+
</dd>
|
|
1511
|
+
</dl>
|
|
1512
|
+
|
|
1513
|
+
<dl>
|
|
1514
|
+
<dd>
|
|
1515
|
+
|
|
1516
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1426
1517
|
|
|
1427
1518
|
</dd>
|
|
1428
1519
|
</dl>
|
|
@@ -1433,9 +1524,7 @@ await client.project.get();
|
|
|
1433
1524
|
</dl>
|
|
1434
1525
|
</details>
|
|
1435
1526
|
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
<details><summary><code>client.task.<a href="/src/api/resources/task/client/Client.ts">get</a>(taskId) -> Zep.GetTaskResponse</code></summary>
|
|
1527
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">detectPatterns</a>({ ...params }) -> Zep.DetectPatternsResponse</code></summary>
|
|
1439
1528
|
<dl>
|
|
1440
1529
|
<dd>
|
|
1441
1530
|
|
|
@@ -1447,7 +1536,10 @@ await client.project.get();
|
|
|
1447
1536
|
<dl>
|
|
1448
1537
|
<dd>
|
|
1449
1538
|
|
|
1450
|
-
|
|
1539
|
+
Detects structural patterns in a knowledge graph including relationship frequencies,
|
|
1540
|
+
multi-hop paths, co-occurrences, hubs, and clusters.
|
|
1541
|
+
When a query is provided, uses hybrid search to discover seed nodes,
|
|
1542
|
+
detects triple-frequency patterns, and returns resolved edges ranked by relevance.
|
|
1451
1543
|
|
|
1452
1544
|
</dd>
|
|
1453
1545
|
</dl>
|
|
@@ -1463,7 +1555,7 @@ Gets a task by its ID
|
|
|
1463
1555
|
<dd>
|
|
1464
1556
|
|
|
1465
1557
|
```typescript
|
|
1466
|
-
await client.
|
|
1558
|
+
await client.graph.detectPatterns();
|
|
1467
1559
|
```
|
|
1468
1560
|
|
|
1469
1561
|
</dd>
|
|
@@ -1479,7 +1571,7 @@ await client.task.get("task_id");
|
|
|
1479
1571
|
<dl>
|
|
1480
1572
|
<dd>
|
|
1481
1573
|
|
|
1482
|
-
**
|
|
1574
|
+
**request:** `Zep.DetectPatternsRequest`
|
|
1483
1575
|
|
|
1484
1576
|
</dd>
|
|
1485
1577
|
</dl>
|
|
@@ -1487,7 +1579,7 @@ await client.task.get("task_id");
|
|
|
1487
1579
|
<dl>
|
|
1488
1580
|
<dd>
|
|
1489
1581
|
|
|
1490
|
-
**requestOptions:** `
|
|
1582
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1491
1583
|
|
|
1492
1584
|
</dd>
|
|
1493
1585
|
</dl>
|
|
@@ -1498,9 +1590,7 @@ await client.task.get("task_id");
|
|
|
1498
1590
|
</dl>
|
|
1499
1591
|
</details>
|
|
1500
1592
|
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">listAll</a>({ ...params }) -> Zep.ThreadListResponse</code></summary>
|
|
1593
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">search</a>({ ...params }) -> Zep.GraphSearchResults</code></summary>
|
|
1504
1594
|
<dl>
|
|
1505
1595
|
<dd>
|
|
1506
1596
|
|
|
@@ -1512,7 +1602,7 @@ await client.task.get("task_id");
|
|
|
1512
1602
|
<dl>
|
|
1513
1603
|
<dd>
|
|
1514
1604
|
|
|
1515
|
-
|
|
1605
|
+
Perform a graph search query.
|
|
1516
1606
|
|
|
1517
1607
|
</dd>
|
|
1518
1608
|
</dl>
|
|
@@ -1528,11 +1618,8 @@ Returns all threads.
|
|
|
1528
1618
|
<dd>
|
|
1529
1619
|
|
|
1530
1620
|
```typescript
|
|
1531
|
-
await client.
|
|
1532
|
-
|
|
1533
|
-
pageSize: 1,
|
|
1534
|
-
orderBy: "order_by",
|
|
1535
|
-
asc: true,
|
|
1621
|
+
await client.graph.search({
|
|
1622
|
+
query: "query",
|
|
1536
1623
|
});
|
|
1537
1624
|
```
|
|
1538
1625
|
|
|
@@ -1549,7 +1636,7 @@ await client.thread.listAll({
|
|
|
1549
1636
|
<dl>
|
|
1550
1637
|
<dd>
|
|
1551
1638
|
|
|
1552
|
-
**request:** `Zep.
|
|
1639
|
+
**request:** `Zep.GraphSearchQuery`
|
|
1553
1640
|
|
|
1554
1641
|
</dd>
|
|
1555
1642
|
</dl>
|
|
@@ -1557,7 +1644,70 @@ await client.thread.listAll({
|
|
|
1557
1644
|
<dl>
|
|
1558
1645
|
<dd>
|
|
1559
1646
|
|
|
1560
|
-
**requestOptions:** `
|
|
1647
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1648
|
+
|
|
1649
|
+
</dd>
|
|
1650
|
+
</dl>
|
|
1651
|
+
</dd>
|
|
1652
|
+
</dl>
|
|
1653
|
+
|
|
1654
|
+
</dd>
|
|
1655
|
+
</dl>
|
|
1656
|
+
</details>
|
|
1657
|
+
|
|
1658
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">get</a>(graphId) -> Zep.Graph</code></summary>
|
|
1659
|
+
<dl>
|
|
1660
|
+
<dd>
|
|
1661
|
+
|
|
1662
|
+
#### 📝 Description
|
|
1663
|
+
|
|
1664
|
+
<dl>
|
|
1665
|
+
<dd>
|
|
1666
|
+
|
|
1667
|
+
<dl>
|
|
1668
|
+
<dd>
|
|
1669
|
+
|
|
1670
|
+
Returns a graph.
|
|
1671
|
+
|
|
1672
|
+
</dd>
|
|
1673
|
+
</dl>
|
|
1674
|
+
</dd>
|
|
1675
|
+
</dl>
|
|
1676
|
+
|
|
1677
|
+
#### 🔌 Usage
|
|
1678
|
+
|
|
1679
|
+
<dl>
|
|
1680
|
+
<dd>
|
|
1681
|
+
|
|
1682
|
+
<dl>
|
|
1683
|
+
<dd>
|
|
1684
|
+
|
|
1685
|
+
```typescript
|
|
1686
|
+
await client.graph.get("graphId");
|
|
1687
|
+
```
|
|
1688
|
+
|
|
1689
|
+
</dd>
|
|
1690
|
+
</dl>
|
|
1691
|
+
</dd>
|
|
1692
|
+
</dl>
|
|
1693
|
+
|
|
1694
|
+
#### ⚙️ Parameters
|
|
1695
|
+
|
|
1696
|
+
<dl>
|
|
1697
|
+
<dd>
|
|
1698
|
+
|
|
1699
|
+
<dl>
|
|
1700
|
+
<dd>
|
|
1701
|
+
|
|
1702
|
+
**graphId:** `string` — The graph_id of the graph to get.
|
|
1703
|
+
|
|
1704
|
+
</dd>
|
|
1705
|
+
</dl>
|
|
1706
|
+
|
|
1707
|
+
<dl>
|
|
1708
|
+
<dd>
|
|
1709
|
+
|
|
1710
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1561
1711
|
|
|
1562
1712
|
</dd>
|
|
1563
1713
|
</dl>
|
|
@@ -1568,7 +1718,831 @@ await client.thread.listAll({
|
|
|
1568
1718
|
</dl>
|
|
1569
1719
|
</details>
|
|
1570
1720
|
|
|
1571
|
-
<details><summary><code>client.
|
|
1721
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">delete</a>(graphId) -> Zep.SuccessResponse</code></summary>
|
|
1722
|
+
<dl>
|
|
1723
|
+
<dd>
|
|
1724
|
+
|
|
1725
|
+
#### 📝 Description
|
|
1726
|
+
|
|
1727
|
+
<dl>
|
|
1728
|
+
<dd>
|
|
1729
|
+
|
|
1730
|
+
<dl>
|
|
1731
|
+
<dd>
|
|
1732
|
+
|
|
1733
|
+
Deletes a graph. If you would like to delete a user graph, make sure to use user.delete instead.
|
|
1734
|
+
|
|
1735
|
+
</dd>
|
|
1736
|
+
</dl>
|
|
1737
|
+
</dd>
|
|
1738
|
+
</dl>
|
|
1739
|
+
|
|
1740
|
+
#### 🔌 Usage
|
|
1741
|
+
|
|
1742
|
+
<dl>
|
|
1743
|
+
<dd>
|
|
1744
|
+
|
|
1745
|
+
<dl>
|
|
1746
|
+
<dd>
|
|
1747
|
+
|
|
1748
|
+
```typescript
|
|
1749
|
+
await client.graph.delete("graphId");
|
|
1750
|
+
```
|
|
1751
|
+
|
|
1752
|
+
</dd>
|
|
1753
|
+
</dl>
|
|
1754
|
+
</dd>
|
|
1755
|
+
</dl>
|
|
1756
|
+
|
|
1757
|
+
#### ⚙️ Parameters
|
|
1758
|
+
|
|
1759
|
+
<dl>
|
|
1760
|
+
<dd>
|
|
1761
|
+
|
|
1762
|
+
<dl>
|
|
1763
|
+
<dd>
|
|
1764
|
+
|
|
1765
|
+
**graphId:** `string` — Graph ID
|
|
1766
|
+
|
|
1767
|
+
</dd>
|
|
1768
|
+
</dl>
|
|
1769
|
+
|
|
1770
|
+
<dl>
|
|
1771
|
+
<dd>
|
|
1772
|
+
|
|
1773
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1774
|
+
|
|
1775
|
+
</dd>
|
|
1776
|
+
</dl>
|
|
1777
|
+
</dd>
|
|
1778
|
+
</dl>
|
|
1779
|
+
|
|
1780
|
+
</dd>
|
|
1781
|
+
</dl>
|
|
1782
|
+
</details>
|
|
1783
|
+
|
|
1784
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">update</a>(graphId, { ...params }) -> Zep.Graph</code></summary>
|
|
1785
|
+
<dl>
|
|
1786
|
+
<dd>
|
|
1787
|
+
|
|
1788
|
+
#### 📝 Description
|
|
1789
|
+
|
|
1790
|
+
<dl>
|
|
1791
|
+
<dd>
|
|
1792
|
+
|
|
1793
|
+
<dl>
|
|
1794
|
+
<dd>
|
|
1795
|
+
|
|
1796
|
+
Updates information about a graph.
|
|
1797
|
+
|
|
1798
|
+
</dd>
|
|
1799
|
+
</dl>
|
|
1800
|
+
</dd>
|
|
1801
|
+
</dl>
|
|
1802
|
+
|
|
1803
|
+
#### 🔌 Usage
|
|
1804
|
+
|
|
1805
|
+
<dl>
|
|
1806
|
+
<dd>
|
|
1807
|
+
|
|
1808
|
+
<dl>
|
|
1809
|
+
<dd>
|
|
1810
|
+
|
|
1811
|
+
```typescript
|
|
1812
|
+
await client.graph.update("graphId");
|
|
1813
|
+
```
|
|
1814
|
+
|
|
1815
|
+
</dd>
|
|
1816
|
+
</dl>
|
|
1817
|
+
</dd>
|
|
1818
|
+
</dl>
|
|
1819
|
+
|
|
1820
|
+
#### ⚙️ Parameters
|
|
1821
|
+
|
|
1822
|
+
<dl>
|
|
1823
|
+
<dd>
|
|
1824
|
+
|
|
1825
|
+
<dl>
|
|
1826
|
+
<dd>
|
|
1827
|
+
|
|
1828
|
+
**graphId:** `string` — Graph ID
|
|
1829
|
+
|
|
1830
|
+
</dd>
|
|
1831
|
+
</dl>
|
|
1832
|
+
|
|
1833
|
+
<dl>
|
|
1834
|
+
<dd>
|
|
1835
|
+
|
|
1836
|
+
**request:** `Zep.UpdateGraphRequest`
|
|
1837
|
+
|
|
1838
|
+
</dd>
|
|
1839
|
+
</dl>
|
|
1840
|
+
|
|
1841
|
+
<dl>
|
|
1842
|
+
<dd>
|
|
1843
|
+
|
|
1844
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1845
|
+
|
|
1846
|
+
</dd>
|
|
1847
|
+
</dl>
|
|
1848
|
+
</dd>
|
|
1849
|
+
</dl>
|
|
1850
|
+
|
|
1851
|
+
</dd>
|
|
1852
|
+
</dl>
|
|
1853
|
+
</details>
|
|
1854
|
+
|
|
1855
|
+
## Project
|
|
1856
|
+
|
|
1857
|
+
<details><summary><code>client.project.<a href="/src/api/resources/project/client/Client.ts">get</a>() -> Zep.ProjectInfoResponse</code></summary>
|
|
1858
|
+
<dl>
|
|
1859
|
+
<dd>
|
|
1860
|
+
|
|
1861
|
+
#### 📝 Description
|
|
1862
|
+
|
|
1863
|
+
<dl>
|
|
1864
|
+
<dd>
|
|
1865
|
+
|
|
1866
|
+
<dl>
|
|
1867
|
+
<dd>
|
|
1868
|
+
|
|
1869
|
+
Retrieve project info based on the provided api key.
|
|
1870
|
+
|
|
1871
|
+
</dd>
|
|
1872
|
+
</dl>
|
|
1873
|
+
</dd>
|
|
1874
|
+
</dl>
|
|
1875
|
+
|
|
1876
|
+
#### 🔌 Usage
|
|
1877
|
+
|
|
1878
|
+
<dl>
|
|
1879
|
+
<dd>
|
|
1880
|
+
|
|
1881
|
+
<dl>
|
|
1882
|
+
<dd>
|
|
1883
|
+
|
|
1884
|
+
```typescript
|
|
1885
|
+
await client.project.get();
|
|
1886
|
+
```
|
|
1887
|
+
|
|
1888
|
+
</dd>
|
|
1889
|
+
</dl>
|
|
1890
|
+
</dd>
|
|
1891
|
+
</dl>
|
|
1892
|
+
|
|
1893
|
+
#### ⚙️ Parameters
|
|
1894
|
+
|
|
1895
|
+
<dl>
|
|
1896
|
+
<dd>
|
|
1897
|
+
|
|
1898
|
+
<dl>
|
|
1899
|
+
<dd>
|
|
1900
|
+
|
|
1901
|
+
**requestOptions:** `Project.RequestOptions`
|
|
1902
|
+
|
|
1903
|
+
</dd>
|
|
1904
|
+
</dl>
|
|
1905
|
+
</dd>
|
|
1906
|
+
</dl>
|
|
1907
|
+
|
|
1908
|
+
</dd>
|
|
1909
|
+
</dl>
|
|
1910
|
+
</details>
|
|
1911
|
+
|
|
1912
|
+
## Task
|
|
1913
|
+
|
|
1914
|
+
<details><summary><code>client.task.<a href="/src/api/resources/task/client/Client.ts">get</a>(taskId) -> Zep.GetTaskResponse</code></summary>
|
|
1915
|
+
<dl>
|
|
1916
|
+
<dd>
|
|
1917
|
+
|
|
1918
|
+
#### 📝 Description
|
|
1919
|
+
|
|
1920
|
+
<dl>
|
|
1921
|
+
<dd>
|
|
1922
|
+
|
|
1923
|
+
<dl>
|
|
1924
|
+
<dd>
|
|
1925
|
+
|
|
1926
|
+
Gets a task by its ID
|
|
1927
|
+
|
|
1928
|
+
</dd>
|
|
1929
|
+
</dl>
|
|
1930
|
+
</dd>
|
|
1931
|
+
</dl>
|
|
1932
|
+
|
|
1933
|
+
#### 🔌 Usage
|
|
1934
|
+
|
|
1935
|
+
<dl>
|
|
1936
|
+
<dd>
|
|
1937
|
+
|
|
1938
|
+
<dl>
|
|
1939
|
+
<dd>
|
|
1940
|
+
|
|
1941
|
+
```typescript
|
|
1942
|
+
await client.task.get("task_id");
|
|
1943
|
+
```
|
|
1944
|
+
|
|
1945
|
+
</dd>
|
|
1946
|
+
</dl>
|
|
1947
|
+
</dd>
|
|
1948
|
+
</dl>
|
|
1949
|
+
|
|
1950
|
+
#### ⚙️ Parameters
|
|
1951
|
+
|
|
1952
|
+
<dl>
|
|
1953
|
+
<dd>
|
|
1954
|
+
|
|
1955
|
+
<dl>
|
|
1956
|
+
<dd>
|
|
1957
|
+
|
|
1958
|
+
**taskId:** `string` — Task ID
|
|
1959
|
+
|
|
1960
|
+
</dd>
|
|
1961
|
+
</dl>
|
|
1962
|
+
|
|
1963
|
+
<dl>
|
|
1964
|
+
<dd>
|
|
1965
|
+
|
|
1966
|
+
**requestOptions:** `Task.RequestOptions`
|
|
1967
|
+
|
|
1968
|
+
</dd>
|
|
1969
|
+
</dl>
|
|
1970
|
+
</dd>
|
|
1971
|
+
</dl>
|
|
1972
|
+
|
|
1973
|
+
</dd>
|
|
1974
|
+
</dl>
|
|
1975
|
+
</details>
|
|
1976
|
+
|
|
1977
|
+
## Thread
|
|
1978
|
+
|
|
1979
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">listAll</a>({ ...params }) -> Zep.ThreadListResponse</code></summary>
|
|
1980
|
+
<dl>
|
|
1981
|
+
<dd>
|
|
1982
|
+
|
|
1983
|
+
#### 📝 Description
|
|
1984
|
+
|
|
1985
|
+
<dl>
|
|
1986
|
+
<dd>
|
|
1987
|
+
|
|
1988
|
+
<dl>
|
|
1989
|
+
<dd>
|
|
1990
|
+
|
|
1991
|
+
Returns all threads.
|
|
1992
|
+
|
|
1993
|
+
</dd>
|
|
1994
|
+
</dl>
|
|
1995
|
+
</dd>
|
|
1996
|
+
</dl>
|
|
1997
|
+
|
|
1998
|
+
#### 🔌 Usage
|
|
1999
|
+
|
|
2000
|
+
<dl>
|
|
2001
|
+
<dd>
|
|
2002
|
+
|
|
2003
|
+
<dl>
|
|
2004
|
+
<dd>
|
|
2005
|
+
|
|
2006
|
+
```typescript
|
|
2007
|
+
await client.thread.listAll({
|
|
2008
|
+
pageNumber: 1,
|
|
2009
|
+
pageSize: 1,
|
|
2010
|
+
orderBy: "order_by",
|
|
2011
|
+
asc: true,
|
|
2012
|
+
});
|
|
2013
|
+
```
|
|
2014
|
+
|
|
2015
|
+
</dd>
|
|
2016
|
+
</dl>
|
|
2017
|
+
</dd>
|
|
2018
|
+
</dl>
|
|
2019
|
+
|
|
2020
|
+
#### ⚙️ Parameters
|
|
2021
|
+
|
|
2022
|
+
<dl>
|
|
2023
|
+
<dd>
|
|
2024
|
+
|
|
2025
|
+
<dl>
|
|
2026
|
+
<dd>
|
|
2027
|
+
|
|
2028
|
+
**request:** `Zep.ThreadListAllRequest`
|
|
2029
|
+
|
|
2030
|
+
</dd>
|
|
2031
|
+
</dl>
|
|
2032
|
+
|
|
2033
|
+
<dl>
|
|
2034
|
+
<dd>
|
|
2035
|
+
|
|
2036
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2037
|
+
|
|
2038
|
+
</dd>
|
|
2039
|
+
</dl>
|
|
2040
|
+
</dd>
|
|
2041
|
+
</dl>
|
|
2042
|
+
|
|
2043
|
+
</dd>
|
|
2044
|
+
</dl>
|
|
2045
|
+
</details>
|
|
2046
|
+
|
|
2047
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">create</a>({ ...params }) -> Zep.Thread</code></summary>
|
|
2048
|
+
<dl>
|
|
2049
|
+
<dd>
|
|
2050
|
+
|
|
2051
|
+
#### 📝 Description
|
|
2052
|
+
|
|
2053
|
+
<dl>
|
|
2054
|
+
<dd>
|
|
2055
|
+
|
|
2056
|
+
<dl>
|
|
2057
|
+
<dd>
|
|
2058
|
+
|
|
2059
|
+
Start a new thread.
|
|
2060
|
+
|
|
2061
|
+
</dd>
|
|
2062
|
+
</dl>
|
|
2063
|
+
</dd>
|
|
2064
|
+
</dl>
|
|
2065
|
+
|
|
2066
|
+
#### 🔌 Usage
|
|
2067
|
+
|
|
2068
|
+
<dl>
|
|
2069
|
+
<dd>
|
|
2070
|
+
|
|
2071
|
+
<dl>
|
|
2072
|
+
<dd>
|
|
2073
|
+
|
|
2074
|
+
```typescript
|
|
2075
|
+
await client.thread.create({
|
|
2076
|
+
threadId: "thread_id",
|
|
2077
|
+
userId: "user_id",
|
|
2078
|
+
});
|
|
2079
|
+
```
|
|
2080
|
+
|
|
2081
|
+
</dd>
|
|
2082
|
+
</dl>
|
|
2083
|
+
</dd>
|
|
2084
|
+
</dl>
|
|
2085
|
+
|
|
2086
|
+
#### ⚙️ Parameters
|
|
2087
|
+
|
|
2088
|
+
<dl>
|
|
2089
|
+
<dd>
|
|
2090
|
+
|
|
2091
|
+
<dl>
|
|
2092
|
+
<dd>
|
|
2093
|
+
|
|
2094
|
+
**request:** `Zep.CreateThreadRequest`
|
|
2095
|
+
|
|
2096
|
+
</dd>
|
|
2097
|
+
</dl>
|
|
2098
|
+
|
|
2099
|
+
<dl>
|
|
2100
|
+
<dd>
|
|
2101
|
+
|
|
2102
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2103
|
+
|
|
2104
|
+
</dd>
|
|
2105
|
+
</dl>
|
|
2106
|
+
</dd>
|
|
2107
|
+
</dl>
|
|
2108
|
+
|
|
2109
|
+
</dd>
|
|
2110
|
+
</dl>
|
|
2111
|
+
</details>
|
|
2112
|
+
|
|
2113
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">delete</a>(threadId) -> Zep.SuccessResponse</code></summary>
|
|
2114
|
+
<dl>
|
|
2115
|
+
<dd>
|
|
2116
|
+
|
|
2117
|
+
#### 📝 Description
|
|
2118
|
+
|
|
2119
|
+
<dl>
|
|
2120
|
+
<dd>
|
|
2121
|
+
|
|
2122
|
+
<dl>
|
|
2123
|
+
<dd>
|
|
2124
|
+
|
|
2125
|
+
Deletes a thread.
|
|
2126
|
+
|
|
2127
|
+
</dd>
|
|
2128
|
+
</dl>
|
|
2129
|
+
</dd>
|
|
2130
|
+
</dl>
|
|
2131
|
+
|
|
2132
|
+
#### 🔌 Usage
|
|
2133
|
+
|
|
2134
|
+
<dl>
|
|
2135
|
+
<dd>
|
|
2136
|
+
|
|
2137
|
+
<dl>
|
|
2138
|
+
<dd>
|
|
2139
|
+
|
|
2140
|
+
```typescript
|
|
2141
|
+
await client.thread.delete("threadId");
|
|
2142
|
+
```
|
|
2143
|
+
|
|
2144
|
+
</dd>
|
|
2145
|
+
</dl>
|
|
2146
|
+
</dd>
|
|
2147
|
+
</dl>
|
|
2148
|
+
|
|
2149
|
+
#### ⚙️ Parameters
|
|
2150
|
+
|
|
2151
|
+
<dl>
|
|
2152
|
+
<dd>
|
|
2153
|
+
|
|
2154
|
+
<dl>
|
|
2155
|
+
<dd>
|
|
2156
|
+
|
|
2157
|
+
**threadId:** `string` — The ID of the thread for which memory should be deleted.
|
|
2158
|
+
|
|
2159
|
+
</dd>
|
|
2160
|
+
</dl>
|
|
2161
|
+
|
|
2162
|
+
<dl>
|
|
2163
|
+
<dd>
|
|
2164
|
+
|
|
2165
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2166
|
+
|
|
2167
|
+
</dd>
|
|
2168
|
+
</dl>
|
|
2169
|
+
</dd>
|
|
2170
|
+
</dl>
|
|
2171
|
+
|
|
2172
|
+
</dd>
|
|
2173
|
+
</dl>
|
|
2174
|
+
</details>
|
|
2175
|
+
|
|
2176
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">getUserContext</a>(threadId, { ...params }) -> Zep.ThreadContextResponse</code></summary>
|
|
2177
|
+
<dl>
|
|
2178
|
+
<dd>
|
|
2179
|
+
|
|
2180
|
+
#### 📝 Description
|
|
2181
|
+
|
|
2182
|
+
<dl>
|
|
2183
|
+
<dd>
|
|
2184
|
+
|
|
2185
|
+
<dl>
|
|
2186
|
+
<dd>
|
|
2187
|
+
|
|
2188
|
+
Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
|
|
2189
|
+
|
|
2190
|
+
</dd>
|
|
2191
|
+
</dl>
|
|
2192
|
+
</dd>
|
|
2193
|
+
</dl>
|
|
2194
|
+
|
|
2195
|
+
#### 🔌 Usage
|
|
2196
|
+
|
|
2197
|
+
<dl>
|
|
2198
|
+
<dd>
|
|
2199
|
+
|
|
2200
|
+
<dl>
|
|
2201
|
+
<dd>
|
|
2202
|
+
|
|
2203
|
+
```typescript
|
|
2204
|
+
await client.thread.getUserContext("threadId", {
|
|
2205
|
+
templateId: "template_id",
|
|
2206
|
+
});
|
|
2207
|
+
```
|
|
2208
|
+
|
|
2209
|
+
</dd>
|
|
2210
|
+
</dl>
|
|
2211
|
+
</dd>
|
|
2212
|
+
</dl>
|
|
2213
|
+
|
|
2214
|
+
#### ⚙️ Parameters
|
|
2215
|
+
|
|
2216
|
+
<dl>
|
|
2217
|
+
<dd>
|
|
2218
|
+
|
|
2219
|
+
<dl>
|
|
2220
|
+
<dd>
|
|
2221
|
+
|
|
2222
|
+
**threadId:** `string` — The ID of the current thread (for which context is being retrieved).
|
|
2223
|
+
|
|
2224
|
+
</dd>
|
|
2225
|
+
</dl>
|
|
2226
|
+
|
|
2227
|
+
<dl>
|
|
2228
|
+
<dd>
|
|
2229
|
+
|
|
2230
|
+
**request:** `Zep.ThreadGetUserContextRequest`
|
|
2231
|
+
|
|
2232
|
+
</dd>
|
|
2233
|
+
</dl>
|
|
2234
|
+
|
|
2235
|
+
<dl>
|
|
2236
|
+
<dd>
|
|
2237
|
+
|
|
2238
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2239
|
+
|
|
2240
|
+
</dd>
|
|
2241
|
+
</dl>
|
|
2242
|
+
</dd>
|
|
2243
|
+
</dl>
|
|
2244
|
+
|
|
2245
|
+
</dd>
|
|
2246
|
+
</dl>
|
|
2247
|
+
</details>
|
|
2248
|
+
|
|
2249
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">get</a>(threadId, { ...params }) -> Zep.MessageListResponse</code></summary>
|
|
2250
|
+
<dl>
|
|
2251
|
+
<dd>
|
|
2252
|
+
|
|
2253
|
+
#### 📝 Description
|
|
2254
|
+
|
|
2255
|
+
<dl>
|
|
2256
|
+
<dd>
|
|
2257
|
+
|
|
2258
|
+
<dl>
|
|
2259
|
+
<dd>
|
|
2260
|
+
|
|
2261
|
+
Returns messages for a thread.
|
|
2262
|
+
|
|
2263
|
+
</dd>
|
|
2264
|
+
</dl>
|
|
2265
|
+
</dd>
|
|
2266
|
+
</dl>
|
|
2267
|
+
|
|
2268
|
+
#### 🔌 Usage
|
|
2269
|
+
|
|
2270
|
+
<dl>
|
|
2271
|
+
<dd>
|
|
2272
|
+
|
|
2273
|
+
<dl>
|
|
2274
|
+
<dd>
|
|
2275
|
+
|
|
2276
|
+
```typescript
|
|
2277
|
+
await client.thread.get("threadId", {
|
|
2278
|
+
limit: 1,
|
|
2279
|
+
cursor: 1,
|
|
2280
|
+
lastn: 1,
|
|
2281
|
+
});
|
|
2282
|
+
```
|
|
2283
|
+
|
|
2284
|
+
</dd>
|
|
2285
|
+
</dl>
|
|
2286
|
+
</dd>
|
|
2287
|
+
</dl>
|
|
2288
|
+
|
|
2289
|
+
#### ⚙️ Parameters
|
|
2290
|
+
|
|
2291
|
+
<dl>
|
|
2292
|
+
<dd>
|
|
2293
|
+
|
|
2294
|
+
<dl>
|
|
2295
|
+
<dd>
|
|
2296
|
+
|
|
2297
|
+
**threadId:** `string` — Thread ID
|
|
2298
|
+
|
|
2299
|
+
</dd>
|
|
2300
|
+
</dl>
|
|
2301
|
+
|
|
2302
|
+
<dl>
|
|
2303
|
+
<dd>
|
|
2304
|
+
|
|
2305
|
+
**request:** `Zep.ThreadGetRequest`
|
|
2306
|
+
|
|
2307
|
+
</dd>
|
|
2308
|
+
</dl>
|
|
2309
|
+
|
|
2310
|
+
<dl>
|
|
2311
|
+
<dd>
|
|
2312
|
+
|
|
2313
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2314
|
+
|
|
2315
|
+
</dd>
|
|
2316
|
+
</dl>
|
|
2317
|
+
</dd>
|
|
2318
|
+
</dl>
|
|
2319
|
+
|
|
2320
|
+
</dd>
|
|
2321
|
+
</dl>
|
|
2322
|
+
</details>
|
|
2323
|
+
|
|
2324
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">addMessages</a>(threadId, { ...params }) -> Zep.AddThreadMessagesResponse</code></summary>
|
|
2325
|
+
<dl>
|
|
2326
|
+
<dd>
|
|
2327
|
+
|
|
2328
|
+
#### 📝 Description
|
|
2329
|
+
|
|
2330
|
+
<dl>
|
|
2331
|
+
<dd>
|
|
2332
|
+
|
|
2333
|
+
<dl>
|
|
2334
|
+
<dd>
|
|
2335
|
+
|
|
2336
|
+
Add messages to a thread.
|
|
2337
|
+
|
|
2338
|
+
</dd>
|
|
2339
|
+
</dl>
|
|
2340
|
+
</dd>
|
|
2341
|
+
</dl>
|
|
2342
|
+
|
|
2343
|
+
#### 🔌 Usage
|
|
2344
|
+
|
|
2345
|
+
<dl>
|
|
2346
|
+
<dd>
|
|
2347
|
+
|
|
2348
|
+
<dl>
|
|
2349
|
+
<dd>
|
|
2350
|
+
|
|
2351
|
+
```typescript
|
|
2352
|
+
await client.thread.addMessages("threadId", {
|
|
2353
|
+
messages: [
|
|
2354
|
+
{
|
|
2355
|
+
content: "content",
|
|
2356
|
+
role: "norole",
|
|
2357
|
+
},
|
|
2358
|
+
],
|
|
2359
|
+
});
|
|
2360
|
+
```
|
|
2361
|
+
|
|
2362
|
+
</dd>
|
|
2363
|
+
</dl>
|
|
2364
|
+
</dd>
|
|
2365
|
+
</dl>
|
|
2366
|
+
|
|
2367
|
+
#### ⚙️ Parameters
|
|
2368
|
+
|
|
2369
|
+
<dl>
|
|
2370
|
+
<dd>
|
|
2371
|
+
|
|
2372
|
+
<dl>
|
|
2373
|
+
<dd>
|
|
2374
|
+
|
|
2375
|
+
**threadId:** `string` — The ID of the thread to which messages should be added.
|
|
2376
|
+
|
|
2377
|
+
</dd>
|
|
2378
|
+
</dl>
|
|
2379
|
+
|
|
2380
|
+
<dl>
|
|
2381
|
+
<dd>
|
|
2382
|
+
|
|
2383
|
+
**request:** `Zep.AddThreadMessagesRequest`
|
|
2384
|
+
|
|
2385
|
+
</dd>
|
|
2386
|
+
</dl>
|
|
2387
|
+
|
|
2388
|
+
<dl>
|
|
2389
|
+
<dd>
|
|
2390
|
+
|
|
2391
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2392
|
+
|
|
2393
|
+
</dd>
|
|
2394
|
+
</dl>
|
|
2395
|
+
</dd>
|
|
2396
|
+
</dl>
|
|
2397
|
+
|
|
2398
|
+
</dd>
|
|
2399
|
+
</dl>
|
|
2400
|
+
</details>
|
|
2401
|
+
|
|
2402
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">addMessagesBatch</a>(threadId, { ...params }) -> Zep.AddThreadMessagesResponse</code></summary>
|
|
2403
|
+
<dl>
|
|
2404
|
+
<dd>
|
|
2405
|
+
|
|
2406
|
+
#### 📝 Description
|
|
2407
|
+
|
|
2408
|
+
<dl>
|
|
2409
|
+
<dd>
|
|
2410
|
+
|
|
2411
|
+
<dl>
|
|
2412
|
+
<dd>
|
|
2413
|
+
|
|
2414
|
+
Add messages to a thread in batch mode. This will process messages concurrently, which is useful for data migrations.
|
|
2415
|
+
|
|
2416
|
+
</dd>
|
|
2417
|
+
</dl>
|
|
2418
|
+
</dd>
|
|
2419
|
+
</dl>
|
|
2420
|
+
|
|
2421
|
+
#### 🔌 Usage
|
|
2422
|
+
|
|
2423
|
+
<dl>
|
|
2424
|
+
<dd>
|
|
2425
|
+
|
|
2426
|
+
<dl>
|
|
2427
|
+
<dd>
|
|
2428
|
+
|
|
2429
|
+
```typescript
|
|
2430
|
+
await client.thread.addMessagesBatch("threadId", {
|
|
2431
|
+
messages: [
|
|
2432
|
+
{
|
|
2433
|
+
content: "content",
|
|
2434
|
+
role: "norole",
|
|
2435
|
+
},
|
|
2436
|
+
],
|
|
2437
|
+
});
|
|
2438
|
+
```
|
|
2439
|
+
|
|
2440
|
+
</dd>
|
|
2441
|
+
</dl>
|
|
2442
|
+
</dd>
|
|
2443
|
+
</dl>
|
|
2444
|
+
|
|
2445
|
+
#### ⚙️ Parameters
|
|
2446
|
+
|
|
2447
|
+
<dl>
|
|
2448
|
+
<dd>
|
|
2449
|
+
|
|
2450
|
+
<dl>
|
|
2451
|
+
<dd>
|
|
2452
|
+
|
|
2453
|
+
**threadId:** `string` — The ID of the thread to which messages should be added.
|
|
2454
|
+
|
|
2455
|
+
</dd>
|
|
2456
|
+
</dl>
|
|
2457
|
+
|
|
2458
|
+
<dl>
|
|
2459
|
+
<dd>
|
|
2460
|
+
|
|
2461
|
+
**request:** `Zep.AddThreadMessagesRequest`
|
|
2462
|
+
|
|
2463
|
+
</dd>
|
|
2464
|
+
</dl>
|
|
2465
|
+
|
|
2466
|
+
<dl>
|
|
2467
|
+
<dd>
|
|
2468
|
+
|
|
2469
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2470
|
+
|
|
2471
|
+
</dd>
|
|
2472
|
+
</dl>
|
|
2473
|
+
</dd>
|
|
2474
|
+
</dl>
|
|
2475
|
+
|
|
2476
|
+
</dd>
|
|
2477
|
+
</dl>
|
|
2478
|
+
</details>
|
|
2479
|
+
|
|
2480
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">getSummary</a>(threadId) -> Zep.ThreadSummary</code></summary>
|
|
2481
|
+
<dl>
|
|
2482
|
+
<dd>
|
|
2483
|
+
|
|
2484
|
+
#### 📝 Description
|
|
2485
|
+
|
|
2486
|
+
<dl>
|
|
2487
|
+
<dd>
|
|
2488
|
+
|
|
2489
|
+
<dl>
|
|
2490
|
+
<dd>
|
|
2491
|
+
|
|
2492
|
+
Returns the incremental summary generated from messages in the thread. Returns 404 if no summary exists for the thread.
|
|
2493
|
+
|
|
2494
|
+
</dd>
|
|
2495
|
+
</dl>
|
|
2496
|
+
</dd>
|
|
2497
|
+
</dl>
|
|
2498
|
+
|
|
2499
|
+
#### 🔌 Usage
|
|
2500
|
+
|
|
2501
|
+
<dl>
|
|
2502
|
+
<dd>
|
|
2503
|
+
|
|
2504
|
+
<dl>
|
|
2505
|
+
<dd>
|
|
2506
|
+
|
|
2507
|
+
```typescript
|
|
2508
|
+
await client.thread.getSummary("threadId");
|
|
2509
|
+
```
|
|
2510
|
+
|
|
2511
|
+
</dd>
|
|
2512
|
+
</dl>
|
|
2513
|
+
</dd>
|
|
2514
|
+
</dl>
|
|
2515
|
+
|
|
2516
|
+
#### ⚙️ Parameters
|
|
2517
|
+
|
|
2518
|
+
<dl>
|
|
2519
|
+
<dd>
|
|
2520
|
+
|
|
2521
|
+
<dl>
|
|
2522
|
+
<dd>
|
|
2523
|
+
|
|
2524
|
+
**threadId:** `string` — The thread ID.
|
|
2525
|
+
|
|
2526
|
+
</dd>
|
|
2527
|
+
</dl>
|
|
2528
|
+
|
|
2529
|
+
<dl>
|
|
2530
|
+
<dd>
|
|
2531
|
+
|
|
2532
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2533
|
+
|
|
2534
|
+
</dd>
|
|
2535
|
+
</dl>
|
|
2536
|
+
</dd>
|
|
2537
|
+
</dl>
|
|
2538
|
+
|
|
2539
|
+
</dd>
|
|
2540
|
+
</dl>
|
|
2541
|
+
</details>
|
|
2542
|
+
|
|
2543
|
+
## User
|
|
2544
|
+
|
|
2545
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">listUserSummaryInstructions</a>({ ...params }) -> Zep.ListUserInstructionsResponse</code></summary>
|
|
1572
2546
|
<dl>
|
|
1573
2547
|
<dd>
|
|
1574
2548
|
|
|
@@ -1580,7 +2554,7 @@ await client.thread.listAll({
|
|
|
1580
2554
|
<dl>
|
|
1581
2555
|
<dd>
|
|
1582
2556
|
|
|
1583
|
-
|
|
2557
|
+
Lists all user summary instructions for a project, user.
|
|
1584
2558
|
|
|
1585
2559
|
</dd>
|
|
1586
2560
|
</dl>
|
|
@@ -1596,8 +2570,7 @@ Start a new thread.
|
|
|
1596
2570
|
<dd>
|
|
1597
2571
|
|
|
1598
2572
|
```typescript
|
|
1599
|
-
await client.
|
|
1600
|
-
threadId: "thread_id",
|
|
2573
|
+
await client.user.listUserSummaryInstructions({
|
|
1601
2574
|
userId: "user_id",
|
|
1602
2575
|
});
|
|
1603
2576
|
```
|
|
@@ -1615,7 +2588,7 @@ await client.thread.create({
|
|
|
1615
2588
|
<dl>
|
|
1616
2589
|
<dd>
|
|
1617
2590
|
|
|
1618
|
-
**request:** `Zep.
|
|
2591
|
+
**request:** `Zep.UserListUserSummaryInstructionsRequest`
|
|
1619
2592
|
|
|
1620
2593
|
</dd>
|
|
1621
2594
|
</dl>
|
|
@@ -1623,7 +2596,7 @@ await client.thread.create({
|
|
|
1623
2596
|
<dl>
|
|
1624
2597
|
<dd>
|
|
1625
2598
|
|
|
1626
|
-
**requestOptions:** `
|
|
2599
|
+
**requestOptions:** `User.RequestOptions`
|
|
1627
2600
|
|
|
1628
2601
|
</dd>
|
|
1629
2602
|
</dl>
|
|
@@ -1634,7 +2607,7 @@ await client.thread.create({
|
|
|
1634
2607
|
</dl>
|
|
1635
2608
|
</details>
|
|
1636
2609
|
|
|
1637
|
-
<details><summary><code>client.
|
|
2610
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">addUserSummaryInstructions</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
|
|
1638
2611
|
<dl>
|
|
1639
2612
|
<dd>
|
|
1640
2613
|
|
|
@@ -1646,7 +2619,7 @@ await client.thread.create({
|
|
|
1646
2619
|
<dl>
|
|
1647
2620
|
<dd>
|
|
1648
2621
|
|
|
1649
|
-
|
|
2622
|
+
Adds new summary instructions for users graphs without removing existing ones. If user_ids is empty, adds to project-wide default instructions.
|
|
1650
2623
|
|
|
1651
2624
|
</dd>
|
|
1652
2625
|
</dl>
|
|
@@ -1662,7 +2635,14 @@ Deletes a thread.
|
|
|
1662
2635
|
<dd>
|
|
1663
2636
|
|
|
1664
2637
|
```typescript
|
|
1665
|
-
await client.
|
|
2638
|
+
await client.user.addUserSummaryInstructions({
|
|
2639
|
+
instructions: [
|
|
2640
|
+
{
|
|
2641
|
+
name: "name",
|
|
2642
|
+
text: "text",
|
|
2643
|
+
},
|
|
2644
|
+
],
|
|
2645
|
+
});
|
|
1666
2646
|
```
|
|
1667
2647
|
|
|
1668
2648
|
</dd>
|
|
@@ -1678,7 +2658,7 @@ await client.thread.delete("threadId");
|
|
|
1678
2658
|
<dl>
|
|
1679
2659
|
<dd>
|
|
1680
2660
|
|
|
1681
|
-
**
|
|
2661
|
+
**request:** `Zep.AddUserInstructionsRequest`
|
|
1682
2662
|
|
|
1683
2663
|
</dd>
|
|
1684
2664
|
</dl>
|
|
@@ -1686,7 +2666,7 @@ await client.thread.delete("threadId");
|
|
|
1686
2666
|
<dl>
|
|
1687
2667
|
<dd>
|
|
1688
2668
|
|
|
1689
|
-
**requestOptions:** `
|
|
2669
|
+
**requestOptions:** `User.RequestOptions`
|
|
1690
2670
|
|
|
1691
2671
|
</dd>
|
|
1692
2672
|
</dl>
|
|
@@ -1697,7 +2677,7 @@ await client.thread.delete("threadId");
|
|
|
1697
2677
|
</dl>
|
|
1698
2678
|
</details>
|
|
1699
2679
|
|
|
1700
|
-
<details><summary><code>client.
|
|
2680
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">deleteUserSummaryInstructions</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
|
|
1701
2681
|
<dl>
|
|
1702
2682
|
<dd>
|
|
1703
2683
|
|
|
@@ -1709,7 +2689,7 @@ await client.thread.delete("threadId");
|
|
|
1709
2689
|
<dl>
|
|
1710
2690
|
<dd>
|
|
1711
2691
|
|
|
1712
|
-
|
|
2692
|
+
Deletes user summary/instructions for users or project wide defaults.
|
|
1713
2693
|
|
|
1714
2694
|
</dd>
|
|
1715
2695
|
</dl>
|
|
@@ -1725,9 +2705,7 @@ Returns most relevant context from the user graph (including memory from any/all
|
|
|
1725
2705
|
<dd>
|
|
1726
2706
|
|
|
1727
2707
|
```typescript
|
|
1728
|
-
await client.
|
|
1729
|
-
templateId: "template_id",
|
|
1730
|
-
});
|
|
2708
|
+
await client.user.deleteUserSummaryInstructions();
|
|
1731
2709
|
```
|
|
1732
2710
|
|
|
1733
2711
|
</dd>
|
|
@@ -1743,15 +2721,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1743
2721
|
<dl>
|
|
1744
2722
|
<dd>
|
|
1745
2723
|
|
|
1746
|
-
**
|
|
1747
|
-
|
|
1748
|
-
</dd>
|
|
1749
|
-
</dl>
|
|
1750
|
-
|
|
1751
|
-
<dl>
|
|
1752
|
-
<dd>
|
|
1753
|
-
|
|
1754
|
-
**request:** `Zep.ThreadGetUserContextRequest`
|
|
2724
|
+
**request:** `Zep.DeleteUserInstructionsRequest`
|
|
1755
2725
|
|
|
1756
2726
|
</dd>
|
|
1757
2727
|
</dl>
|
|
@@ -1759,7 +2729,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1759
2729
|
<dl>
|
|
1760
2730
|
<dd>
|
|
1761
2731
|
|
|
1762
|
-
**requestOptions:** `
|
|
2732
|
+
**requestOptions:** `User.RequestOptions`
|
|
1763
2733
|
|
|
1764
2734
|
</dd>
|
|
1765
2735
|
</dl>
|
|
@@ -1770,7 +2740,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1770
2740
|
</dl>
|
|
1771
2741
|
</details>
|
|
1772
2742
|
|
|
1773
|
-
<details><summary><code>client.
|
|
2743
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">add</a>({ ...params }) -> Zep.User</code></summary>
|
|
1774
2744
|
<dl>
|
|
1775
2745
|
<dd>
|
|
1776
2746
|
|
|
@@ -1782,7 +2752,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1782
2752
|
<dl>
|
|
1783
2753
|
<dd>
|
|
1784
2754
|
|
|
1785
|
-
|
|
2755
|
+
Adds a user.
|
|
1786
2756
|
|
|
1787
2757
|
</dd>
|
|
1788
2758
|
</dl>
|
|
@@ -1798,10 +2768,8 @@ Returns messages for a thread.
|
|
|
1798
2768
|
<dd>
|
|
1799
2769
|
|
|
1800
2770
|
```typescript
|
|
1801
|
-
await client.
|
|
1802
|
-
|
|
1803
|
-
cursor: 1,
|
|
1804
|
-
lastn: 1,
|
|
2771
|
+
await client.user.add({
|
|
2772
|
+
userId: "user_id",
|
|
1805
2773
|
});
|
|
1806
2774
|
```
|
|
1807
2775
|
|
|
@@ -1818,15 +2786,7 @@ await client.thread.get("threadId", {
|
|
|
1818
2786
|
<dl>
|
|
1819
2787
|
<dd>
|
|
1820
2788
|
|
|
1821
|
-
**
|
|
1822
|
-
|
|
1823
|
-
</dd>
|
|
1824
|
-
</dl>
|
|
1825
|
-
|
|
1826
|
-
<dl>
|
|
1827
|
-
<dd>
|
|
1828
|
-
|
|
1829
|
-
**request:** `Zep.ThreadGetRequest`
|
|
2789
|
+
**request:** `Zep.CreateUserRequest`
|
|
1830
2790
|
|
|
1831
2791
|
</dd>
|
|
1832
2792
|
</dl>
|
|
@@ -1834,7 +2794,7 @@ await client.thread.get("threadId", {
|
|
|
1834
2794
|
<dl>
|
|
1835
2795
|
<dd>
|
|
1836
2796
|
|
|
1837
|
-
**requestOptions:** `
|
|
2797
|
+
**requestOptions:** `User.RequestOptions`
|
|
1838
2798
|
|
|
1839
2799
|
</dd>
|
|
1840
2800
|
</dl>
|
|
@@ -1845,7 +2805,7 @@ await client.thread.get("threadId", {
|
|
|
1845
2805
|
</dl>
|
|
1846
2806
|
</details>
|
|
1847
2807
|
|
|
1848
|
-
<details><summary><code>client.
|
|
2808
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">listOrdered</a>({ ...params }) -> Zep.UserListResponse</code></summary>
|
|
1849
2809
|
<dl>
|
|
1850
2810
|
<dd>
|
|
1851
2811
|
|
|
@@ -1857,7 +2817,7 @@ await client.thread.get("threadId", {
|
|
|
1857
2817
|
<dl>
|
|
1858
2818
|
<dd>
|
|
1859
2819
|
|
|
1860
|
-
|
|
2820
|
+
Returns all users.
|
|
1861
2821
|
|
|
1862
2822
|
</dd>
|
|
1863
2823
|
</dl>
|
|
@@ -1873,13 +2833,12 @@ Add messages to a thread.
|
|
|
1873
2833
|
<dd>
|
|
1874
2834
|
|
|
1875
2835
|
```typescript
|
|
1876
|
-
await client.
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
],
|
|
2836
|
+
await client.user.listOrdered({
|
|
2837
|
+
pageNumber: 1,
|
|
2838
|
+
pageSize: 1,
|
|
2839
|
+
search: "search",
|
|
2840
|
+
orderBy: "order_by",
|
|
2841
|
+
asc: true,
|
|
1883
2842
|
});
|
|
1884
2843
|
```
|
|
1885
2844
|
|
|
@@ -1896,15 +2855,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1896
2855
|
<dl>
|
|
1897
2856
|
<dd>
|
|
1898
2857
|
|
|
1899
|
-
**
|
|
1900
|
-
|
|
1901
|
-
</dd>
|
|
1902
|
-
</dl>
|
|
1903
|
-
|
|
1904
|
-
<dl>
|
|
1905
|
-
<dd>
|
|
1906
|
-
|
|
1907
|
-
**request:** `Zep.AddThreadMessagesRequest`
|
|
2858
|
+
**request:** `Zep.UserListOrderedRequest`
|
|
1908
2859
|
|
|
1909
2860
|
</dd>
|
|
1910
2861
|
</dl>
|
|
@@ -1912,7 +2863,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1912
2863
|
<dl>
|
|
1913
2864
|
<dd>
|
|
1914
2865
|
|
|
1915
|
-
**requestOptions:** `
|
|
2866
|
+
**requestOptions:** `User.RequestOptions`
|
|
1916
2867
|
|
|
1917
2868
|
</dd>
|
|
1918
2869
|
</dl>
|
|
@@ -1923,7 +2874,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1923
2874
|
</dl>
|
|
1924
2875
|
</details>
|
|
1925
2876
|
|
|
1926
|
-
<details><summary><code>client.
|
|
2877
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">get</a>(userId) -> Zep.User</code></summary>
|
|
1927
2878
|
<dl>
|
|
1928
2879
|
<dd>
|
|
1929
2880
|
|
|
@@ -1935,7 +2886,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1935
2886
|
<dl>
|
|
1936
2887
|
<dd>
|
|
1937
2888
|
|
|
1938
|
-
|
|
2889
|
+
Returns a user.
|
|
1939
2890
|
|
|
1940
2891
|
</dd>
|
|
1941
2892
|
</dl>
|
|
@@ -1951,14 +2902,7 @@ Add messages to a thread in batch mode. This will process messages concurrently,
|
|
|
1951
2902
|
<dd>
|
|
1952
2903
|
|
|
1953
2904
|
```typescript
|
|
1954
|
-
await client.
|
|
1955
|
-
messages: [
|
|
1956
|
-
{
|
|
1957
|
-
content: "content",
|
|
1958
|
-
role: "norole",
|
|
1959
|
-
},
|
|
1960
|
-
],
|
|
1961
|
-
});
|
|
2905
|
+
await client.user.get("userId");
|
|
1962
2906
|
```
|
|
1963
2907
|
|
|
1964
2908
|
</dd>
|
|
@@ -1974,15 +2918,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
1974
2918
|
<dl>
|
|
1975
2919
|
<dd>
|
|
1976
2920
|
|
|
1977
|
-
**
|
|
1978
|
-
|
|
1979
|
-
</dd>
|
|
1980
|
-
</dl>
|
|
1981
|
-
|
|
1982
|
-
<dl>
|
|
1983
|
-
<dd>
|
|
1984
|
-
|
|
1985
|
-
**request:** `Zep.AddThreadMessagesRequest`
|
|
2921
|
+
**userId:** `string` — The user_id of the user to get.
|
|
1986
2922
|
|
|
1987
2923
|
</dd>
|
|
1988
2924
|
</dl>
|
|
@@ -1990,7 +2926,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
1990
2926
|
<dl>
|
|
1991
2927
|
<dd>
|
|
1992
2928
|
|
|
1993
|
-
**requestOptions:** `
|
|
2929
|
+
**requestOptions:** `User.RequestOptions`
|
|
1994
2930
|
|
|
1995
2931
|
</dd>
|
|
1996
2932
|
</dl>
|
|
@@ -2001,9 +2937,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
2001
2937
|
</dl>
|
|
2002
2938
|
</details>
|
|
2003
2939
|
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">listUserSummaryInstructions</a>({ ...params }) -> Zep.ListUserInstructionsResponse</code></summary>
|
|
2940
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">delete</a>(userId) -> Zep.SuccessResponse</code></summary>
|
|
2007
2941
|
<dl>
|
|
2008
2942
|
<dd>
|
|
2009
2943
|
|
|
@@ -2015,7 +2949,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
2015
2949
|
<dl>
|
|
2016
2950
|
<dd>
|
|
2017
2951
|
|
|
2018
|
-
|
|
2952
|
+
Deletes a user.
|
|
2019
2953
|
|
|
2020
2954
|
</dd>
|
|
2021
2955
|
</dl>
|
|
@@ -2031,9 +2965,7 @@ Lists all user summary instructions for a project, user.
|
|
|
2031
2965
|
<dd>
|
|
2032
2966
|
|
|
2033
2967
|
```typescript
|
|
2034
|
-
await client.user.
|
|
2035
|
-
userId: "user_id",
|
|
2036
|
-
});
|
|
2968
|
+
await client.user.delete("userId");
|
|
2037
2969
|
```
|
|
2038
2970
|
|
|
2039
2971
|
</dd>
|
|
@@ -2049,7 +2981,7 @@ await client.user.listUserSummaryInstructions({
|
|
|
2049
2981
|
<dl>
|
|
2050
2982
|
<dd>
|
|
2051
2983
|
|
|
2052
|
-
**
|
|
2984
|
+
**userId:** `string` — User ID
|
|
2053
2985
|
|
|
2054
2986
|
</dd>
|
|
2055
2987
|
</dl>
|
|
@@ -2068,7 +3000,7 @@ await client.user.listUserSummaryInstructions({
|
|
|
2068
3000
|
</dl>
|
|
2069
3001
|
</details>
|
|
2070
3002
|
|
|
2071
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">
|
|
3003
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">update</a>(userId, { ...params }) -> Zep.User</code></summary>
|
|
2072
3004
|
<dl>
|
|
2073
3005
|
<dd>
|
|
2074
3006
|
|
|
@@ -2080,7 +3012,7 @@ await client.user.listUserSummaryInstructions({
|
|
|
2080
3012
|
<dl>
|
|
2081
3013
|
<dd>
|
|
2082
3014
|
|
|
2083
|
-
|
|
3015
|
+
Updates a user.
|
|
2084
3016
|
|
|
2085
3017
|
</dd>
|
|
2086
3018
|
</dl>
|
|
@@ -2096,14 +3028,7 @@ Adds new summary instructions for users graphs without removing existing ones. I
|
|
|
2096
3028
|
<dd>
|
|
2097
3029
|
|
|
2098
3030
|
```typescript
|
|
2099
|
-
await client.user.
|
|
2100
|
-
instructions: [
|
|
2101
|
-
{
|
|
2102
|
-
name: "name",
|
|
2103
|
-
text: "text",
|
|
2104
|
-
},
|
|
2105
|
-
],
|
|
2106
|
-
});
|
|
3031
|
+
await client.user.update("userId");
|
|
2107
3032
|
```
|
|
2108
3033
|
|
|
2109
3034
|
</dd>
|
|
@@ -2119,7 +3044,15 @@ await client.user.addUserSummaryInstructions({
|
|
|
2119
3044
|
<dl>
|
|
2120
3045
|
<dd>
|
|
2121
3046
|
|
|
2122
|
-
**
|
|
3047
|
+
**userId:** `string` — User ID
|
|
3048
|
+
|
|
3049
|
+
</dd>
|
|
3050
|
+
</dl>
|
|
3051
|
+
|
|
3052
|
+
<dl>
|
|
3053
|
+
<dd>
|
|
3054
|
+
|
|
3055
|
+
**request:** `Zep.UpdateUserRequest`
|
|
2123
3056
|
|
|
2124
3057
|
</dd>
|
|
2125
3058
|
</dl>
|
|
@@ -2138,7 +3071,7 @@ await client.user.addUserSummaryInstructions({
|
|
|
2138
3071
|
</dl>
|
|
2139
3072
|
</details>
|
|
2140
3073
|
|
|
2141
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">
|
|
3074
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getNode</a>(userId) -> Zep.UserNodeResponse</code></summary>
|
|
2142
3075
|
<dl>
|
|
2143
3076
|
<dd>
|
|
2144
3077
|
|
|
@@ -2150,7 +3083,7 @@ await client.user.addUserSummaryInstructions({
|
|
|
2150
3083
|
<dl>
|
|
2151
3084
|
<dd>
|
|
2152
3085
|
|
|
2153
|
-
|
|
3086
|
+
Returns a user's node.
|
|
2154
3087
|
|
|
2155
3088
|
</dd>
|
|
2156
3089
|
</dl>
|
|
@@ -2166,7 +3099,7 @@ Deletes user summary/instructions for users or project wide defaults.
|
|
|
2166
3099
|
<dd>
|
|
2167
3100
|
|
|
2168
3101
|
```typescript
|
|
2169
|
-
await client.user.
|
|
3102
|
+
await client.user.getNode("userId");
|
|
2170
3103
|
```
|
|
2171
3104
|
|
|
2172
3105
|
</dd>
|
|
@@ -2182,7 +3115,7 @@ await client.user.deleteUserSummaryInstructions();
|
|
|
2182
3115
|
<dl>
|
|
2183
3116
|
<dd>
|
|
2184
3117
|
|
|
2185
|
-
**
|
|
3118
|
+
**userId:** `string` — The user_id of the user to get the node for.
|
|
2186
3119
|
|
|
2187
3120
|
</dd>
|
|
2188
3121
|
</dl>
|
|
@@ -2201,7 +3134,7 @@ await client.user.deleteUserSummaryInstructions();
|
|
|
2201
3134
|
</dl>
|
|
2202
3135
|
</details>
|
|
2203
3136
|
|
|
2204
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">
|
|
3137
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getThreads</a>(userId) -> Zep.Thread[]</code></summary>
|
|
2205
3138
|
<dl>
|
|
2206
3139
|
<dd>
|
|
2207
3140
|
|
|
@@ -2213,7 +3146,7 @@ await client.user.deleteUserSummaryInstructions();
|
|
|
2213
3146
|
<dl>
|
|
2214
3147
|
<dd>
|
|
2215
3148
|
|
|
2216
|
-
|
|
3149
|
+
Returns all threads for a user.
|
|
2217
3150
|
|
|
2218
3151
|
</dd>
|
|
2219
3152
|
</dl>
|
|
@@ -2229,9 +3162,7 @@ Adds a user.
|
|
|
2229
3162
|
<dd>
|
|
2230
3163
|
|
|
2231
3164
|
```typescript
|
|
2232
|
-
await client.user.
|
|
2233
|
-
userId: "user_id",
|
|
2234
|
-
});
|
|
3165
|
+
await client.user.getThreads("userId");
|
|
2235
3166
|
```
|
|
2236
3167
|
|
|
2237
3168
|
</dd>
|
|
@@ -2247,7 +3178,7 @@ await client.user.add({
|
|
|
2247
3178
|
<dl>
|
|
2248
3179
|
<dd>
|
|
2249
3180
|
|
|
2250
|
-
**
|
|
3181
|
+
**userId:** `string` — User ID
|
|
2251
3182
|
|
|
2252
3183
|
</dd>
|
|
2253
3184
|
</dl>
|
|
@@ -2266,7 +3197,7 @@ await client.user.add({
|
|
|
2266
3197
|
</dl>
|
|
2267
3198
|
</details>
|
|
2268
3199
|
|
|
2269
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">
|
|
3200
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">warm</a>(userId) -> Zep.SuccessResponse</code></summary>
|
|
2270
3201
|
<dl>
|
|
2271
3202
|
<dd>
|
|
2272
3203
|
|
|
@@ -2278,7 +3209,7 @@ await client.user.add({
|
|
|
2278
3209
|
<dl>
|
|
2279
3210
|
<dd>
|
|
2280
3211
|
|
|
2281
|
-
|
|
3212
|
+
Hints Zep to warm a user's graph for low-latency search
|
|
2282
3213
|
|
|
2283
3214
|
</dd>
|
|
2284
3215
|
</dl>
|
|
@@ -2294,13 +3225,7 @@ Returns all users.
|
|
|
2294
3225
|
<dd>
|
|
2295
3226
|
|
|
2296
3227
|
```typescript
|
|
2297
|
-
await client.user.
|
|
2298
|
-
pageNumber: 1,
|
|
2299
|
-
pageSize: 1,
|
|
2300
|
-
search: "search",
|
|
2301
|
-
orderBy: "order_by",
|
|
2302
|
-
asc: true,
|
|
2303
|
-
});
|
|
3228
|
+
await client.user.warm("userId");
|
|
2304
3229
|
```
|
|
2305
3230
|
|
|
2306
3231
|
</dd>
|
|
@@ -2316,7 +3241,7 @@ await client.user.listOrdered({
|
|
|
2316
3241
|
<dl>
|
|
2317
3242
|
<dd>
|
|
2318
3243
|
|
|
2319
|
-
**
|
|
3244
|
+
**userId:** `string` — User ID
|
|
2320
3245
|
|
|
2321
3246
|
</dd>
|
|
2322
3247
|
</dl>
|
|
@@ -2335,7 +3260,9 @@ await client.user.listOrdered({
|
|
|
2335
3260
|
</dl>
|
|
2336
3261
|
</details>
|
|
2337
3262
|
|
|
2338
|
-
|
|
3263
|
+
## Graph Edge
|
|
3264
|
+
|
|
3265
|
+
<details><summary><code>client.graph.edge.<a href="/src/api/resources/graph/resources/edge/client/Client.ts">getByGraphId</a>(graphId, { ...params }) -> Zep.EntityEdge[]</code></summary>
|
|
2339
3266
|
<dl>
|
|
2340
3267
|
<dd>
|
|
2341
3268
|
|
|
@@ -2347,7 +3274,7 @@ await client.user.listOrdered({
|
|
|
2347
3274
|
<dl>
|
|
2348
3275
|
<dd>
|
|
2349
3276
|
|
|
2350
|
-
Returns a
|
|
3277
|
+
Returns all edges for a graph.
|
|
2351
3278
|
|
|
2352
3279
|
</dd>
|
|
2353
3280
|
</dl>
|
|
@@ -2363,7 +3290,7 @@ Returns a user.
|
|
|
2363
3290
|
<dd>
|
|
2364
3291
|
|
|
2365
3292
|
```typescript
|
|
2366
|
-
await client.
|
|
3293
|
+
await client.graph.edge.getByGraphId("graph_id", {});
|
|
2367
3294
|
```
|
|
2368
3295
|
|
|
2369
3296
|
</dd>
|
|
@@ -2379,7 +3306,7 @@ await client.user.get("userId");
|
|
|
2379
3306
|
<dl>
|
|
2380
3307
|
<dd>
|
|
2381
3308
|
|
|
2382
|
-
**
|
|
3309
|
+
**graphId:** `string` — Graph ID
|
|
2383
3310
|
|
|
2384
3311
|
</dd>
|
|
2385
3312
|
</dl>
|
|
@@ -2387,7 +3314,15 @@ await client.user.get("userId");
|
|
|
2387
3314
|
<dl>
|
|
2388
3315
|
<dd>
|
|
2389
3316
|
|
|
2390
|
-
**
|
|
3317
|
+
**request:** `Zep.GraphEdgesRequest`
|
|
3318
|
+
|
|
3319
|
+
</dd>
|
|
3320
|
+
</dl>
|
|
3321
|
+
|
|
3322
|
+
<dl>
|
|
3323
|
+
<dd>
|
|
3324
|
+
|
|
3325
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2391
3326
|
|
|
2392
3327
|
</dd>
|
|
2393
3328
|
</dl>
|
|
@@ -2398,7 +3333,7 @@ await client.user.get("userId");
|
|
|
2398
3333
|
</dl>
|
|
2399
3334
|
</details>
|
|
2400
3335
|
|
|
2401
|
-
<details><summary><code>client.
|
|
3336
|
+
<details><summary><code>client.graph.edge.<a href="/src/api/resources/graph/resources/edge/client/Client.ts">getByUserId</a>(userId, { ...params }) -> Zep.EntityEdge[]</code></summary>
|
|
2402
3337
|
<dl>
|
|
2403
3338
|
<dd>
|
|
2404
3339
|
|
|
@@ -2410,7 +3345,7 @@ await client.user.get("userId");
|
|
|
2410
3345
|
<dl>
|
|
2411
3346
|
<dd>
|
|
2412
3347
|
|
|
2413
|
-
|
|
3348
|
+
Returns all edges for a user.
|
|
2414
3349
|
|
|
2415
3350
|
</dd>
|
|
2416
3351
|
</dl>
|
|
@@ -2426,7 +3361,7 @@ Deletes a user.
|
|
|
2426
3361
|
<dd>
|
|
2427
3362
|
|
|
2428
3363
|
```typescript
|
|
2429
|
-
await client.
|
|
3364
|
+
await client.graph.edge.getByUserId("user_id", {});
|
|
2430
3365
|
```
|
|
2431
3366
|
|
|
2432
3367
|
</dd>
|
|
@@ -2450,7 +3385,15 @@ await client.user.delete("userId");
|
|
|
2450
3385
|
<dl>
|
|
2451
3386
|
<dd>
|
|
2452
3387
|
|
|
2453
|
-
**
|
|
3388
|
+
**request:** `Zep.GraphEdgesRequest`
|
|
3389
|
+
|
|
3390
|
+
</dd>
|
|
3391
|
+
</dl>
|
|
3392
|
+
|
|
3393
|
+
<dl>
|
|
3394
|
+
<dd>
|
|
3395
|
+
|
|
3396
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2454
3397
|
|
|
2455
3398
|
</dd>
|
|
2456
3399
|
</dl>
|
|
@@ -2461,7 +3404,7 @@ await client.user.delete("userId");
|
|
|
2461
3404
|
</dl>
|
|
2462
3405
|
</details>
|
|
2463
3406
|
|
|
2464
|
-
<details><summary><code>client.
|
|
3407
|
+
<details><summary><code>client.graph.edge.<a href="/src/api/resources/graph/resources/edge/client/Client.ts">get</a>(uuid) -> Zep.EntityEdge</code></summary>
|
|
2465
3408
|
<dl>
|
|
2466
3409
|
<dd>
|
|
2467
3410
|
|
|
@@ -2473,7 +3416,7 @@ await client.user.delete("userId");
|
|
|
2473
3416
|
<dl>
|
|
2474
3417
|
<dd>
|
|
2475
3418
|
|
|
2476
|
-
|
|
3419
|
+
Returns a specific edge by its UUID.
|
|
2477
3420
|
|
|
2478
3421
|
</dd>
|
|
2479
3422
|
</dl>
|
|
@@ -2489,7 +3432,7 @@ Updates a user.
|
|
|
2489
3432
|
<dd>
|
|
2490
3433
|
|
|
2491
3434
|
```typescript
|
|
2492
|
-
await client.
|
|
3435
|
+
await client.graph.edge.get("uuid");
|
|
2493
3436
|
```
|
|
2494
3437
|
|
|
2495
3438
|
</dd>
|
|
@@ -2505,15 +3448,7 @@ await client.user.update("userId");
|
|
|
2505
3448
|
<dl>
|
|
2506
3449
|
<dd>
|
|
2507
3450
|
|
|
2508
|
-
**
|
|
2509
|
-
|
|
2510
|
-
</dd>
|
|
2511
|
-
</dl>
|
|
2512
|
-
|
|
2513
|
-
<dl>
|
|
2514
|
-
<dd>
|
|
2515
|
-
|
|
2516
|
-
**request:** `Zep.UpdateUserRequest`
|
|
3451
|
+
**uuid:** `string` — Edge UUID
|
|
2517
3452
|
|
|
2518
3453
|
</dd>
|
|
2519
3454
|
</dl>
|
|
@@ -2521,7 +3456,7 @@ await client.user.update("userId");
|
|
|
2521
3456
|
<dl>
|
|
2522
3457
|
<dd>
|
|
2523
3458
|
|
|
2524
|
-
**requestOptions:** `
|
|
3459
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2525
3460
|
|
|
2526
3461
|
</dd>
|
|
2527
3462
|
</dl>
|
|
@@ -2532,7 +3467,7 @@ await client.user.update("userId");
|
|
|
2532
3467
|
</dl>
|
|
2533
3468
|
</details>
|
|
2534
3469
|
|
|
2535
|
-
<details><summary><code>client.
|
|
3470
|
+
<details><summary><code>client.graph.edge.<a href="/src/api/resources/graph/resources/edge/client/Client.ts">delete</a>(uuid) -> Zep.SuccessResponse</code></summary>
|
|
2536
3471
|
<dl>
|
|
2537
3472
|
<dd>
|
|
2538
3473
|
|
|
@@ -2544,7 +3479,7 @@ await client.user.update("userId");
|
|
|
2544
3479
|
<dl>
|
|
2545
3480
|
<dd>
|
|
2546
3481
|
|
|
2547
|
-
|
|
3482
|
+
Deletes an edge by UUID.
|
|
2548
3483
|
|
|
2549
3484
|
</dd>
|
|
2550
3485
|
</dl>
|
|
@@ -2560,7 +3495,7 @@ Returns a user's node.
|
|
|
2560
3495
|
<dd>
|
|
2561
3496
|
|
|
2562
3497
|
```typescript
|
|
2563
|
-
await client.
|
|
3498
|
+
await client.graph.edge.delete("uuid");
|
|
2564
3499
|
```
|
|
2565
3500
|
|
|
2566
3501
|
</dd>
|
|
@@ -2576,7 +3511,7 @@ await client.user.getNode("userId");
|
|
|
2576
3511
|
<dl>
|
|
2577
3512
|
<dd>
|
|
2578
3513
|
|
|
2579
|
-
**
|
|
3514
|
+
**uuid:** `string` — Edge UUID
|
|
2580
3515
|
|
|
2581
3516
|
</dd>
|
|
2582
3517
|
</dl>
|
|
@@ -2584,7 +3519,7 @@ await client.user.getNode("userId");
|
|
|
2584
3519
|
<dl>
|
|
2585
3520
|
<dd>
|
|
2586
3521
|
|
|
2587
|
-
**requestOptions:** `
|
|
3522
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2588
3523
|
|
|
2589
3524
|
</dd>
|
|
2590
3525
|
</dl>
|
|
@@ -2595,7 +3530,7 @@ await client.user.getNode("userId");
|
|
|
2595
3530
|
</dl>
|
|
2596
3531
|
</details>
|
|
2597
3532
|
|
|
2598
|
-
<details><summary><code>client.
|
|
3533
|
+
<details><summary><code>client.graph.edge.<a href="/src/api/resources/graph/resources/edge/client/Client.ts">update</a>(uuid, { ...params }) -> Zep.EntityEdge</code></summary>
|
|
2599
3534
|
<dl>
|
|
2600
3535
|
<dd>
|
|
2601
3536
|
|
|
@@ -2607,7 +3542,7 @@ await client.user.getNode("userId");
|
|
|
2607
3542
|
<dl>
|
|
2608
3543
|
<dd>
|
|
2609
3544
|
|
|
2610
|
-
|
|
3545
|
+
Updates an entity edge by UUID.
|
|
2611
3546
|
|
|
2612
3547
|
</dd>
|
|
2613
3548
|
</dl>
|
|
@@ -2623,7 +3558,7 @@ Returns all threads for a user.
|
|
|
2623
3558
|
<dd>
|
|
2624
3559
|
|
|
2625
3560
|
```typescript
|
|
2626
|
-
await client.
|
|
3561
|
+
await client.graph.edge.update("uuid");
|
|
2627
3562
|
```
|
|
2628
3563
|
|
|
2629
3564
|
</dd>
|
|
@@ -2639,7 +3574,7 @@ await client.user.getThreads("userId");
|
|
|
2639
3574
|
<dl>
|
|
2640
3575
|
<dd>
|
|
2641
3576
|
|
|
2642
|
-
**
|
|
3577
|
+
**uuid:** `string` — Edge UUID
|
|
2643
3578
|
|
|
2644
3579
|
</dd>
|
|
2645
3580
|
</dl>
|
|
@@ -2647,7 +3582,15 @@ await client.user.getThreads("userId");
|
|
|
2647
3582
|
<dl>
|
|
2648
3583
|
<dd>
|
|
2649
3584
|
|
|
2650
|
-
**
|
|
3585
|
+
**request:** `Zep.graph.UpdateEdgeRequest`
|
|
3586
|
+
|
|
3587
|
+
</dd>
|
|
3588
|
+
</dl>
|
|
3589
|
+
|
|
3590
|
+
<dl>
|
|
3591
|
+
<dd>
|
|
3592
|
+
|
|
3593
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2651
3594
|
|
|
2652
3595
|
</dd>
|
|
2653
3596
|
</dl>
|
|
@@ -2658,7 +3601,9 @@ await client.user.getThreads("userId");
|
|
|
2658
3601
|
</dl>
|
|
2659
3602
|
</details>
|
|
2660
3603
|
|
|
2661
|
-
|
|
3604
|
+
## Graph Episode
|
|
3605
|
+
|
|
3606
|
+
<details><summary><code>client.graph.episode.<a href="/src/api/resources/graph/resources/episode/client/Client.ts">getByGraphId</a>(graphId, { ...params }) -> Zep.EpisodeResponse</code></summary>
|
|
2662
3607
|
<dl>
|
|
2663
3608
|
<dd>
|
|
2664
3609
|
|
|
@@ -2670,7 +3615,7 @@ await client.user.getThreads("userId");
|
|
|
2670
3615
|
<dl>
|
|
2671
3616
|
<dd>
|
|
2672
3617
|
|
|
2673
|
-
|
|
3618
|
+
Returns episodes by graph id.
|
|
2674
3619
|
|
|
2675
3620
|
</dd>
|
|
2676
3621
|
</dl>
|
|
@@ -2686,7 +3631,9 @@ Hints Zep to warm a user's graph for low-latency search
|
|
|
2686
3631
|
<dd>
|
|
2687
3632
|
|
|
2688
3633
|
```typescript
|
|
2689
|
-
await client.
|
|
3634
|
+
await client.graph.episode.getByGraphId("graph_id", {
|
|
3635
|
+
lastn: 1,
|
|
3636
|
+
});
|
|
2690
3637
|
```
|
|
2691
3638
|
|
|
2692
3639
|
</dd>
|
|
@@ -2702,7 +3649,7 @@ await client.user.warm("userId");
|
|
|
2702
3649
|
<dl>
|
|
2703
3650
|
<dd>
|
|
2704
3651
|
|
|
2705
|
-
**
|
|
3652
|
+
**graphId:** `string` — Graph ID
|
|
2706
3653
|
|
|
2707
3654
|
</dd>
|
|
2708
3655
|
</dl>
|
|
@@ -2710,7 +3657,15 @@ await client.user.warm("userId");
|
|
|
2710
3657
|
<dl>
|
|
2711
3658
|
<dd>
|
|
2712
3659
|
|
|
2713
|
-
**
|
|
3660
|
+
**request:** `Zep.graph.EpisodeGetByGraphIdRequest`
|
|
3661
|
+
|
|
3662
|
+
</dd>
|
|
3663
|
+
</dl>
|
|
3664
|
+
|
|
3665
|
+
<dl>
|
|
3666
|
+
<dd>
|
|
3667
|
+
|
|
3668
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2714
3669
|
|
|
2715
3670
|
</dd>
|
|
2716
3671
|
</dl>
|
|
@@ -2721,9 +3676,7 @@ await client.user.warm("userId");
|
|
|
2721
3676
|
</dl>
|
|
2722
3677
|
</details>
|
|
2723
3678
|
|
|
2724
|
-
|
|
2725
|
-
|
|
2726
|
-
<details><summary><code>client.graph.edge.<a href="/src/api/resources/graph/resources/edge/client/Client.ts">getByGraphId</a>(graphId, { ...params }) -> Zep.EntityEdge[]</code></summary>
|
|
3679
|
+
<details><summary><code>client.graph.episode.<a href="/src/api/resources/graph/resources/episode/client/Client.ts">getByUserId</a>(userId, { ...params }) -> Zep.EpisodeResponse</code></summary>
|
|
2727
3680
|
<dl>
|
|
2728
3681
|
<dd>
|
|
2729
3682
|
|
|
@@ -2735,7 +3688,7 @@ await client.user.warm("userId");
|
|
|
2735
3688
|
<dl>
|
|
2736
3689
|
<dd>
|
|
2737
3690
|
|
|
2738
|
-
Returns
|
|
3691
|
+
Returns episodes by user id.
|
|
2739
3692
|
|
|
2740
3693
|
</dd>
|
|
2741
3694
|
</dl>
|
|
@@ -2751,7 +3704,9 @@ Returns all edges for a graph.
|
|
|
2751
3704
|
<dd>
|
|
2752
3705
|
|
|
2753
3706
|
```typescript
|
|
2754
|
-
await client.graph.
|
|
3707
|
+
await client.graph.episode.getByUserId("user_id", {
|
|
3708
|
+
lastn: 1,
|
|
3709
|
+
});
|
|
2755
3710
|
```
|
|
2756
3711
|
|
|
2757
3712
|
</dd>
|
|
@@ -2767,7 +3722,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2767
3722
|
<dl>
|
|
2768
3723
|
<dd>
|
|
2769
3724
|
|
|
2770
|
-
**
|
|
3725
|
+
**userId:** `string` — User ID
|
|
2771
3726
|
|
|
2772
3727
|
</dd>
|
|
2773
3728
|
</dl>
|
|
@@ -2775,7 +3730,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2775
3730
|
<dl>
|
|
2776
3731
|
<dd>
|
|
2777
3732
|
|
|
2778
|
-
**request:** `Zep.
|
|
3733
|
+
**request:** `Zep.graph.EpisodeGetByUserIdRequest`
|
|
2779
3734
|
|
|
2780
3735
|
</dd>
|
|
2781
3736
|
</dl>
|
|
@@ -2783,7 +3738,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2783
3738
|
<dl>
|
|
2784
3739
|
<dd>
|
|
2785
3740
|
|
|
2786
|
-
**requestOptions:** `
|
|
3741
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2787
3742
|
|
|
2788
3743
|
</dd>
|
|
2789
3744
|
</dl>
|
|
@@ -2794,7 +3749,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2794
3749
|
</dl>
|
|
2795
3750
|
</details>
|
|
2796
3751
|
|
|
2797
|
-
<details><summary><code>client.graph.
|
|
3752
|
+
<details><summary><code>client.graph.episode.<a href="/src/api/resources/graph/resources/episode/client/Client.ts">get</a>(uuid) -> Zep.Episode</code></summary>
|
|
2798
3753
|
<dl>
|
|
2799
3754
|
<dd>
|
|
2800
3755
|
|
|
@@ -2806,7 +3761,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2806
3761
|
<dl>
|
|
2807
3762
|
<dd>
|
|
2808
3763
|
|
|
2809
|
-
Returns
|
|
3764
|
+
Returns episodes by UUID
|
|
2810
3765
|
|
|
2811
3766
|
</dd>
|
|
2812
3767
|
</dl>
|
|
@@ -2822,7 +3777,7 @@ Returns all edges for a user.
|
|
|
2822
3777
|
<dd>
|
|
2823
3778
|
|
|
2824
3779
|
```typescript
|
|
2825
|
-
await client.graph.
|
|
3780
|
+
await client.graph.episode.get("uuid");
|
|
2826
3781
|
```
|
|
2827
3782
|
|
|
2828
3783
|
</dd>
|
|
@@ -2838,15 +3793,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2838
3793
|
<dl>
|
|
2839
3794
|
<dd>
|
|
2840
3795
|
|
|
2841
|
-
**
|
|
2842
|
-
|
|
2843
|
-
</dd>
|
|
2844
|
-
</dl>
|
|
2845
|
-
|
|
2846
|
-
<dl>
|
|
2847
|
-
<dd>
|
|
2848
|
-
|
|
2849
|
-
**request:** `Zep.GraphEdgesRequest`
|
|
3796
|
+
**uuid:** `string` — Episode UUID
|
|
2850
3797
|
|
|
2851
3798
|
</dd>
|
|
2852
3799
|
</dl>
|
|
@@ -2854,7 +3801,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2854
3801
|
<dl>
|
|
2855
3802
|
<dd>
|
|
2856
3803
|
|
|
2857
|
-
**requestOptions:** `
|
|
3804
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2858
3805
|
|
|
2859
3806
|
</dd>
|
|
2860
3807
|
</dl>
|
|
@@ -2865,7 +3812,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2865
3812
|
</dl>
|
|
2866
3813
|
</details>
|
|
2867
3814
|
|
|
2868
|
-
<details><summary><code>client.graph.
|
|
3815
|
+
<details><summary><code>client.graph.episode.<a href="/src/api/resources/graph/resources/episode/client/Client.ts">delete</a>(uuid) -> Zep.SuccessResponse</code></summary>
|
|
2869
3816
|
<dl>
|
|
2870
3817
|
<dd>
|
|
2871
3818
|
|
|
@@ -2877,7 +3824,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2877
3824
|
<dl>
|
|
2878
3825
|
<dd>
|
|
2879
3826
|
|
|
2880
|
-
|
|
3827
|
+
Deletes an episode by its UUID.
|
|
2881
3828
|
|
|
2882
3829
|
</dd>
|
|
2883
3830
|
</dl>
|
|
@@ -2893,7 +3840,7 @@ Returns a specific edge by its UUID.
|
|
|
2893
3840
|
<dd>
|
|
2894
3841
|
|
|
2895
3842
|
```typescript
|
|
2896
|
-
await client.graph.
|
|
3843
|
+
await client.graph.episode.delete("uuid");
|
|
2897
3844
|
```
|
|
2898
3845
|
|
|
2899
3846
|
</dd>
|
|
@@ -2909,7 +3856,7 @@ await client.graph.edge.get("uuid");
|
|
|
2909
3856
|
<dl>
|
|
2910
3857
|
<dd>
|
|
2911
3858
|
|
|
2912
|
-
**uuid:** `string` —
|
|
3859
|
+
**uuid:** `string` — Episode UUID
|
|
2913
3860
|
|
|
2914
3861
|
</dd>
|
|
2915
3862
|
</dl>
|
|
@@ -2917,7 +3864,7 @@ await client.graph.edge.get("uuid");
|
|
|
2917
3864
|
<dl>
|
|
2918
3865
|
<dd>
|
|
2919
3866
|
|
|
2920
|
-
**requestOptions:** `
|
|
3867
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2921
3868
|
|
|
2922
3869
|
</dd>
|
|
2923
3870
|
</dl>
|
|
@@ -2928,7 +3875,7 @@ await client.graph.edge.get("uuid");
|
|
|
2928
3875
|
</dl>
|
|
2929
3876
|
</details>
|
|
2930
3877
|
|
|
2931
|
-
<details><summary><code>client.graph.
|
|
3878
|
+
<details><summary><code>client.graph.episode.<a href="/src/api/resources/graph/resources/episode/client/Client.ts">update</a>(uuid, { ...params }) -> Zep.Episode</code></summary>
|
|
2932
3879
|
<dl>
|
|
2933
3880
|
<dd>
|
|
2934
3881
|
|
|
@@ -2940,7 +3887,7 @@ await client.graph.edge.get("uuid");
|
|
|
2940
3887
|
<dl>
|
|
2941
3888
|
<dd>
|
|
2942
3889
|
|
|
2943
|
-
|
|
3890
|
+
Update episode metadata with merge semantics. Supplied keys overwrite or add to existing metadata; keys set to null are removed.
|
|
2944
3891
|
|
|
2945
3892
|
</dd>
|
|
2946
3893
|
</dl>
|
|
@@ -2956,7 +3903,11 @@ Deletes an edge by UUID.
|
|
|
2956
3903
|
<dd>
|
|
2957
3904
|
|
|
2958
3905
|
```typescript
|
|
2959
|
-
await client.graph.
|
|
3906
|
+
await client.graph.episode.update("uuid", {
|
|
3907
|
+
metadata: {
|
|
3908
|
+
key: "value",
|
|
3909
|
+
},
|
|
3910
|
+
});
|
|
2960
3911
|
```
|
|
2961
3912
|
|
|
2962
3913
|
</dd>
|
|
@@ -2972,7 +3923,7 @@ await client.graph.edge.delete("uuid");
|
|
|
2972
3923
|
<dl>
|
|
2973
3924
|
<dd>
|
|
2974
3925
|
|
|
2975
|
-
**uuid:** `string` —
|
|
3926
|
+
**uuid:** `string` — Episode UUID
|
|
2976
3927
|
|
|
2977
3928
|
</dd>
|
|
2978
3929
|
</dl>
|
|
@@ -2980,7 +3931,15 @@ await client.graph.edge.delete("uuid");
|
|
|
2980
3931
|
<dl>
|
|
2981
3932
|
<dd>
|
|
2982
3933
|
|
|
2983
|
-
**
|
|
3934
|
+
**request:** `Zep.graph.UpdateEpisodeRequest`
|
|
3935
|
+
|
|
3936
|
+
</dd>
|
|
3937
|
+
</dl>
|
|
3938
|
+
|
|
3939
|
+
<dl>
|
|
3940
|
+
<dd>
|
|
3941
|
+
|
|
3942
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2984
3943
|
|
|
2985
3944
|
</dd>
|
|
2986
3945
|
</dl>
|
|
@@ -2991,7 +3950,7 @@ await client.graph.edge.delete("uuid");
|
|
|
2991
3950
|
</dl>
|
|
2992
3951
|
</details>
|
|
2993
3952
|
|
|
2994
|
-
<details><summary><code>client.graph.
|
|
3953
|
+
<details><summary><code>client.graph.episode.<a href="/src/api/resources/graph/resources/episode/client/Client.ts">getNodesAndEdges</a>(uuid) -> Zep.EpisodeMentions</code></summary>
|
|
2995
3954
|
<dl>
|
|
2996
3955
|
<dd>
|
|
2997
3956
|
|
|
@@ -3003,7 +3962,7 @@ await client.graph.edge.delete("uuid");
|
|
|
3003
3962
|
<dl>
|
|
3004
3963
|
<dd>
|
|
3005
3964
|
|
|
3006
|
-
|
|
3965
|
+
Returns nodes and edges mentioned in an episode
|
|
3007
3966
|
|
|
3008
3967
|
</dd>
|
|
3009
3968
|
</dl>
|
|
@@ -3019,7 +3978,7 @@ Updates an entity edge by UUID.
|
|
|
3019
3978
|
<dd>
|
|
3020
3979
|
|
|
3021
3980
|
```typescript
|
|
3022
|
-
await client.graph.
|
|
3981
|
+
await client.graph.episode.getNodesAndEdges("uuid");
|
|
3023
3982
|
```
|
|
3024
3983
|
|
|
3025
3984
|
</dd>
|
|
@@ -3035,15 +3994,7 @@ await client.graph.edge.update("uuid");
|
|
|
3035
3994
|
<dl>
|
|
3036
3995
|
<dd>
|
|
3037
3996
|
|
|
3038
|
-
**uuid:** `string` —
|
|
3039
|
-
|
|
3040
|
-
</dd>
|
|
3041
|
-
</dl>
|
|
3042
|
-
|
|
3043
|
-
<dl>
|
|
3044
|
-
<dd>
|
|
3045
|
-
|
|
3046
|
-
**request:** `Zep.graph.UpdateEdgeRequest`
|
|
3997
|
+
**uuid:** `string` — Episode uuid
|
|
3047
3998
|
|
|
3048
3999
|
</dd>
|
|
3049
4000
|
</dl>
|
|
@@ -3051,7 +4002,7 @@ await client.graph.edge.update("uuid");
|
|
|
3051
4002
|
<dl>
|
|
3052
4003
|
<dd>
|
|
3053
4004
|
|
|
3054
|
-
**requestOptions:** `
|
|
4005
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
3055
4006
|
|
|
3056
4007
|
</dd>
|
|
3057
4008
|
</dl>
|
|
@@ -3062,9 +4013,9 @@ await client.graph.edge.update("uuid");
|
|
|
3062
4013
|
</dl>
|
|
3063
4014
|
</details>
|
|
3064
4015
|
|
|
3065
|
-
## Graph
|
|
4016
|
+
## Graph Node
|
|
3066
4017
|
|
|
3067
|
-
<details><summary><code>client.graph.
|
|
4018
|
+
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">getByGraphId</a>(graphId, { ...params }) -> Zep.EntityNode[]</code></summary>
|
|
3068
4019
|
<dl>
|
|
3069
4020
|
<dd>
|
|
3070
4021
|
|
|
@@ -3076,7 +4027,7 @@ await client.graph.edge.update("uuid");
|
|
|
3076
4027
|
<dl>
|
|
3077
4028
|
<dd>
|
|
3078
4029
|
|
|
3079
|
-
Returns
|
|
4030
|
+
Returns all nodes for a graph.
|
|
3080
4031
|
|
|
3081
4032
|
</dd>
|
|
3082
4033
|
</dl>
|
|
@@ -3092,9 +4043,7 @@ Returns episodes by graph id.
|
|
|
3092
4043
|
<dd>
|
|
3093
4044
|
|
|
3094
4045
|
```typescript
|
|
3095
|
-
await client.graph.
|
|
3096
|
-
lastn: 1,
|
|
3097
|
-
});
|
|
4046
|
+
await client.graph.node.getByGraphId("graph_id", {});
|
|
3098
4047
|
```
|
|
3099
4048
|
|
|
3100
4049
|
</dd>
|
|
@@ -3118,7 +4067,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3118
4067
|
<dl>
|
|
3119
4068
|
<dd>
|
|
3120
4069
|
|
|
3121
|
-
**request:** `Zep.
|
|
4070
|
+
**request:** `Zep.GraphNodesRequest`
|
|
3122
4071
|
|
|
3123
4072
|
</dd>
|
|
3124
4073
|
</dl>
|
|
@@ -3126,7 +4075,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3126
4075
|
<dl>
|
|
3127
4076
|
<dd>
|
|
3128
4077
|
|
|
3129
|
-
**requestOptions:** `
|
|
4078
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3130
4079
|
|
|
3131
4080
|
</dd>
|
|
3132
4081
|
</dl>
|
|
@@ -3137,7 +4086,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3137
4086
|
</dl>
|
|
3138
4087
|
</details>
|
|
3139
4088
|
|
|
3140
|
-
<details><summary><code>client.graph.
|
|
4089
|
+
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">getByUserId</a>(userId, { ...params }) -> Zep.EntityNode[]</code></summary>
|
|
3141
4090
|
<dl>
|
|
3142
4091
|
<dd>
|
|
3143
4092
|
|
|
@@ -3149,7 +4098,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3149
4098
|
<dl>
|
|
3150
4099
|
<dd>
|
|
3151
4100
|
|
|
3152
|
-
Returns
|
|
4101
|
+
Returns all nodes for a user
|
|
3153
4102
|
|
|
3154
4103
|
</dd>
|
|
3155
4104
|
</dl>
|
|
@@ -3165,9 +4114,7 @@ Returns episodes by user id.
|
|
|
3165
4114
|
<dd>
|
|
3166
4115
|
|
|
3167
4116
|
```typescript
|
|
3168
|
-
await client.graph.
|
|
3169
|
-
lastn: 1,
|
|
3170
|
-
});
|
|
4117
|
+
await client.graph.node.getByUserId("user_id", {});
|
|
3171
4118
|
```
|
|
3172
4119
|
|
|
3173
4120
|
</dd>
|
|
@@ -3191,7 +4138,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3191
4138
|
<dl>
|
|
3192
4139
|
<dd>
|
|
3193
4140
|
|
|
3194
|
-
**request:** `Zep.
|
|
4141
|
+
**request:** `Zep.GraphNodesRequest`
|
|
3195
4142
|
|
|
3196
4143
|
</dd>
|
|
3197
4144
|
</dl>
|
|
@@ -3199,7 +4146,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3199
4146
|
<dl>
|
|
3200
4147
|
<dd>
|
|
3201
4148
|
|
|
3202
|
-
**requestOptions:** `
|
|
4149
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3203
4150
|
|
|
3204
4151
|
</dd>
|
|
3205
4152
|
</dl>
|
|
@@ -3210,7 +4157,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3210
4157
|
</dl>
|
|
3211
4158
|
</details>
|
|
3212
4159
|
|
|
3213
|
-
<details><summary><code>client.graph.
|
|
4160
|
+
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">getEdges</a>(nodeUuid) -> Zep.EntityEdge[]</code></summary>
|
|
3214
4161
|
<dl>
|
|
3215
4162
|
<dd>
|
|
3216
4163
|
|
|
@@ -3222,7 +4169,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3222
4169
|
<dl>
|
|
3223
4170
|
<dd>
|
|
3224
4171
|
|
|
3225
|
-
Returns
|
|
4172
|
+
Returns all edges for a node
|
|
3226
4173
|
|
|
3227
4174
|
</dd>
|
|
3228
4175
|
</dl>
|
|
@@ -3238,7 +4185,7 @@ Returns episodes by UUID
|
|
|
3238
4185
|
<dd>
|
|
3239
4186
|
|
|
3240
4187
|
```typescript
|
|
3241
|
-
await client.graph.
|
|
4188
|
+
await client.graph.node.getEdges("node_uuid");
|
|
3242
4189
|
```
|
|
3243
4190
|
|
|
3244
4191
|
</dd>
|
|
@@ -3254,7 +4201,7 @@ await client.graph.episode.get("uuid");
|
|
|
3254
4201
|
<dl>
|
|
3255
4202
|
<dd>
|
|
3256
4203
|
|
|
3257
|
-
**
|
|
4204
|
+
**nodeUuid:** `string` — Node UUID
|
|
3258
4205
|
|
|
3259
4206
|
</dd>
|
|
3260
4207
|
</dl>
|
|
@@ -3262,7 +4209,7 @@ await client.graph.episode.get("uuid");
|
|
|
3262
4209
|
<dl>
|
|
3263
4210
|
<dd>
|
|
3264
4211
|
|
|
3265
|
-
**requestOptions:** `
|
|
4212
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3266
4213
|
|
|
3267
4214
|
</dd>
|
|
3268
4215
|
</dl>
|
|
@@ -3273,7 +4220,7 @@ await client.graph.episode.get("uuid");
|
|
|
3273
4220
|
</dl>
|
|
3274
4221
|
</details>
|
|
3275
4222
|
|
|
3276
|
-
<details><summary><code>client.graph.
|
|
4223
|
+
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">getEpisodes</a>(nodeUuid) -> Zep.EpisodeResponse</code></summary>
|
|
3277
4224
|
<dl>
|
|
3278
4225
|
<dd>
|
|
3279
4226
|
|
|
@@ -3285,7 +4232,7 @@ await client.graph.episode.get("uuid");
|
|
|
3285
4232
|
<dl>
|
|
3286
4233
|
<dd>
|
|
3287
4234
|
|
|
3288
|
-
|
|
4235
|
+
Returns all episodes that mentioned a given node
|
|
3289
4236
|
|
|
3290
4237
|
</dd>
|
|
3291
4238
|
</dl>
|
|
@@ -3301,7 +4248,7 @@ Deletes an episode by its UUID.
|
|
|
3301
4248
|
<dd>
|
|
3302
4249
|
|
|
3303
4250
|
```typescript
|
|
3304
|
-
await client.graph.
|
|
4251
|
+
await client.graph.node.getEpisodes("node_uuid");
|
|
3305
4252
|
```
|
|
3306
4253
|
|
|
3307
4254
|
</dd>
|
|
@@ -3317,7 +4264,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3317
4264
|
<dl>
|
|
3318
4265
|
<dd>
|
|
3319
4266
|
|
|
3320
|
-
**
|
|
4267
|
+
**nodeUuid:** `string` — Node UUID
|
|
3321
4268
|
|
|
3322
4269
|
</dd>
|
|
3323
4270
|
</dl>
|
|
@@ -3325,7 +4272,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3325
4272
|
<dl>
|
|
3326
4273
|
<dd>
|
|
3327
4274
|
|
|
3328
|
-
**requestOptions:** `
|
|
4275
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3329
4276
|
|
|
3330
4277
|
</dd>
|
|
3331
4278
|
</dl>
|
|
@@ -3336,7 +4283,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3336
4283
|
</dl>
|
|
3337
4284
|
</details>
|
|
3338
4285
|
|
|
3339
|
-
<details><summary><code>client.graph.
|
|
4286
|
+
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">get</a>(uuid) -> Zep.EntityNode</code></summary>
|
|
3340
4287
|
<dl>
|
|
3341
4288
|
<dd>
|
|
3342
4289
|
|
|
@@ -3348,7 +4295,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3348
4295
|
<dl>
|
|
3349
4296
|
<dd>
|
|
3350
4297
|
|
|
3351
|
-
Returns
|
|
4298
|
+
Returns a specific node by its UUID.
|
|
3352
4299
|
|
|
3353
4300
|
</dd>
|
|
3354
4301
|
</dl>
|
|
@@ -3364,7 +4311,7 @@ Returns nodes and edges mentioned in an episode
|
|
|
3364
4311
|
<dd>
|
|
3365
4312
|
|
|
3366
4313
|
```typescript
|
|
3367
|
-
await client.graph.
|
|
4314
|
+
await client.graph.node.get("uuid");
|
|
3368
4315
|
```
|
|
3369
4316
|
|
|
3370
4317
|
</dd>
|
|
@@ -3380,7 +4327,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3380
4327
|
<dl>
|
|
3381
4328
|
<dd>
|
|
3382
4329
|
|
|
3383
|
-
**uuid:** `string` —
|
|
4330
|
+
**uuid:** `string` — Node UUID
|
|
3384
4331
|
|
|
3385
4332
|
</dd>
|
|
3386
4333
|
</dl>
|
|
@@ -3388,7 +4335,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3388
4335
|
<dl>
|
|
3389
4336
|
<dd>
|
|
3390
4337
|
|
|
3391
|
-
**requestOptions:** `
|
|
4338
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3392
4339
|
|
|
3393
4340
|
</dd>
|
|
3394
4341
|
</dl>
|
|
@@ -3399,9 +4346,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3399
4346
|
</dl>
|
|
3400
4347
|
</details>
|
|
3401
4348
|
|
|
3402
|
-
|
|
3403
|
-
|
|
3404
|
-
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">getByGraphId</a>(graphId, { ...params }) -> Zep.EntityNode[]</code></summary>
|
|
4349
|
+
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">delete</a>(uuid) -> Zep.SuccessResponse</code></summary>
|
|
3405
4350
|
<dl>
|
|
3406
4351
|
<dd>
|
|
3407
4352
|
|
|
@@ -3413,7 +4358,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3413
4358
|
<dl>
|
|
3414
4359
|
<dd>
|
|
3415
4360
|
|
|
3416
|
-
|
|
4361
|
+
Deletes a node by UUID.
|
|
3417
4362
|
|
|
3418
4363
|
</dd>
|
|
3419
4364
|
</dl>
|
|
@@ -3429,7 +4374,7 @@ Returns all nodes for a graph.
|
|
|
3429
4374
|
<dd>
|
|
3430
4375
|
|
|
3431
4376
|
```typescript
|
|
3432
|
-
await client.graph.node.
|
|
4377
|
+
await client.graph.node.delete("uuid");
|
|
3433
4378
|
```
|
|
3434
4379
|
|
|
3435
4380
|
</dd>
|
|
@@ -3445,15 +4390,7 @@ await client.graph.node.getByGraphId("graph_id", {});
|
|
|
3445
4390
|
<dl>
|
|
3446
4391
|
<dd>
|
|
3447
4392
|
|
|
3448
|
-
**
|
|
3449
|
-
|
|
3450
|
-
</dd>
|
|
3451
|
-
</dl>
|
|
3452
|
-
|
|
3453
|
-
<dl>
|
|
3454
|
-
<dd>
|
|
3455
|
-
|
|
3456
|
-
**request:** `Zep.GraphNodesRequest`
|
|
4393
|
+
**uuid:** `string` — Node UUID
|
|
3457
4394
|
|
|
3458
4395
|
</dd>
|
|
3459
4396
|
</dl>
|
|
@@ -3472,7 +4409,7 @@ await client.graph.node.getByGraphId("graph_id", {});
|
|
|
3472
4409
|
</dl>
|
|
3473
4410
|
</details>
|
|
3474
4411
|
|
|
3475
|
-
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">
|
|
4412
|
+
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">update</a>(uuid, { ...params }) -> Zep.EntityNode</code></summary>
|
|
3476
4413
|
<dl>
|
|
3477
4414
|
<dd>
|
|
3478
4415
|
|
|
@@ -3484,7 +4421,7 @@ await client.graph.node.getByGraphId("graph_id", {});
|
|
|
3484
4421
|
<dl>
|
|
3485
4422
|
<dd>
|
|
3486
4423
|
|
|
3487
|
-
|
|
4424
|
+
Updates an entity node by UUID.
|
|
3488
4425
|
|
|
3489
4426
|
</dd>
|
|
3490
4427
|
</dl>
|
|
@@ -3500,7 +4437,7 @@ Returns all nodes for a user
|
|
|
3500
4437
|
<dd>
|
|
3501
4438
|
|
|
3502
4439
|
```typescript
|
|
3503
|
-
await client.graph.node.
|
|
4440
|
+
await client.graph.node.update("uuid");
|
|
3504
4441
|
```
|
|
3505
4442
|
|
|
3506
4443
|
</dd>
|
|
@@ -3516,7 +4453,7 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3516
4453
|
<dl>
|
|
3517
4454
|
<dd>
|
|
3518
4455
|
|
|
3519
|
-
**
|
|
4456
|
+
**uuid:** `string` — Node UUID
|
|
3520
4457
|
|
|
3521
4458
|
</dd>
|
|
3522
4459
|
</dl>
|
|
@@ -3524,7 +4461,7 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3524
4461
|
<dl>
|
|
3525
4462
|
<dd>
|
|
3526
4463
|
|
|
3527
|
-
**request:** `Zep.
|
|
4464
|
+
**request:** `Zep.graph.UpdateNodeRequest`
|
|
3528
4465
|
|
|
3529
4466
|
</dd>
|
|
3530
4467
|
</dl>
|
|
@@ -3543,7 +4480,9 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3543
4480
|
</dl>
|
|
3544
4481
|
</details>
|
|
3545
4482
|
|
|
3546
|
-
|
|
4483
|
+
## Graph Observation
|
|
4484
|
+
|
|
4485
|
+
<details><summary><code>client.graph.observation.<a href="/src/api/resources/graph/resources/observation/client/Client.ts">getByGraphId</a>(graphId, { ...params }) -> Zep.DerivedNode[]</code></summary>
|
|
3547
4486
|
<dl>
|
|
3548
4487
|
<dd>
|
|
3549
4488
|
|
|
@@ -3555,7 +4494,7 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3555
4494
|
<dl>
|
|
3556
4495
|
<dd>
|
|
3557
4496
|
|
|
3558
|
-
Returns
|
|
4497
|
+
Returns read-only observation nodes for a graph.
|
|
3559
4498
|
|
|
3560
4499
|
</dd>
|
|
3561
4500
|
</dl>
|
|
@@ -3571,7 +4510,7 @@ Returns all edges for a node
|
|
|
3571
4510
|
<dd>
|
|
3572
4511
|
|
|
3573
4512
|
```typescript
|
|
3574
|
-
await client.graph.
|
|
4513
|
+
await client.graph.observation.getByGraphId("graph_id", {});
|
|
3575
4514
|
```
|
|
3576
4515
|
|
|
3577
4516
|
</dd>
|
|
@@ -3587,7 +4526,7 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3587
4526
|
<dl>
|
|
3588
4527
|
<dd>
|
|
3589
4528
|
|
|
3590
|
-
**
|
|
4529
|
+
**graphId:** `string` — Graph ID
|
|
3591
4530
|
|
|
3592
4531
|
</dd>
|
|
3593
4532
|
</dl>
|
|
@@ -3595,7 +4534,15 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3595
4534
|
<dl>
|
|
3596
4535
|
<dd>
|
|
3597
4536
|
|
|
3598
|
-
**
|
|
4537
|
+
**request:** `Zep.GraphObservationsRequest`
|
|
4538
|
+
|
|
4539
|
+
</dd>
|
|
4540
|
+
</dl>
|
|
4541
|
+
|
|
4542
|
+
<dl>
|
|
4543
|
+
<dd>
|
|
4544
|
+
|
|
4545
|
+
**requestOptions:** `Observation.RequestOptions`
|
|
3599
4546
|
|
|
3600
4547
|
</dd>
|
|
3601
4548
|
</dl>
|
|
@@ -3606,7 +4553,7 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3606
4553
|
</dl>
|
|
3607
4554
|
</details>
|
|
3608
4555
|
|
|
3609
|
-
<details><summary><code>client.graph.
|
|
4556
|
+
<details><summary><code>client.graph.observation.<a href="/src/api/resources/graph/resources/observation/client/Client.ts">getByUserId</a>(userId, { ...params }) -> Zep.DerivedNode[]</code></summary>
|
|
3610
4557
|
<dl>
|
|
3611
4558
|
<dd>
|
|
3612
4559
|
|
|
@@ -3618,7 +4565,7 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3618
4565
|
<dl>
|
|
3619
4566
|
<dd>
|
|
3620
4567
|
|
|
3621
|
-
Returns
|
|
4568
|
+
Returns read-only observation nodes for a user's graph.
|
|
3622
4569
|
|
|
3623
4570
|
</dd>
|
|
3624
4571
|
</dl>
|
|
@@ -3634,7 +4581,7 @@ Returns all episodes that mentioned a given node
|
|
|
3634
4581
|
<dd>
|
|
3635
4582
|
|
|
3636
4583
|
```typescript
|
|
3637
|
-
await client.graph.
|
|
4584
|
+
await client.graph.observation.getByUserId("user_id", {});
|
|
3638
4585
|
```
|
|
3639
4586
|
|
|
3640
4587
|
</dd>
|
|
@@ -3650,7 +4597,7 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3650
4597
|
<dl>
|
|
3651
4598
|
<dd>
|
|
3652
4599
|
|
|
3653
|
-
**
|
|
4600
|
+
**userId:** `string` — User ID
|
|
3654
4601
|
|
|
3655
4602
|
</dd>
|
|
3656
4603
|
</dl>
|
|
@@ -3658,7 +4605,15 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3658
4605
|
<dl>
|
|
3659
4606
|
<dd>
|
|
3660
4607
|
|
|
3661
|
-
**
|
|
4608
|
+
**request:** `Zep.GraphObservationsRequest`
|
|
4609
|
+
|
|
4610
|
+
</dd>
|
|
4611
|
+
</dl>
|
|
4612
|
+
|
|
4613
|
+
<dl>
|
|
4614
|
+
<dd>
|
|
4615
|
+
|
|
4616
|
+
**requestOptions:** `Observation.RequestOptions`
|
|
3662
4617
|
|
|
3663
4618
|
</dd>
|
|
3664
4619
|
</dl>
|
|
@@ -3669,7 +4624,7 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3669
4624
|
</dl>
|
|
3670
4625
|
</details>
|
|
3671
4626
|
|
|
3672
|
-
<details><summary><code>client.graph.
|
|
4627
|
+
<details><summary><code>client.graph.observation.<a href="/src/api/resources/graph/resources/observation/client/Client.ts">get</a>(uuid) -> Zep.DerivedNode</code></summary>
|
|
3673
4628
|
<dl>
|
|
3674
4629
|
<dd>
|
|
3675
4630
|
|
|
@@ -3681,7 +4636,7 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3681
4636
|
<dl>
|
|
3682
4637
|
<dd>
|
|
3683
4638
|
|
|
3684
|
-
Returns a specific node by
|
|
4639
|
+
Returns a specific observation node by UUID. Observation nodes are read-only.
|
|
3685
4640
|
|
|
3686
4641
|
</dd>
|
|
3687
4642
|
</dl>
|
|
@@ -3697,7 +4652,7 @@ Returns a specific node by its UUID.
|
|
|
3697
4652
|
<dd>
|
|
3698
4653
|
|
|
3699
4654
|
```typescript
|
|
3700
|
-
await client.graph.
|
|
4655
|
+
await client.graph.observation.get("uuid");
|
|
3701
4656
|
```
|
|
3702
4657
|
|
|
3703
4658
|
</dd>
|
|
@@ -3713,7 +4668,7 @@ await client.graph.node.get("uuid");
|
|
|
3713
4668
|
<dl>
|
|
3714
4669
|
<dd>
|
|
3715
4670
|
|
|
3716
|
-
**uuid:** `string` —
|
|
4671
|
+
**uuid:** `string` — Observation UUID
|
|
3717
4672
|
|
|
3718
4673
|
</dd>
|
|
3719
4674
|
</dl>
|
|
@@ -3721,7 +4676,7 @@ await client.graph.node.get("uuid");
|
|
|
3721
4676
|
<dl>
|
|
3722
4677
|
<dd>
|
|
3723
4678
|
|
|
3724
|
-
**requestOptions:** `
|
|
4679
|
+
**requestOptions:** `Observation.RequestOptions`
|
|
3725
4680
|
|
|
3726
4681
|
</dd>
|
|
3727
4682
|
</dl>
|
|
@@ -3732,7 +4687,9 @@ await client.graph.node.get("uuid");
|
|
|
3732
4687
|
</dl>
|
|
3733
4688
|
</details>
|
|
3734
4689
|
|
|
3735
|
-
|
|
4690
|
+
## Graph ThreadSummary
|
|
4691
|
+
|
|
4692
|
+
<details><summary><code>client.graph.threadSummary.<a href="/src/api/resources/graph/resources/threadSummary/client/Client.ts">getByGraphId</a>(graphId, { ...params }) -> Zep.ThreadSummary[]</code></summary>
|
|
3736
4693
|
<dl>
|
|
3737
4694
|
<dd>
|
|
3738
4695
|
|
|
@@ -3744,7 +4701,7 @@ await client.graph.node.get("uuid");
|
|
|
3744
4701
|
<dl>
|
|
3745
4702
|
<dd>
|
|
3746
4703
|
|
|
3747
|
-
|
|
4704
|
+
Returns incremental thread summaries associated with the graph.
|
|
3748
4705
|
|
|
3749
4706
|
</dd>
|
|
3750
4707
|
</dl>
|
|
@@ -3760,7 +4717,7 @@ Deletes a node by UUID.
|
|
|
3760
4717
|
<dd>
|
|
3761
4718
|
|
|
3762
4719
|
```typescript
|
|
3763
|
-
await client.graph.
|
|
4720
|
+
await client.graph.threadSummary.getByGraphId("graph_id", {});
|
|
3764
4721
|
```
|
|
3765
4722
|
|
|
3766
4723
|
</dd>
|
|
@@ -3776,7 +4733,7 @@ await client.graph.node.delete("uuid");
|
|
|
3776
4733
|
<dl>
|
|
3777
4734
|
<dd>
|
|
3778
4735
|
|
|
3779
|
-
**
|
|
4736
|
+
**graphId:** `string` — Graph ID
|
|
3780
4737
|
|
|
3781
4738
|
</dd>
|
|
3782
4739
|
</dl>
|
|
@@ -3784,7 +4741,15 @@ await client.graph.node.delete("uuid");
|
|
|
3784
4741
|
<dl>
|
|
3785
4742
|
<dd>
|
|
3786
4743
|
|
|
3787
|
-
**
|
|
4744
|
+
**request:** `Zep.GraphThreadSummariesRequest`
|
|
4745
|
+
|
|
4746
|
+
</dd>
|
|
4747
|
+
</dl>
|
|
4748
|
+
|
|
4749
|
+
<dl>
|
|
4750
|
+
<dd>
|
|
4751
|
+
|
|
4752
|
+
**requestOptions:** `ThreadSummary.RequestOptions`
|
|
3788
4753
|
|
|
3789
4754
|
</dd>
|
|
3790
4755
|
</dl>
|
|
@@ -3795,7 +4760,7 @@ await client.graph.node.delete("uuid");
|
|
|
3795
4760
|
</dl>
|
|
3796
4761
|
</details>
|
|
3797
4762
|
|
|
3798
|
-
<details><summary><code>client.graph.
|
|
4763
|
+
<details><summary><code>client.graph.threadSummary.<a href="/src/api/resources/graph/resources/threadSummary/client/Client.ts">getByUserId</a>(userId, { ...params }) -> Zep.ThreadSummary[]</code></summary>
|
|
3799
4764
|
<dl>
|
|
3800
4765
|
<dd>
|
|
3801
4766
|
|
|
@@ -3807,7 +4772,7 @@ await client.graph.node.delete("uuid");
|
|
|
3807
4772
|
<dl>
|
|
3808
4773
|
<dd>
|
|
3809
4774
|
|
|
3810
|
-
|
|
4775
|
+
Returns incremental thread summaries generated from messages in each thread associated with the user's graph.
|
|
3811
4776
|
|
|
3812
4777
|
</dd>
|
|
3813
4778
|
</dl>
|
|
@@ -3823,7 +4788,7 @@ Updates an entity node by UUID.
|
|
|
3823
4788
|
<dd>
|
|
3824
4789
|
|
|
3825
4790
|
```typescript
|
|
3826
|
-
await client.graph.
|
|
4791
|
+
await client.graph.threadSummary.getByUserId("user_id", {});
|
|
3827
4792
|
```
|
|
3828
4793
|
|
|
3829
4794
|
</dd>
|
|
@@ -3839,7 +4804,7 @@ await client.graph.node.update("uuid");
|
|
|
3839
4804
|
<dl>
|
|
3840
4805
|
<dd>
|
|
3841
4806
|
|
|
3842
|
-
**
|
|
4807
|
+
**userId:** `string` — User ID
|
|
3843
4808
|
|
|
3844
4809
|
</dd>
|
|
3845
4810
|
</dl>
|
|
@@ -3847,7 +4812,7 @@ await client.graph.node.update("uuid");
|
|
|
3847
4812
|
<dl>
|
|
3848
4813
|
<dd>
|
|
3849
4814
|
|
|
3850
|
-
**request:** `Zep.
|
|
4815
|
+
**request:** `Zep.GraphThreadSummariesRequest`
|
|
3851
4816
|
|
|
3852
4817
|
</dd>
|
|
3853
4818
|
</dl>
|
|
@@ -3855,7 +4820,7 @@ await client.graph.node.update("uuid");
|
|
|
3855
4820
|
<dl>
|
|
3856
4821
|
<dd>
|
|
3857
4822
|
|
|
3858
|
-
**requestOptions:** `
|
|
4823
|
+
**requestOptions:** `ThreadSummary.RequestOptions`
|
|
3859
4824
|
|
|
3860
4825
|
</dd>
|
|
3861
4826
|
</dl>
|