@getzep/zep-cloud 3.18.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/ApidataAddBatchItemsRequest.js +5 -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 +7 -0
- package/dist/cjs/api/resources/graph/client/Client.js +30 -106
- 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/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.js +6 -42
- 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/DerivedNode.d.ts +28 -0
- package/dist/cjs/api/types/DerivedNode.js +5 -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 +17 -3
- package/dist/cjs/api/types/PatternSeeds.d.ts +1 -1
- package/dist/cjs/api/types/SearchFilters.d.ts +6 -1
- 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 -0
- package/dist/cjs/api/types/index.js +19 -0
- 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/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/BatchListResponse.js +45 -0
- 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/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 +1 -0
- package/dist/cjs/serialization/types/PatternResult.js +1 -0
- 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 -0
- package/dist/cjs/serialization/types/index.js +19 -0
- 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/ApidataAddBatchItemsRequest.mjs +4 -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 +7 -0
- package/dist/esm/api/resources/graph/client/Client.mjs +30 -106
- 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/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.mjs +6 -42
- 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/DerivedNode.d.mts +28 -0
- package/dist/esm/api/types/DerivedNode.mjs +4 -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 +17 -3
- package/dist/esm/api/types/PatternSeeds.d.mts +1 -1
- package/dist/esm/api/types/SearchFilters.d.mts +6 -1
- 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 -0
- package/dist/esm/api/types/index.mjs +19 -0
- 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/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/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 +1 -0
- package/dist/esm/serialization/types/PatternResult.mjs +1 -0
- 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 -0
- package/dist/esm/serialization/types/index.mjs +19 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +16 -9
- package/reference.md +1421 -458
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,10 +1074,7 @@ await client.graph.listAll({
|
|
|
1062
1074
|
<dl>
|
|
1063
1075
|
<dd>
|
|
1064
1076
|
|
|
1065
|
-
|
|
1066
|
-
multi-hop paths, co-occurrences, hubs, and clusters.
|
|
1067
|
-
When a query is provided, uses hybrid search to discover seed nodes,
|
|
1068
|
-
detects triple-frequency patterns, and returns resolved edges ranked by relevance.
|
|
1077
|
+
Sets the entity types for multiple users and graphs, replacing any existing ones.
|
|
1069
1078
|
|
|
1070
1079
|
</dd>
|
|
1071
1080
|
</dl>
|
|
@@ -1081,7 +1090,7 @@ detects triple-frequency patterns, and returns resolved edges ranked by relevanc
|
|
|
1081
1090
|
<dd>
|
|
1082
1091
|
|
|
1083
1092
|
```typescript
|
|
1084
|
-
await client.graph.
|
|
1093
|
+
await client.graph.setEntityTypesInternal();
|
|
1085
1094
|
```
|
|
1086
1095
|
|
|
1087
1096
|
</dd>
|
|
@@ -1097,7 +1106,7 @@ await client.graph.detectPatterns();
|
|
|
1097
1106
|
<dl>
|
|
1098
1107
|
<dd>
|
|
1099
1108
|
|
|
1100
|
-
**request:** `Zep.
|
|
1109
|
+
**request:** `Zep.EntityTypeRequest`
|
|
1101
1110
|
|
|
1102
1111
|
</dd>
|
|
1103
1112
|
</dl>
|
|
@@ -1116,7 +1125,7 @@ await client.graph.detectPatterns();
|
|
|
1116
1125
|
</dl>
|
|
1117
1126
|
</details>
|
|
1118
1127
|
|
|
1119
|
-
<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>
|
|
1120
1129
|
<dl>
|
|
1121
1130
|
<dd>
|
|
1122
1131
|
|
|
@@ -1128,7 +1137,7 @@ await client.graph.detectPatterns();
|
|
|
1128
1137
|
<dl>
|
|
1129
1138
|
<dd>
|
|
1130
1139
|
|
|
1131
|
-
|
|
1140
|
+
Add data to the graph.
|
|
1132
1141
|
|
|
1133
1142
|
</dd>
|
|
1134
1143
|
</dl>
|
|
@@ -1144,8 +1153,9 @@ Perform a graph search query.
|
|
|
1144
1153
|
<dd>
|
|
1145
1154
|
|
|
1146
1155
|
```typescript
|
|
1147
|
-
await client.graph.
|
|
1148
|
-
|
|
1156
|
+
await client.graph.add({
|
|
1157
|
+
data: "data",
|
|
1158
|
+
type: "text",
|
|
1149
1159
|
});
|
|
1150
1160
|
```
|
|
1151
1161
|
|
|
@@ -1162,7 +1172,7 @@ await client.graph.search({
|
|
|
1162
1172
|
<dl>
|
|
1163
1173
|
<dd>
|
|
1164
1174
|
|
|
1165
|
-
**request:** `Zep.
|
|
1175
|
+
**request:** `Zep.AddDataRequest`
|
|
1166
1176
|
|
|
1167
1177
|
</dd>
|
|
1168
1178
|
</dl>
|
|
@@ -1181,7 +1191,7 @@ await client.graph.search({
|
|
|
1181
1191
|
</dl>
|
|
1182
1192
|
</details>
|
|
1183
1193
|
|
|
1184
|
-
<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>
|
|
1185
1195
|
<dl>
|
|
1186
1196
|
<dd>
|
|
1187
1197
|
|
|
@@ -1193,7 +1203,7 @@ await client.graph.search({
|
|
|
1193
1203
|
<dl>
|
|
1194
1204
|
<dd>
|
|
1195
1205
|
|
|
1196
|
-
|
|
1206
|
+
Add data to the graph in batch mode. Episodes are processed sequentially in the order provided.
|
|
1197
1207
|
|
|
1198
1208
|
</dd>
|
|
1199
1209
|
</dl>
|
|
@@ -1209,14 +1219,21 @@ Returns a graph.
|
|
|
1209
1219
|
<dd>
|
|
1210
1220
|
|
|
1211
1221
|
```typescript
|
|
1212
|
-
await client.graph.
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1222
|
+
await client.graph.addBatch({
|
|
1223
|
+
episodes: [
|
|
1224
|
+
{
|
|
1225
|
+
data: "data",
|
|
1226
|
+
type: "text",
|
|
1227
|
+
},
|
|
1228
|
+
],
|
|
1229
|
+
});
|
|
1230
|
+
```
|
|
1231
|
+
|
|
1232
|
+
</dd>
|
|
1233
|
+
</dl>
|
|
1234
|
+
</dd>
|
|
1235
|
+
</dl>
|
|
1236
|
+
|
|
1220
1237
|
#### ⚙️ Parameters
|
|
1221
1238
|
|
|
1222
1239
|
<dl>
|
|
@@ -1225,7 +1242,7 @@ await client.graph.get("graphId");
|
|
|
1225
1242
|
<dl>
|
|
1226
1243
|
<dd>
|
|
1227
1244
|
|
|
1228
|
-
**
|
|
1245
|
+
**request:** `Zep.AddDataBatchRequest`
|
|
1229
1246
|
|
|
1230
1247
|
</dd>
|
|
1231
1248
|
</dl>
|
|
@@ -1244,7 +1261,7 @@ await client.graph.get("graphId");
|
|
|
1244
1261
|
</dl>
|
|
1245
1262
|
</details>
|
|
1246
1263
|
|
|
1247
|
-
<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>
|
|
1248
1265
|
<dl>
|
|
1249
1266
|
<dd>
|
|
1250
1267
|
|
|
@@ -1256,7 +1273,7 @@ await client.graph.get("graphId");
|
|
|
1256
1273
|
<dl>
|
|
1257
1274
|
<dd>
|
|
1258
1275
|
|
|
1259
|
-
|
|
1276
|
+
Add a fact triple for a user or group
|
|
1260
1277
|
|
|
1261
1278
|
</dd>
|
|
1262
1279
|
</dl>
|
|
@@ -1272,7 +1289,10 @@ Deletes a graph. If you would like to delete a user graph, make sure to use user
|
|
|
1272
1289
|
<dd>
|
|
1273
1290
|
|
|
1274
1291
|
```typescript
|
|
1275
|
-
await client.graph.
|
|
1292
|
+
await client.graph.addFactTriple({
|
|
1293
|
+
fact: "fact",
|
|
1294
|
+
factName: "fact_name",
|
|
1295
|
+
});
|
|
1276
1296
|
```
|
|
1277
1297
|
|
|
1278
1298
|
</dd>
|
|
@@ -1288,7 +1308,7 @@ await client.graph.delete("graphId");
|
|
|
1288
1308
|
<dl>
|
|
1289
1309
|
<dd>
|
|
1290
1310
|
|
|
1291
|
-
**
|
|
1311
|
+
**request:** `Zep.AddTripleRequest`
|
|
1292
1312
|
|
|
1293
1313
|
</dd>
|
|
1294
1314
|
</dl>
|
|
@@ -1307,7 +1327,7 @@ await client.graph.delete("graphId");
|
|
|
1307
1327
|
</dl>
|
|
1308
1328
|
</details>
|
|
1309
1329
|
|
|
1310
|
-
<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>
|
|
1311
1331
|
<dl>
|
|
1312
1332
|
<dd>
|
|
1313
1333
|
|
|
@@ -1319,7 +1339,7 @@ await client.graph.delete("graphId");
|
|
|
1319
1339
|
<dl>
|
|
1320
1340
|
<dd>
|
|
1321
1341
|
|
|
1322
|
-
|
|
1342
|
+
Clone a user or group graph.
|
|
1323
1343
|
|
|
1324
1344
|
</dd>
|
|
1325
1345
|
</dl>
|
|
@@ -1335,7 +1355,7 @@ Updates information about a graph.
|
|
|
1335
1355
|
<dd>
|
|
1336
1356
|
|
|
1337
1357
|
```typescript
|
|
1338
|
-
await client.graph.
|
|
1358
|
+
await client.graph.clone();
|
|
1339
1359
|
```
|
|
1340
1360
|
|
|
1341
1361
|
</dd>
|
|
@@ -1351,7 +1371,7 @@ await client.graph.update("graphId");
|
|
|
1351
1371
|
<dl>
|
|
1352
1372
|
<dd>
|
|
1353
1373
|
|
|
1354
|
-
**
|
|
1374
|
+
**request:** `Zep.CloneGraphRequest`
|
|
1355
1375
|
|
|
1356
1376
|
</dd>
|
|
1357
1377
|
</dl>
|
|
@@ -1359,7 +1379,64 @@ await client.graph.update("graphId");
|
|
|
1359
1379
|
<dl>
|
|
1360
1380
|
<dd>
|
|
1361
1381
|
|
|
1362
|
-
**
|
|
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`
|
|
1363
1440
|
|
|
1364
1441
|
</dd>
|
|
1365
1442
|
</dl>
|
|
@@ -1378,9 +1455,7 @@ await client.graph.update("graphId");
|
|
|
1378
1455
|
</dl>
|
|
1379
1456
|
</details>
|
|
1380
1457
|
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
<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>
|
|
1384
1459
|
<dl>
|
|
1385
1460
|
<dd>
|
|
1386
1461
|
|
|
@@ -1392,7 +1467,7 @@ await client.graph.update("graphId");
|
|
|
1392
1467
|
<dl>
|
|
1393
1468
|
<dd>
|
|
1394
1469
|
|
|
1395
|
-
|
|
1470
|
+
Returns all graphs. In order to list users, use user.list_ordered instead
|
|
1396
1471
|
|
|
1397
1472
|
</dd>
|
|
1398
1473
|
</dl>
|
|
@@ -1408,7 +1483,13 @@ Retrieve project info based on the provided api key.
|
|
|
1408
1483
|
<dd>
|
|
1409
1484
|
|
|
1410
1485
|
```typescript
|
|
1411
|
-
await client.
|
|
1486
|
+
await client.graph.listAll({
|
|
1487
|
+
pageNumber: 1,
|
|
1488
|
+
pageSize: 1,
|
|
1489
|
+
search: "search",
|
|
1490
|
+
orderBy: "order_by",
|
|
1491
|
+
asc: true,
|
|
1492
|
+
});
|
|
1412
1493
|
```
|
|
1413
1494
|
|
|
1414
1495
|
</dd>
|
|
@@ -1424,7 +1505,15 @@ await client.project.get();
|
|
|
1424
1505
|
<dl>
|
|
1425
1506
|
<dd>
|
|
1426
1507
|
|
|
1427
|
-
**
|
|
1508
|
+
**request:** `Zep.GraphListAllRequest`
|
|
1509
|
+
|
|
1510
|
+
</dd>
|
|
1511
|
+
</dl>
|
|
1512
|
+
|
|
1513
|
+
<dl>
|
|
1514
|
+
<dd>
|
|
1515
|
+
|
|
1516
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1428
1517
|
|
|
1429
1518
|
</dd>
|
|
1430
1519
|
</dl>
|
|
@@ -1435,9 +1524,7 @@ await client.project.get();
|
|
|
1435
1524
|
</dl>
|
|
1436
1525
|
</details>
|
|
1437
1526
|
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
<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>
|
|
1441
1528
|
<dl>
|
|
1442
1529
|
<dd>
|
|
1443
1530
|
|
|
@@ -1449,7 +1536,10 @@ await client.project.get();
|
|
|
1449
1536
|
<dl>
|
|
1450
1537
|
<dd>
|
|
1451
1538
|
|
|
1452
|
-
|
|
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.
|
|
1453
1543
|
|
|
1454
1544
|
</dd>
|
|
1455
1545
|
</dl>
|
|
@@ -1465,7 +1555,7 @@ Gets a task by its ID
|
|
|
1465
1555
|
<dd>
|
|
1466
1556
|
|
|
1467
1557
|
```typescript
|
|
1468
|
-
await client.
|
|
1558
|
+
await client.graph.detectPatterns();
|
|
1469
1559
|
```
|
|
1470
1560
|
|
|
1471
1561
|
</dd>
|
|
@@ -1481,7 +1571,7 @@ await client.task.get("task_id");
|
|
|
1481
1571
|
<dl>
|
|
1482
1572
|
<dd>
|
|
1483
1573
|
|
|
1484
|
-
**
|
|
1574
|
+
**request:** `Zep.DetectPatternsRequest`
|
|
1485
1575
|
|
|
1486
1576
|
</dd>
|
|
1487
1577
|
</dl>
|
|
@@ -1489,7 +1579,7 @@ await client.task.get("task_id");
|
|
|
1489
1579
|
<dl>
|
|
1490
1580
|
<dd>
|
|
1491
1581
|
|
|
1492
|
-
**requestOptions:** `
|
|
1582
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1493
1583
|
|
|
1494
1584
|
</dd>
|
|
1495
1585
|
</dl>
|
|
@@ -1500,9 +1590,7 @@ await client.task.get("task_id");
|
|
|
1500
1590
|
</dl>
|
|
1501
1591
|
</details>
|
|
1502
1592
|
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
<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>
|
|
1506
1594
|
<dl>
|
|
1507
1595
|
<dd>
|
|
1508
1596
|
|
|
@@ -1514,7 +1602,7 @@ await client.task.get("task_id");
|
|
|
1514
1602
|
<dl>
|
|
1515
1603
|
<dd>
|
|
1516
1604
|
|
|
1517
|
-
|
|
1605
|
+
Perform a graph search query.
|
|
1518
1606
|
|
|
1519
1607
|
</dd>
|
|
1520
1608
|
</dl>
|
|
@@ -1530,11 +1618,8 @@ Returns all threads.
|
|
|
1530
1618
|
<dd>
|
|
1531
1619
|
|
|
1532
1620
|
```typescript
|
|
1533
|
-
await client.
|
|
1534
|
-
|
|
1535
|
-
pageSize: 1,
|
|
1536
|
-
orderBy: "order_by",
|
|
1537
|
-
asc: true,
|
|
1621
|
+
await client.graph.search({
|
|
1622
|
+
query: "query",
|
|
1538
1623
|
});
|
|
1539
1624
|
```
|
|
1540
1625
|
|
|
@@ -1551,7 +1636,7 @@ await client.thread.listAll({
|
|
|
1551
1636
|
<dl>
|
|
1552
1637
|
<dd>
|
|
1553
1638
|
|
|
1554
|
-
**request:** `Zep.
|
|
1639
|
+
**request:** `Zep.GraphSearchQuery`
|
|
1555
1640
|
|
|
1556
1641
|
</dd>
|
|
1557
1642
|
</dl>
|
|
@@ -1559,7 +1644,70 @@ await client.thread.listAll({
|
|
|
1559
1644
|
<dl>
|
|
1560
1645
|
<dd>
|
|
1561
1646
|
|
|
1562
|
-
**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`
|
|
1563
1711
|
|
|
1564
1712
|
</dd>
|
|
1565
1713
|
</dl>
|
|
@@ -1570,7 +1718,831 @@ await client.thread.listAll({
|
|
|
1570
1718
|
</dl>
|
|
1571
1719
|
</details>
|
|
1572
1720
|
|
|
1573
|
-
<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>
|
|
1574
2546
|
<dl>
|
|
1575
2547
|
<dd>
|
|
1576
2548
|
|
|
@@ -1582,7 +2554,7 @@ await client.thread.listAll({
|
|
|
1582
2554
|
<dl>
|
|
1583
2555
|
<dd>
|
|
1584
2556
|
|
|
1585
|
-
|
|
2557
|
+
Lists all user summary instructions for a project, user.
|
|
1586
2558
|
|
|
1587
2559
|
</dd>
|
|
1588
2560
|
</dl>
|
|
@@ -1598,8 +2570,7 @@ Start a new thread.
|
|
|
1598
2570
|
<dd>
|
|
1599
2571
|
|
|
1600
2572
|
```typescript
|
|
1601
|
-
await client.
|
|
1602
|
-
threadId: "thread_id",
|
|
2573
|
+
await client.user.listUserSummaryInstructions({
|
|
1603
2574
|
userId: "user_id",
|
|
1604
2575
|
});
|
|
1605
2576
|
```
|
|
@@ -1617,7 +2588,7 @@ await client.thread.create({
|
|
|
1617
2588
|
<dl>
|
|
1618
2589
|
<dd>
|
|
1619
2590
|
|
|
1620
|
-
**request:** `Zep.
|
|
2591
|
+
**request:** `Zep.UserListUserSummaryInstructionsRequest`
|
|
1621
2592
|
|
|
1622
2593
|
</dd>
|
|
1623
2594
|
</dl>
|
|
@@ -1625,7 +2596,7 @@ await client.thread.create({
|
|
|
1625
2596
|
<dl>
|
|
1626
2597
|
<dd>
|
|
1627
2598
|
|
|
1628
|
-
**requestOptions:** `
|
|
2599
|
+
**requestOptions:** `User.RequestOptions`
|
|
1629
2600
|
|
|
1630
2601
|
</dd>
|
|
1631
2602
|
</dl>
|
|
@@ -1636,7 +2607,7 @@ await client.thread.create({
|
|
|
1636
2607
|
</dl>
|
|
1637
2608
|
</details>
|
|
1638
2609
|
|
|
1639
|
-
<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>
|
|
1640
2611
|
<dl>
|
|
1641
2612
|
<dd>
|
|
1642
2613
|
|
|
@@ -1648,7 +2619,7 @@ await client.thread.create({
|
|
|
1648
2619
|
<dl>
|
|
1649
2620
|
<dd>
|
|
1650
2621
|
|
|
1651
|
-
|
|
2622
|
+
Adds new summary instructions for users graphs without removing existing ones. If user_ids is empty, adds to project-wide default instructions.
|
|
1652
2623
|
|
|
1653
2624
|
</dd>
|
|
1654
2625
|
</dl>
|
|
@@ -1664,7 +2635,14 @@ Deletes a thread.
|
|
|
1664
2635
|
<dd>
|
|
1665
2636
|
|
|
1666
2637
|
```typescript
|
|
1667
|
-
await client.
|
|
2638
|
+
await client.user.addUserSummaryInstructions({
|
|
2639
|
+
instructions: [
|
|
2640
|
+
{
|
|
2641
|
+
name: "name",
|
|
2642
|
+
text: "text",
|
|
2643
|
+
},
|
|
2644
|
+
],
|
|
2645
|
+
});
|
|
1668
2646
|
```
|
|
1669
2647
|
|
|
1670
2648
|
</dd>
|
|
@@ -1680,7 +2658,7 @@ await client.thread.delete("threadId");
|
|
|
1680
2658
|
<dl>
|
|
1681
2659
|
<dd>
|
|
1682
2660
|
|
|
1683
|
-
**
|
|
2661
|
+
**request:** `Zep.AddUserInstructionsRequest`
|
|
1684
2662
|
|
|
1685
2663
|
</dd>
|
|
1686
2664
|
</dl>
|
|
@@ -1688,7 +2666,7 @@ await client.thread.delete("threadId");
|
|
|
1688
2666
|
<dl>
|
|
1689
2667
|
<dd>
|
|
1690
2668
|
|
|
1691
|
-
**requestOptions:** `
|
|
2669
|
+
**requestOptions:** `User.RequestOptions`
|
|
1692
2670
|
|
|
1693
2671
|
</dd>
|
|
1694
2672
|
</dl>
|
|
@@ -1699,7 +2677,7 @@ await client.thread.delete("threadId");
|
|
|
1699
2677
|
</dl>
|
|
1700
2678
|
</details>
|
|
1701
2679
|
|
|
1702
|
-
<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>
|
|
1703
2681
|
<dl>
|
|
1704
2682
|
<dd>
|
|
1705
2683
|
|
|
@@ -1711,7 +2689,7 @@ await client.thread.delete("threadId");
|
|
|
1711
2689
|
<dl>
|
|
1712
2690
|
<dd>
|
|
1713
2691
|
|
|
1714
|
-
|
|
2692
|
+
Deletes user summary/instructions for users or project wide defaults.
|
|
1715
2693
|
|
|
1716
2694
|
</dd>
|
|
1717
2695
|
</dl>
|
|
@@ -1727,9 +2705,7 @@ Returns most relevant context from the user graph (including memory from any/all
|
|
|
1727
2705
|
<dd>
|
|
1728
2706
|
|
|
1729
2707
|
```typescript
|
|
1730
|
-
await client.
|
|
1731
|
-
templateId: "template_id",
|
|
1732
|
-
});
|
|
2708
|
+
await client.user.deleteUserSummaryInstructions();
|
|
1733
2709
|
```
|
|
1734
2710
|
|
|
1735
2711
|
</dd>
|
|
@@ -1745,15 +2721,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1745
2721
|
<dl>
|
|
1746
2722
|
<dd>
|
|
1747
2723
|
|
|
1748
|
-
**
|
|
1749
|
-
|
|
1750
|
-
</dd>
|
|
1751
|
-
</dl>
|
|
1752
|
-
|
|
1753
|
-
<dl>
|
|
1754
|
-
<dd>
|
|
1755
|
-
|
|
1756
|
-
**request:** `Zep.ThreadGetUserContextRequest`
|
|
2724
|
+
**request:** `Zep.DeleteUserInstructionsRequest`
|
|
1757
2725
|
|
|
1758
2726
|
</dd>
|
|
1759
2727
|
</dl>
|
|
@@ -1761,7 +2729,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1761
2729
|
<dl>
|
|
1762
2730
|
<dd>
|
|
1763
2731
|
|
|
1764
|
-
**requestOptions:** `
|
|
2732
|
+
**requestOptions:** `User.RequestOptions`
|
|
1765
2733
|
|
|
1766
2734
|
</dd>
|
|
1767
2735
|
</dl>
|
|
@@ -1772,7 +2740,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1772
2740
|
</dl>
|
|
1773
2741
|
</details>
|
|
1774
2742
|
|
|
1775
|
-
<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>
|
|
1776
2744
|
<dl>
|
|
1777
2745
|
<dd>
|
|
1778
2746
|
|
|
@@ -1784,7 +2752,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1784
2752
|
<dl>
|
|
1785
2753
|
<dd>
|
|
1786
2754
|
|
|
1787
|
-
|
|
2755
|
+
Adds a user.
|
|
1788
2756
|
|
|
1789
2757
|
</dd>
|
|
1790
2758
|
</dl>
|
|
@@ -1800,10 +2768,8 @@ Returns messages for a thread.
|
|
|
1800
2768
|
<dd>
|
|
1801
2769
|
|
|
1802
2770
|
```typescript
|
|
1803
|
-
await client.
|
|
1804
|
-
|
|
1805
|
-
cursor: 1,
|
|
1806
|
-
lastn: 1,
|
|
2771
|
+
await client.user.add({
|
|
2772
|
+
userId: "user_id",
|
|
1807
2773
|
});
|
|
1808
2774
|
```
|
|
1809
2775
|
|
|
@@ -1820,15 +2786,7 @@ await client.thread.get("threadId", {
|
|
|
1820
2786
|
<dl>
|
|
1821
2787
|
<dd>
|
|
1822
2788
|
|
|
1823
|
-
**
|
|
1824
|
-
|
|
1825
|
-
</dd>
|
|
1826
|
-
</dl>
|
|
1827
|
-
|
|
1828
|
-
<dl>
|
|
1829
|
-
<dd>
|
|
1830
|
-
|
|
1831
|
-
**request:** `Zep.ThreadGetRequest`
|
|
2789
|
+
**request:** `Zep.CreateUserRequest`
|
|
1832
2790
|
|
|
1833
2791
|
</dd>
|
|
1834
2792
|
</dl>
|
|
@@ -1836,7 +2794,7 @@ await client.thread.get("threadId", {
|
|
|
1836
2794
|
<dl>
|
|
1837
2795
|
<dd>
|
|
1838
2796
|
|
|
1839
|
-
**requestOptions:** `
|
|
2797
|
+
**requestOptions:** `User.RequestOptions`
|
|
1840
2798
|
|
|
1841
2799
|
</dd>
|
|
1842
2800
|
</dl>
|
|
@@ -1847,7 +2805,7 @@ await client.thread.get("threadId", {
|
|
|
1847
2805
|
</dl>
|
|
1848
2806
|
</details>
|
|
1849
2807
|
|
|
1850
|
-
<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>
|
|
1851
2809
|
<dl>
|
|
1852
2810
|
<dd>
|
|
1853
2811
|
|
|
@@ -1859,7 +2817,7 @@ await client.thread.get("threadId", {
|
|
|
1859
2817
|
<dl>
|
|
1860
2818
|
<dd>
|
|
1861
2819
|
|
|
1862
|
-
|
|
2820
|
+
Returns all users.
|
|
1863
2821
|
|
|
1864
2822
|
</dd>
|
|
1865
2823
|
</dl>
|
|
@@ -1875,13 +2833,12 @@ Add messages to a thread.
|
|
|
1875
2833
|
<dd>
|
|
1876
2834
|
|
|
1877
2835
|
```typescript
|
|
1878
|
-
await client.
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
],
|
|
2836
|
+
await client.user.listOrdered({
|
|
2837
|
+
pageNumber: 1,
|
|
2838
|
+
pageSize: 1,
|
|
2839
|
+
search: "search",
|
|
2840
|
+
orderBy: "order_by",
|
|
2841
|
+
asc: true,
|
|
1885
2842
|
});
|
|
1886
2843
|
```
|
|
1887
2844
|
|
|
@@ -1898,15 +2855,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1898
2855
|
<dl>
|
|
1899
2856
|
<dd>
|
|
1900
2857
|
|
|
1901
|
-
**
|
|
1902
|
-
|
|
1903
|
-
</dd>
|
|
1904
|
-
</dl>
|
|
1905
|
-
|
|
1906
|
-
<dl>
|
|
1907
|
-
<dd>
|
|
1908
|
-
|
|
1909
|
-
**request:** `Zep.AddThreadMessagesRequest`
|
|
2858
|
+
**request:** `Zep.UserListOrderedRequest`
|
|
1910
2859
|
|
|
1911
2860
|
</dd>
|
|
1912
2861
|
</dl>
|
|
@@ -1914,7 +2863,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1914
2863
|
<dl>
|
|
1915
2864
|
<dd>
|
|
1916
2865
|
|
|
1917
|
-
**requestOptions:** `
|
|
2866
|
+
**requestOptions:** `User.RequestOptions`
|
|
1918
2867
|
|
|
1919
2868
|
</dd>
|
|
1920
2869
|
</dl>
|
|
@@ -1925,7 +2874,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1925
2874
|
</dl>
|
|
1926
2875
|
</details>
|
|
1927
2876
|
|
|
1928
|
-
<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>
|
|
1929
2878
|
<dl>
|
|
1930
2879
|
<dd>
|
|
1931
2880
|
|
|
@@ -1937,7 +2886,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1937
2886
|
<dl>
|
|
1938
2887
|
<dd>
|
|
1939
2888
|
|
|
1940
|
-
|
|
2889
|
+
Returns a user.
|
|
1941
2890
|
|
|
1942
2891
|
</dd>
|
|
1943
2892
|
</dl>
|
|
@@ -1953,14 +2902,7 @@ Add messages to a thread in batch mode. This will process messages concurrently,
|
|
|
1953
2902
|
<dd>
|
|
1954
2903
|
|
|
1955
2904
|
```typescript
|
|
1956
|
-
await client.
|
|
1957
|
-
messages: [
|
|
1958
|
-
{
|
|
1959
|
-
content: "content",
|
|
1960
|
-
role: "norole",
|
|
1961
|
-
},
|
|
1962
|
-
],
|
|
1963
|
-
});
|
|
2905
|
+
await client.user.get("userId");
|
|
1964
2906
|
```
|
|
1965
2907
|
|
|
1966
2908
|
</dd>
|
|
@@ -1976,15 +2918,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
1976
2918
|
<dl>
|
|
1977
2919
|
<dd>
|
|
1978
2920
|
|
|
1979
|
-
**
|
|
1980
|
-
|
|
1981
|
-
</dd>
|
|
1982
|
-
</dl>
|
|
1983
|
-
|
|
1984
|
-
<dl>
|
|
1985
|
-
<dd>
|
|
1986
|
-
|
|
1987
|
-
**request:** `Zep.AddThreadMessagesRequest`
|
|
2921
|
+
**userId:** `string` — The user_id of the user to get.
|
|
1988
2922
|
|
|
1989
2923
|
</dd>
|
|
1990
2924
|
</dl>
|
|
@@ -1992,7 +2926,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
1992
2926
|
<dl>
|
|
1993
2927
|
<dd>
|
|
1994
2928
|
|
|
1995
|
-
**requestOptions:** `
|
|
2929
|
+
**requestOptions:** `User.RequestOptions`
|
|
1996
2930
|
|
|
1997
2931
|
</dd>
|
|
1998
2932
|
</dl>
|
|
@@ -2003,9 +2937,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
2003
2937
|
</dl>
|
|
2004
2938
|
</details>
|
|
2005
2939
|
|
|
2006
|
-
|
|
2007
|
-
|
|
2008
|
-
<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>
|
|
2009
2941
|
<dl>
|
|
2010
2942
|
<dd>
|
|
2011
2943
|
|
|
@@ -2017,7 +2949,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
2017
2949
|
<dl>
|
|
2018
2950
|
<dd>
|
|
2019
2951
|
|
|
2020
|
-
|
|
2952
|
+
Deletes a user.
|
|
2021
2953
|
|
|
2022
2954
|
</dd>
|
|
2023
2955
|
</dl>
|
|
@@ -2033,9 +2965,7 @@ Lists all user summary instructions for a project, user.
|
|
|
2033
2965
|
<dd>
|
|
2034
2966
|
|
|
2035
2967
|
```typescript
|
|
2036
|
-
await client.user.
|
|
2037
|
-
userId: "user_id",
|
|
2038
|
-
});
|
|
2968
|
+
await client.user.delete("userId");
|
|
2039
2969
|
```
|
|
2040
2970
|
|
|
2041
2971
|
</dd>
|
|
@@ -2051,7 +2981,7 @@ await client.user.listUserSummaryInstructions({
|
|
|
2051
2981
|
<dl>
|
|
2052
2982
|
<dd>
|
|
2053
2983
|
|
|
2054
|
-
**
|
|
2984
|
+
**userId:** `string` — User ID
|
|
2055
2985
|
|
|
2056
2986
|
</dd>
|
|
2057
2987
|
</dl>
|
|
@@ -2070,7 +3000,7 @@ await client.user.listUserSummaryInstructions({
|
|
|
2070
3000
|
</dl>
|
|
2071
3001
|
</details>
|
|
2072
3002
|
|
|
2073
|
-
<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>
|
|
2074
3004
|
<dl>
|
|
2075
3005
|
<dd>
|
|
2076
3006
|
|
|
@@ -2082,7 +3012,7 @@ await client.user.listUserSummaryInstructions({
|
|
|
2082
3012
|
<dl>
|
|
2083
3013
|
<dd>
|
|
2084
3014
|
|
|
2085
|
-
|
|
3015
|
+
Updates a user.
|
|
2086
3016
|
|
|
2087
3017
|
</dd>
|
|
2088
3018
|
</dl>
|
|
@@ -2098,14 +3028,7 @@ Adds new summary instructions for users graphs without removing existing ones. I
|
|
|
2098
3028
|
<dd>
|
|
2099
3029
|
|
|
2100
3030
|
```typescript
|
|
2101
|
-
await client.user.
|
|
2102
|
-
instructions: [
|
|
2103
|
-
{
|
|
2104
|
-
name: "name",
|
|
2105
|
-
text: "text",
|
|
2106
|
-
},
|
|
2107
|
-
],
|
|
2108
|
-
});
|
|
3031
|
+
await client.user.update("userId");
|
|
2109
3032
|
```
|
|
2110
3033
|
|
|
2111
3034
|
</dd>
|
|
@@ -2121,7 +3044,15 @@ await client.user.addUserSummaryInstructions({
|
|
|
2121
3044
|
<dl>
|
|
2122
3045
|
<dd>
|
|
2123
3046
|
|
|
2124
|
-
**
|
|
3047
|
+
**userId:** `string` — User ID
|
|
3048
|
+
|
|
3049
|
+
</dd>
|
|
3050
|
+
</dl>
|
|
3051
|
+
|
|
3052
|
+
<dl>
|
|
3053
|
+
<dd>
|
|
3054
|
+
|
|
3055
|
+
**request:** `Zep.UpdateUserRequest`
|
|
2125
3056
|
|
|
2126
3057
|
</dd>
|
|
2127
3058
|
</dl>
|
|
@@ -2140,7 +3071,7 @@ await client.user.addUserSummaryInstructions({
|
|
|
2140
3071
|
</dl>
|
|
2141
3072
|
</details>
|
|
2142
3073
|
|
|
2143
|
-
<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>
|
|
2144
3075
|
<dl>
|
|
2145
3076
|
<dd>
|
|
2146
3077
|
|
|
@@ -2152,7 +3083,7 @@ await client.user.addUserSummaryInstructions({
|
|
|
2152
3083
|
<dl>
|
|
2153
3084
|
<dd>
|
|
2154
3085
|
|
|
2155
|
-
|
|
3086
|
+
Returns a user's node.
|
|
2156
3087
|
|
|
2157
3088
|
</dd>
|
|
2158
3089
|
</dl>
|
|
@@ -2168,7 +3099,7 @@ Deletes user summary/instructions for users or project wide defaults.
|
|
|
2168
3099
|
<dd>
|
|
2169
3100
|
|
|
2170
3101
|
```typescript
|
|
2171
|
-
await client.user.
|
|
3102
|
+
await client.user.getNode("userId");
|
|
2172
3103
|
```
|
|
2173
3104
|
|
|
2174
3105
|
</dd>
|
|
@@ -2184,7 +3115,7 @@ await client.user.deleteUserSummaryInstructions();
|
|
|
2184
3115
|
<dl>
|
|
2185
3116
|
<dd>
|
|
2186
3117
|
|
|
2187
|
-
**
|
|
3118
|
+
**userId:** `string` — The user_id of the user to get the node for.
|
|
2188
3119
|
|
|
2189
3120
|
</dd>
|
|
2190
3121
|
</dl>
|
|
@@ -2203,7 +3134,7 @@ await client.user.deleteUserSummaryInstructions();
|
|
|
2203
3134
|
</dl>
|
|
2204
3135
|
</details>
|
|
2205
3136
|
|
|
2206
|
-
<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>
|
|
2207
3138
|
<dl>
|
|
2208
3139
|
<dd>
|
|
2209
3140
|
|
|
@@ -2215,7 +3146,7 @@ await client.user.deleteUserSummaryInstructions();
|
|
|
2215
3146
|
<dl>
|
|
2216
3147
|
<dd>
|
|
2217
3148
|
|
|
2218
|
-
|
|
3149
|
+
Returns all threads for a user.
|
|
2219
3150
|
|
|
2220
3151
|
</dd>
|
|
2221
3152
|
</dl>
|
|
@@ -2231,9 +3162,7 @@ Adds a user.
|
|
|
2231
3162
|
<dd>
|
|
2232
3163
|
|
|
2233
3164
|
```typescript
|
|
2234
|
-
await client.user.
|
|
2235
|
-
userId: "user_id",
|
|
2236
|
-
});
|
|
3165
|
+
await client.user.getThreads("userId");
|
|
2237
3166
|
```
|
|
2238
3167
|
|
|
2239
3168
|
</dd>
|
|
@@ -2249,7 +3178,7 @@ await client.user.add({
|
|
|
2249
3178
|
<dl>
|
|
2250
3179
|
<dd>
|
|
2251
3180
|
|
|
2252
|
-
**
|
|
3181
|
+
**userId:** `string` — User ID
|
|
2253
3182
|
|
|
2254
3183
|
</dd>
|
|
2255
3184
|
</dl>
|
|
@@ -2268,7 +3197,7 @@ await client.user.add({
|
|
|
2268
3197
|
</dl>
|
|
2269
3198
|
</details>
|
|
2270
3199
|
|
|
2271
|
-
<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>
|
|
2272
3201
|
<dl>
|
|
2273
3202
|
<dd>
|
|
2274
3203
|
|
|
@@ -2280,7 +3209,7 @@ await client.user.add({
|
|
|
2280
3209
|
<dl>
|
|
2281
3210
|
<dd>
|
|
2282
3211
|
|
|
2283
|
-
|
|
3212
|
+
Hints Zep to warm a user's graph for low-latency search
|
|
2284
3213
|
|
|
2285
3214
|
</dd>
|
|
2286
3215
|
</dl>
|
|
@@ -2296,13 +3225,7 @@ Returns all users.
|
|
|
2296
3225
|
<dd>
|
|
2297
3226
|
|
|
2298
3227
|
```typescript
|
|
2299
|
-
await client.user.
|
|
2300
|
-
pageNumber: 1,
|
|
2301
|
-
pageSize: 1,
|
|
2302
|
-
search: "search",
|
|
2303
|
-
orderBy: "order_by",
|
|
2304
|
-
asc: true,
|
|
2305
|
-
});
|
|
3228
|
+
await client.user.warm("userId");
|
|
2306
3229
|
```
|
|
2307
3230
|
|
|
2308
3231
|
</dd>
|
|
@@ -2318,7 +3241,7 @@ await client.user.listOrdered({
|
|
|
2318
3241
|
<dl>
|
|
2319
3242
|
<dd>
|
|
2320
3243
|
|
|
2321
|
-
**
|
|
3244
|
+
**userId:** `string` — User ID
|
|
2322
3245
|
|
|
2323
3246
|
</dd>
|
|
2324
3247
|
</dl>
|
|
@@ -2337,7 +3260,9 @@ await client.user.listOrdered({
|
|
|
2337
3260
|
</dl>
|
|
2338
3261
|
</details>
|
|
2339
3262
|
|
|
2340
|
-
|
|
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>
|
|
2341
3266
|
<dl>
|
|
2342
3267
|
<dd>
|
|
2343
3268
|
|
|
@@ -2349,7 +3274,7 @@ await client.user.listOrdered({
|
|
|
2349
3274
|
<dl>
|
|
2350
3275
|
<dd>
|
|
2351
3276
|
|
|
2352
|
-
Returns a
|
|
3277
|
+
Returns all edges for a graph.
|
|
2353
3278
|
|
|
2354
3279
|
</dd>
|
|
2355
3280
|
</dl>
|
|
@@ -2365,7 +3290,7 @@ Returns a user.
|
|
|
2365
3290
|
<dd>
|
|
2366
3291
|
|
|
2367
3292
|
```typescript
|
|
2368
|
-
await client.
|
|
3293
|
+
await client.graph.edge.getByGraphId("graph_id", {});
|
|
2369
3294
|
```
|
|
2370
3295
|
|
|
2371
3296
|
</dd>
|
|
@@ -2381,7 +3306,7 @@ await client.user.get("userId");
|
|
|
2381
3306
|
<dl>
|
|
2382
3307
|
<dd>
|
|
2383
3308
|
|
|
2384
|
-
**
|
|
3309
|
+
**graphId:** `string` — Graph ID
|
|
2385
3310
|
|
|
2386
3311
|
</dd>
|
|
2387
3312
|
</dl>
|
|
@@ -2389,7 +3314,15 @@ await client.user.get("userId");
|
|
|
2389
3314
|
<dl>
|
|
2390
3315
|
<dd>
|
|
2391
3316
|
|
|
2392
|
-
**
|
|
3317
|
+
**request:** `Zep.GraphEdgesRequest`
|
|
3318
|
+
|
|
3319
|
+
</dd>
|
|
3320
|
+
</dl>
|
|
3321
|
+
|
|
3322
|
+
<dl>
|
|
3323
|
+
<dd>
|
|
3324
|
+
|
|
3325
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2393
3326
|
|
|
2394
3327
|
</dd>
|
|
2395
3328
|
</dl>
|
|
@@ -2400,7 +3333,7 @@ await client.user.get("userId");
|
|
|
2400
3333
|
</dl>
|
|
2401
3334
|
</details>
|
|
2402
3335
|
|
|
2403
|
-
<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>
|
|
2404
3337
|
<dl>
|
|
2405
3338
|
<dd>
|
|
2406
3339
|
|
|
@@ -2412,7 +3345,7 @@ await client.user.get("userId");
|
|
|
2412
3345
|
<dl>
|
|
2413
3346
|
<dd>
|
|
2414
3347
|
|
|
2415
|
-
|
|
3348
|
+
Returns all edges for a user.
|
|
2416
3349
|
|
|
2417
3350
|
</dd>
|
|
2418
3351
|
</dl>
|
|
@@ -2428,7 +3361,7 @@ Deletes a user.
|
|
|
2428
3361
|
<dd>
|
|
2429
3362
|
|
|
2430
3363
|
```typescript
|
|
2431
|
-
await client.
|
|
3364
|
+
await client.graph.edge.getByUserId("user_id", {});
|
|
2432
3365
|
```
|
|
2433
3366
|
|
|
2434
3367
|
</dd>
|
|
@@ -2452,7 +3385,15 @@ await client.user.delete("userId");
|
|
|
2452
3385
|
<dl>
|
|
2453
3386
|
<dd>
|
|
2454
3387
|
|
|
2455
|
-
**
|
|
3388
|
+
**request:** `Zep.GraphEdgesRequest`
|
|
3389
|
+
|
|
3390
|
+
</dd>
|
|
3391
|
+
</dl>
|
|
3392
|
+
|
|
3393
|
+
<dl>
|
|
3394
|
+
<dd>
|
|
3395
|
+
|
|
3396
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2456
3397
|
|
|
2457
3398
|
</dd>
|
|
2458
3399
|
</dl>
|
|
@@ -2463,7 +3404,7 @@ await client.user.delete("userId");
|
|
|
2463
3404
|
</dl>
|
|
2464
3405
|
</details>
|
|
2465
3406
|
|
|
2466
|
-
<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>
|
|
2467
3408
|
<dl>
|
|
2468
3409
|
<dd>
|
|
2469
3410
|
|
|
@@ -2475,7 +3416,7 @@ await client.user.delete("userId");
|
|
|
2475
3416
|
<dl>
|
|
2476
3417
|
<dd>
|
|
2477
3418
|
|
|
2478
|
-
|
|
3419
|
+
Returns a specific edge by its UUID.
|
|
2479
3420
|
|
|
2480
3421
|
</dd>
|
|
2481
3422
|
</dl>
|
|
@@ -2491,7 +3432,7 @@ Updates a user.
|
|
|
2491
3432
|
<dd>
|
|
2492
3433
|
|
|
2493
3434
|
```typescript
|
|
2494
|
-
await client.
|
|
3435
|
+
await client.graph.edge.get("uuid");
|
|
2495
3436
|
```
|
|
2496
3437
|
|
|
2497
3438
|
</dd>
|
|
@@ -2507,15 +3448,7 @@ await client.user.update("userId");
|
|
|
2507
3448
|
<dl>
|
|
2508
3449
|
<dd>
|
|
2509
3450
|
|
|
2510
|
-
**
|
|
2511
|
-
|
|
2512
|
-
</dd>
|
|
2513
|
-
</dl>
|
|
2514
|
-
|
|
2515
|
-
<dl>
|
|
2516
|
-
<dd>
|
|
2517
|
-
|
|
2518
|
-
**request:** `Zep.UpdateUserRequest`
|
|
3451
|
+
**uuid:** `string` — Edge UUID
|
|
2519
3452
|
|
|
2520
3453
|
</dd>
|
|
2521
3454
|
</dl>
|
|
@@ -2523,7 +3456,7 @@ await client.user.update("userId");
|
|
|
2523
3456
|
<dl>
|
|
2524
3457
|
<dd>
|
|
2525
3458
|
|
|
2526
|
-
**requestOptions:** `
|
|
3459
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2527
3460
|
|
|
2528
3461
|
</dd>
|
|
2529
3462
|
</dl>
|
|
@@ -2534,7 +3467,7 @@ await client.user.update("userId");
|
|
|
2534
3467
|
</dl>
|
|
2535
3468
|
</details>
|
|
2536
3469
|
|
|
2537
|
-
<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>
|
|
2538
3471
|
<dl>
|
|
2539
3472
|
<dd>
|
|
2540
3473
|
|
|
@@ -2546,7 +3479,7 @@ await client.user.update("userId");
|
|
|
2546
3479
|
<dl>
|
|
2547
3480
|
<dd>
|
|
2548
3481
|
|
|
2549
|
-
|
|
3482
|
+
Deletes an edge by UUID.
|
|
2550
3483
|
|
|
2551
3484
|
</dd>
|
|
2552
3485
|
</dl>
|
|
@@ -2562,7 +3495,7 @@ Returns a user's node.
|
|
|
2562
3495
|
<dd>
|
|
2563
3496
|
|
|
2564
3497
|
```typescript
|
|
2565
|
-
await client.
|
|
3498
|
+
await client.graph.edge.delete("uuid");
|
|
2566
3499
|
```
|
|
2567
3500
|
|
|
2568
3501
|
</dd>
|
|
@@ -2578,7 +3511,7 @@ await client.user.getNode("userId");
|
|
|
2578
3511
|
<dl>
|
|
2579
3512
|
<dd>
|
|
2580
3513
|
|
|
2581
|
-
**
|
|
3514
|
+
**uuid:** `string` — Edge UUID
|
|
2582
3515
|
|
|
2583
3516
|
</dd>
|
|
2584
3517
|
</dl>
|
|
@@ -2586,7 +3519,7 @@ await client.user.getNode("userId");
|
|
|
2586
3519
|
<dl>
|
|
2587
3520
|
<dd>
|
|
2588
3521
|
|
|
2589
|
-
**requestOptions:** `
|
|
3522
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2590
3523
|
|
|
2591
3524
|
</dd>
|
|
2592
3525
|
</dl>
|
|
@@ -2597,7 +3530,7 @@ await client.user.getNode("userId");
|
|
|
2597
3530
|
</dl>
|
|
2598
3531
|
</details>
|
|
2599
3532
|
|
|
2600
|
-
<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>
|
|
2601
3534
|
<dl>
|
|
2602
3535
|
<dd>
|
|
2603
3536
|
|
|
@@ -2609,7 +3542,7 @@ await client.user.getNode("userId");
|
|
|
2609
3542
|
<dl>
|
|
2610
3543
|
<dd>
|
|
2611
3544
|
|
|
2612
|
-
|
|
3545
|
+
Updates an entity edge by UUID.
|
|
2613
3546
|
|
|
2614
3547
|
</dd>
|
|
2615
3548
|
</dl>
|
|
@@ -2625,7 +3558,7 @@ Returns all threads for a user.
|
|
|
2625
3558
|
<dd>
|
|
2626
3559
|
|
|
2627
3560
|
```typescript
|
|
2628
|
-
await client.
|
|
3561
|
+
await client.graph.edge.update("uuid");
|
|
2629
3562
|
```
|
|
2630
3563
|
|
|
2631
3564
|
</dd>
|
|
@@ -2641,7 +3574,7 @@ await client.user.getThreads("userId");
|
|
|
2641
3574
|
<dl>
|
|
2642
3575
|
<dd>
|
|
2643
3576
|
|
|
2644
|
-
**
|
|
3577
|
+
**uuid:** `string` — Edge UUID
|
|
2645
3578
|
|
|
2646
3579
|
</dd>
|
|
2647
3580
|
</dl>
|
|
@@ -2649,7 +3582,15 @@ await client.user.getThreads("userId");
|
|
|
2649
3582
|
<dl>
|
|
2650
3583
|
<dd>
|
|
2651
3584
|
|
|
2652
|
-
**
|
|
3585
|
+
**request:** `Zep.graph.UpdateEdgeRequest`
|
|
3586
|
+
|
|
3587
|
+
</dd>
|
|
3588
|
+
</dl>
|
|
3589
|
+
|
|
3590
|
+
<dl>
|
|
3591
|
+
<dd>
|
|
3592
|
+
|
|
3593
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2653
3594
|
|
|
2654
3595
|
</dd>
|
|
2655
3596
|
</dl>
|
|
@@ -2660,7 +3601,9 @@ await client.user.getThreads("userId");
|
|
|
2660
3601
|
</dl>
|
|
2661
3602
|
</details>
|
|
2662
3603
|
|
|
2663
|
-
|
|
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>
|
|
2664
3607
|
<dl>
|
|
2665
3608
|
<dd>
|
|
2666
3609
|
|
|
@@ -2672,7 +3615,7 @@ await client.user.getThreads("userId");
|
|
|
2672
3615
|
<dl>
|
|
2673
3616
|
<dd>
|
|
2674
3617
|
|
|
2675
|
-
|
|
3618
|
+
Returns episodes by graph id.
|
|
2676
3619
|
|
|
2677
3620
|
</dd>
|
|
2678
3621
|
</dl>
|
|
@@ -2688,7 +3631,9 @@ Hints Zep to warm a user's graph for low-latency search
|
|
|
2688
3631
|
<dd>
|
|
2689
3632
|
|
|
2690
3633
|
```typescript
|
|
2691
|
-
await client.
|
|
3634
|
+
await client.graph.episode.getByGraphId("graph_id", {
|
|
3635
|
+
lastn: 1,
|
|
3636
|
+
});
|
|
2692
3637
|
```
|
|
2693
3638
|
|
|
2694
3639
|
</dd>
|
|
@@ -2704,7 +3649,7 @@ await client.user.warm("userId");
|
|
|
2704
3649
|
<dl>
|
|
2705
3650
|
<dd>
|
|
2706
3651
|
|
|
2707
|
-
**
|
|
3652
|
+
**graphId:** `string` — Graph ID
|
|
2708
3653
|
|
|
2709
3654
|
</dd>
|
|
2710
3655
|
</dl>
|
|
@@ -2712,7 +3657,15 @@ await client.user.warm("userId");
|
|
|
2712
3657
|
<dl>
|
|
2713
3658
|
<dd>
|
|
2714
3659
|
|
|
2715
|
-
**
|
|
3660
|
+
**request:** `Zep.graph.EpisodeGetByGraphIdRequest`
|
|
3661
|
+
|
|
3662
|
+
</dd>
|
|
3663
|
+
</dl>
|
|
3664
|
+
|
|
3665
|
+
<dl>
|
|
3666
|
+
<dd>
|
|
3667
|
+
|
|
3668
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2716
3669
|
|
|
2717
3670
|
</dd>
|
|
2718
3671
|
</dl>
|
|
@@ -2723,9 +3676,7 @@ await client.user.warm("userId");
|
|
|
2723
3676
|
</dl>
|
|
2724
3677
|
</details>
|
|
2725
3678
|
|
|
2726
|
-
|
|
2727
|
-
|
|
2728
|
-
<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>
|
|
2729
3680
|
<dl>
|
|
2730
3681
|
<dd>
|
|
2731
3682
|
|
|
@@ -2737,7 +3688,7 @@ await client.user.warm("userId");
|
|
|
2737
3688
|
<dl>
|
|
2738
3689
|
<dd>
|
|
2739
3690
|
|
|
2740
|
-
Returns
|
|
3691
|
+
Returns episodes by user id.
|
|
2741
3692
|
|
|
2742
3693
|
</dd>
|
|
2743
3694
|
</dl>
|
|
@@ -2753,7 +3704,9 @@ Returns all edges for a graph.
|
|
|
2753
3704
|
<dd>
|
|
2754
3705
|
|
|
2755
3706
|
```typescript
|
|
2756
|
-
await client.graph.
|
|
3707
|
+
await client.graph.episode.getByUserId("user_id", {
|
|
3708
|
+
lastn: 1,
|
|
3709
|
+
});
|
|
2757
3710
|
```
|
|
2758
3711
|
|
|
2759
3712
|
</dd>
|
|
@@ -2769,7 +3722,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2769
3722
|
<dl>
|
|
2770
3723
|
<dd>
|
|
2771
3724
|
|
|
2772
|
-
**
|
|
3725
|
+
**userId:** `string` — User ID
|
|
2773
3726
|
|
|
2774
3727
|
</dd>
|
|
2775
3728
|
</dl>
|
|
@@ -2777,7 +3730,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2777
3730
|
<dl>
|
|
2778
3731
|
<dd>
|
|
2779
3732
|
|
|
2780
|
-
**request:** `Zep.
|
|
3733
|
+
**request:** `Zep.graph.EpisodeGetByUserIdRequest`
|
|
2781
3734
|
|
|
2782
3735
|
</dd>
|
|
2783
3736
|
</dl>
|
|
@@ -2785,7 +3738,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2785
3738
|
<dl>
|
|
2786
3739
|
<dd>
|
|
2787
3740
|
|
|
2788
|
-
**requestOptions:** `
|
|
3741
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2789
3742
|
|
|
2790
3743
|
</dd>
|
|
2791
3744
|
</dl>
|
|
@@ -2796,7 +3749,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2796
3749
|
</dl>
|
|
2797
3750
|
</details>
|
|
2798
3751
|
|
|
2799
|
-
<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>
|
|
2800
3753
|
<dl>
|
|
2801
3754
|
<dd>
|
|
2802
3755
|
|
|
@@ -2808,7 +3761,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2808
3761
|
<dl>
|
|
2809
3762
|
<dd>
|
|
2810
3763
|
|
|
2811
|
-
Returns
|
|
3764
|
+
Returns episodes by UUID
|
|
2812
3765
|
|
|
2813
3766
|
</dd>
|
|
2814
3767
|
</dl>
|
|
@@ -2824,7 +3777,7 @@ Returns all edges for a user.
|
|
|
2824
3777
|
<dd>
|
|
2825
3778
|
|
|
2826
3779
|
```typescript
|
|
2827
|
-
await client.graph.
|
|
3780
|
+
await client.graph.episode.get("uuid");
|
|
2828
3781
|
```
|
|
2829
3782
|
|
|
2830
3783
|
</dd>
|
|
@@ -2840,15 +3793,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2840
3793
|
<dl>
|
|
2841
3794
|
<dd>
|
|
2842
3795
|
|
|
2843
|
-
**
|
|
2844
|
-
|
|
2845
|
-
</dd>
|
|
2846
|
-
</dl>
|
|
2847
|
-
|
|
2848
|
-
<dl>
|
|
2849
|
-
<dd>
|
|
2850
|
-
|
|
2851
|
-
**request:** `Zep.GraphEdgesRequest`
|
|
3796
|
+
**uuid:** `string` — Episode UUID
|
|
2852
3797
|
|
|
2853
3798
|
</dd>
|
|
2854
3799
|
</dl>
|
|
@@ -2856,7 +3801,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2856
3801
|
<dl>
|
|
2857
3802
|
<dd>
|
|
2858
3803
|
|
|
2859
|
-
**requestOptions:** `
|
|
3804
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2860
3805
|
|
|
2861
3806
|
</dd>
|
|
2862
3807
|
</dl>
|
|
@@ -2867,7 +3812,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2867
3812
|
</dl>
|
|
2868
3813
|
</details>
|
|
2869
3814
|
|
|
2870
|
-
<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>
|
|
2871
3816
|
<dl>
|
|
2872
3817
|
<dd>
|
|
2873
3818
|
|
|
@@ -2879,7 +3824,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2879
3824
|
<dl>
|
|
2880
3825
|
<dd>
|
|
2881
3826
|
|
|
2882
|
-
|
|
3827
|
+
Deletes an episode by its UUID.
|
|
2883
3828
|
|
|
2884
3829
|
</dd>
|
|
2885
3830
|
</dl>
|
|
@@ -2895,7 +3840,7 @@ Returns a specific edge by its UUID.
|
|
|
2895
3840
|
<dd>
|
|
2896
3841
|
|
|
2897
3842
|
```typescript
|
|
2898
|
-
await client.graph.
|
|
3843
|
+
await client.graph.episode.delete("uuid");
|
|
2899
3844
|
```
|
|
2900
3845
|
|
|
2901
3846
|
</dd>
|
|
@@ -2911,7 +3856,7 @@ await client.graph.edge.get("uuid");
|
|
|
2911
3856
|
<dl>
|
|
2912
3857
|
<dd>
|
|
2913
3858
|
|
|
2914
|
-
**uuid:** `string` —
|
|
3859
|
+
**uuid:** `string` — Episode UUID
|
|
2915
3860
|
|
|
2916
3861
|
</dd>
|
|
2917
3862
|
</dl>
|
|
@@ -2919,7 +3864,7 @@ await client.graph.edge.get("uuid");
|
|
|
2919
3864
|
<dl>
|
|
2920
3865
|
<dd>
|
|
2921
3866
|
|
|
2922
|
-
**requestOptions:** `
|
|
3867
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2923
3868
|
|
|
2924
3869
|
</dd>
|
|
2925
3870
|
</dl>
|
|
@@ -2930,7 +3875,7 @@ await client.graph.edge.get("uuid");
|
|
|
2930
3875
|
</dl>
|
|
2931
3876
|
</details>
|
|
2932
3877
|
|
|
2933
|
-
<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>
|
|
2934
3879
|
<dl>
|
|
2935
3880
|
<dd>
|
|
2936
3881
|
|
|
@@ -2942,7 +3887,7 @@ await client.graph.edge.get("uuid");
|
|
|
2942
3887
|
<dl>
|
|
2943
3888
|
<dd>
|
|
2944
3889
|
|
|
2945
|
-
|
|
3890
|
+
Update episode metadata with merge semantics. Supplied keys overwrite or add to existing metadata; keys set to null are removed.
|
|
2946
3891
|
|
|
2947
3892
|
</dd>
|
|
2948
3893
|
</dl>
|
|
@@ -2958,7 +3903,11 @@ Deletes an edge by UUID.
|
|
|
2958
3903
|
<dd>
|
|
2959
3904
|
|
|
2960
3905
|
```typescript
|
|
2961
|
-
await client.graph.
|
|
3906
|
+
await client.graph.episode.update("uuid", {
|
|
3907
|
+
metadata: {
|
|
3908
|
+
key: "value",
|
|
3909
|
+
},
|
|
3910
|
+
});
|
|
2962
3911
|
```
|
|
2963
3912
|
|
|
2964
3913
|
</dd>
|
|
@@ -2974,7 +3923,7 @@ await client.graph.edge.delete("uuid");
|
|
|
2974
3923
|
<dl>
|
|
2975
3924
|
<dd>
|
|
2976
3925
|
|
|
2977
|
-
**uuid:** `string` —
|
|
3926
|
+
**uuid:** `string` — Episode UUID
|
|
2978
3927
|
|
|
2979
3928
|
</dd>
|
|
2980
3929
|
</dl>
|
|
@@ -2982,7 +3931,15 @@ await client.graph.edge.delete("uuid");
|
|
|
2982
3931
|
<dl>
|
|
2983
3932
|
<dd>
|
|
2984
3933
|
|
|
2985
|
-
**
|
|
3934
|
+
**request:** `Zep.graph.UpdateEpisodeRequest`
|
|
3935
|
+
|
|
3936
|
+
</dd>
|
|
3937
|
+
</dl>
|
|
3938
|
+
|
|
3939
|
+
<dl>
|
|
3940
|
+
<dd>
|
|
3941
|
+
|
|
3942
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2986
3943
|
|
|
2987
3944
|
</dd>
|
|
2988
3945
|
</dl>
|
|
@@ -2993,7 +3950,7 @@ await client.graph.edge.delete("uuid");
|
|
|
2993
3950
|
</dl>
|
|
2994
3951
|
</details>
|
|
2995
3952
|
|
|
2996
|
-
<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>
|
|
2997
3954
|
<dl>
|
|
2998
3955
|
<dd>
|
|
2999
3956
|
|
|
@@ -3005,7 +3962,7 @@ await client.graph.edge.delete("uuid");
|
|
|
3005
3962
|
<dl>
|
|
3006
3963
|
<dd>
|
|
3007
3964
|
|
|
3008
|
-
|
|
3965
|
+
Returns nodes and edges mentioned in an episode
|
|
3009
3966
|
|
|
3010
3967
|
</dd>
|
|
3011
3968
|
</dl>
|
|
@@ -3021,7 +3978,7 @@ Updates an entity edge by UUID.
|
|
|
3021
3978
|
<dd>
|
|
3022
3979
|
|
|
3023
3980
|
```typescript
|
|
3024
|
-
await client.graph.
|
|
3981
|
+
await client.graph.episode.getNodesAndEdges("uuid");
|
|
3025
3982
|
```
|
|
3026
3983
|
|
|
3027
3984
|
</dd>
|
|
@@ -3037,15 +3994,7 @@ await client.graph.edge.update("uuid");
|
|
|
3037
3994
|
<dl>
|
|
3038
3995
|
<dd>
|
|
3039
3996
|
|
|
3040
|
-
**uuid:** `string` —
|
|
3041
|
-
|
|
3042
|
-
</dd>
|
|
3043
|
-
</dl>
|
|
3044
|
-
|
|
3045
|
-
<dl>
|
|
3046
|
-
<dd>
|
|
3047
|
-
|
|
3048
|
-
**request:** `Zep.graph.UpdateEdgeRequest`
|
|
3997
|
+
**uuid:** `string` — Episode uuid
|
|
3049
3998
|
|
|
3050
3999
|
</dd>
|
|
3051
4000
|
</dl>
|
|
@@ -3053,7 +4002,7 @@ await client.graph.edge.update("uuid");
|
|
|
3053
4002
|
<dl>
|
|
3054
4003
|
<dd>
|
|
3055
4004
|
|
|
3056
|
-
**requestOptions:** `
|
|
4005
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
3057
4006
|
|
|
3058
4007
|
</dd>
|
|
3059
4008
|
</dl>
|
|
@@ -3064,9 +4013,9 @@ await client.graph.edge.update("uuid");
|
|
|
3064
4013
|
</dl>
|
|
3065
4014
|
</details>
|
|
3066
4015
|
|
|
3067
|
-
## Graph
|
|
4016
|
+
## Graph Node
|
|
3068
4017
|
|
|
3069
|
-
<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>
|
|
3070
4019
|
<dl>
|
|
3071
4020
|
<dd>
|
|
3072
4021
|
|
|
@@ -3078,7 +4027,7 @@ await client.graph.edge.update("uuid");
|
|
|
3078
4027
|
<dl>
|
|
3079
4028
|
<dd>
|
|
3080
4029
|
|
|
3081
|
-
Returns
|
|
4030
|
+
Returns all nodes for a graph.
|
|
3082
4031
|
|
|
3083
4032
|
</dd>
|
|
3084
4033
|
</dl>
|
|
@@ -3094,9 +4043,7 @@ Returns episodes by graph id.
|
|
|
3094
4043
|
<dd>
|
|
3095
4044
|
|
|
3096
4045
|
```typescript
|
|
3097
|
-
await client.graph.
|
|
3098
|
-
lastn: 1,
|
|
3099
|
-
});
|
|
4046
|
+
await client.graph.node.getByGraphId("graph_id", {});
|
|
3100
4047
|
```
|
|
3101
4048
|
|
|
3102
4049
|
</dd>
|
|
@@ -3120,7 +4067,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3120
4067
|
<dl>
|
|
3121
4068
|
<dd>
|
|
3122
4069
|
|
|
3123
|
-
**request:** `Zep.
|
|
4070
|
+
**request:** `Zep.GraphNodesRequest`
|
|
3124
4071
|
|
|
3125
4072
|
</dd>
|
|
3126
4073
|
</dl>
|
|
@@ -3128,7 +4075,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3128
4075
|
<dl>
|
|
3129
4076
|
<dd>
|
|
3130
4077
|
|
|
3131
|
-
**requestOptions:** `
|
|
4078
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3132
4079
|
|
|
3133
4080
|
</dd>
|
|
3134
4081
|
</dl>
|
|
@@ -3139,7 +4086,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3139
4086
|
</dl>
|
|
3140
4087
|
</details>
|
|
3141
4088
|
|
|
3142
|
-
<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>
|
|
3143
4090
|
<dl>
|
|
3144
4091
|
<dd>
|
|
3145
4092
|
|
|
@@ -3151,7 +4098,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3151
4098
|
<dl>
|
|
3152
4099
|
<dd>
|
|
3153
4100
|
|
|
3154
|
-
Returns
|
|
4101
|
+
Returns all nodes for a user
|
|
3155
4102
|
|
|
3156
4103
|
</dd>
|
|
3157
4104
|
</dl>
|
|
@@ -3167,9 +4114,7 @@ Returns episodes by user id.
|
|
|
3167
4114
|
<dd>
|
|
3168
4115
|
|
|
3169
4116
|
```typescript
|
|
3170
|
-
await client.graph.
|
|
3171
|
-
lastn: 1,
|
|
3172
|
-
});
|
|
4117
|
+
await client.graph.node.getByUserId("user_id", {});
|
|
3173
4118
|
```
|
|
3174
4119
|
|
|
3175
4120
|
</dd>
|
|
@@ -3193,7 +4138,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3193
4138
|
<dl>
|
|
3194
4139
|
<dd>
|
|
3195
4140
|
|
|
3196
|
-
**request:** `Zep.
|
|
4141
|
+
**request:** `Zep.GraphNodesRequest`
|
|
3197
4142
|
|
|
3198
4143
|
</dd>
|
|
3199
4144
|
</dl>
|
|
@@ -3201,7 +4146,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3201
4146
|
<dl>
|
|
3202
4147
|
<dd>
|
|
3203
4148
|
|
|
3204
|
-
**requestOptions:** `
|
|
4149
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3205
4150
|
|
|
3206
4151
|
</dd>
|
|
3207
4152
|
</dl>
|
|
@@ -3212,7 +4157,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3212
4157
|
</dl>
|
|
3213
4158
|
</details>
|
|
3214
4159
|
|
|
3215
|
-
<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>
|
|
3216
4161
|
<dl>
|
|
3217
4162
|
<dd>
|
|
3218
4163
|
|
|
@@ -3224,7 +4169,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3224
4169
|
<dl>
|
|
3225
4170
|
<dd>
|
|
3226
4171
|
|
|
3227
|
-
Returns
|
|
4172
|
+
Returns all edges for a node
|
|
3228
4173
|
|
|
3229
4174
|
</dd>
|
|
3230
4175
|
</dl>
|
|
@@ -3240,7 +4185,7 @@ Returns episodes by UUID
|
|
|
3240
4185
|
<dd>
|
|
3241
4186
|
|
|
3242
4187
|
```typescript
|
|
3243
|
-
await client.graph.
|
|
4188
|
+
await client.graph.node.getEdges("node_uuid");
|
|
3244
4189
|
```
|
|
3245
4190
|
|
|
3246
4191
|
</dd>
|
|
@@ -3256,7 +4201,7 @@ await client.graph.episode.get("uuid");
|
|
|
3256
4201
|
<dl>
|
|
3257
4202
|
<dd>
|
|
3258
4203
|
|
|
3259
|
-
**
|
|
4204
|
+
**nodeUuid:** `string` — Node UUID
|
|
3260
4205
|
|
|
3261
4206
|
</dd>
|
|
3262
4207
|
</dl>
|
|
@@ -3264,7 +4209,7 @@ await client.graph.episode.get("uuid");
|
|
|
3264
4209
|
<dl>
|
|
3265
4210
|
<dd>
|
|
3266
4211
|
|
|
3267
|
-
**requestOptions:** `
|
|
4212
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3268
4213
|
|
|
3269
4214
|
</dd>
|
|
3270
4215
|
</dl>
|
|
@@ -3275,7 +4220,7 @@ await client.graph.episode.get("uuid");
|
|
|
3275
4220
|
</dl>
|
|
3276
4221
|
</details>
|
|
3277
4222
|
|
|
3278
|
-
<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>
|
|
3279
4224
|
<dl>
|
|
3280
4225
|
<dd>
|
|
3281
4226
|
|
|
@@ -3287,7 +4232,7 @@ await client.graph.episode.get("uuid");
|
|
|
3287
4232
|
<dl>
|
|
3288
4233
|
<dd>
|
|
3289
4234
|
|
|
3290
|
-
|
|
4235
|
+
Returns all episodes that mentioned a given node
|
|
3291
4236
|
|
|
3292
4237
|
</dd>
|
|
3293
4238
|
</dl>
|
|
@@ -3303,7 +4248,7 @@ Deletes an episode by its UUID.
|
|
|
3303
4248
|
<dd>
|
|
3304
4249
|
|
|
3305
4250
|
```typescript
|
|
3306
|
-
await client.graph.
|
|
4251
|
+
await client.graph.node.getEpisodes("node_uuid");
|
|
3307
4252
|
```
|
|
3308
4253
|
|
|
3309
4254
|
</dd>
|
|
@@ -3319,7 +4264,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3319
4264
|
<dl>
|
|
3320
4265
|
<dd>
|
|
3321
4266
|
|
|
3322
|
-
**
|
|
4267
|
+
**nodeUuid:** `string` — Node UUID
|
|
3323
4268
|
|
|
3324
4269
|
</dd>
|
|
3325
4270
|
</dl>
|
|
@@ -3327,7 +4272,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3327
4272
|
<dl>
|
|
3328
4273
|
<dd>
|
|
3329
4274
|
|
|
3330
|
-
**requestOptions:** `
|
|
4275
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3331
4276
|
|
|
3332
4277
|
</dd>
|
|
3333
4278
|
</dl>
|
|
@@ -3338,7 +4283,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3338
4283
|
</dl>
|
|
3339
4284
|
</details>
|
|
3340
4285
|
|
|
3341
|
-
<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>
|
|
3342
4287
|
<dl>
|
|
3343
4288
|
<dd>
|
|
3344
4289
|
|
|
@@ -3350,7 +4295,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3350
4295
|
<dl>
|
|
3351
4296
|
<dd>
|
|
3352
4297
|
|
|
3353
|
-
Returns
|
|
4298
|
+
Returns a specific node by its UUID.
|
|
3354
4299
|
|
|
3355
4300
|
</dd>
|
|
3356
4301
|
</dl>
|
|
@@ -3366,7 +4311,7 @@ Returns nodes and edges mentioned in an episode
|
|
|
3366
4311
|
<dd>
|
|
3367
4312
|
|
|
3368
4313
|
```typescript
|
|
3369
|
-
await client.graph.
|
|
4314
|
+
await client.graph.node.get("uuid");
|
|
3370
4315
|
```
|
|
3371
4316
|
|
|
3372
4317
|
</dd>
|
|
@@ -3382,7 +4327,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3382
4327
|
<dl>
|
|
3383
4328
|
<dd>
|
|
3384
4329
|
|
|
3385
|
-
**uuid:** `string` —
|
|
4330
|
+
**uuid:** `string` — Node UUID
|
|
3386
4331
|
|
|
3387
4332
|
</dd>
|
|
3388
4333
|
</dl>
|
|
@@ -3390,7 +4335,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3390
4335
|
<dl>
|
|
3391
4336
|
<dd>
|
|
3392
4337
|
|
|
3393
|
-
**requestOptions:** `
|
|
4338
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3394
4339
|
|
|
3395
4340
|
</dd>
|
|
3396
4341
|
</dl>
|
|
@@ -3401,9 +4346,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3401
4346
|
</dl>
|
|
3402
4347
|
</details>
|
|
3403
4348
|
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
|
-
<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>
|
|
3407
4350
|
<dl>
|
|
3408
4351
|
<dd>
|
|
3409
4352
|
|
|
@@ -3415,7 +4358,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3415
4358
|
<dl>
|
|
3416
4359
|
<dd>
|
|
3417
4360
|
|
|
3418
|
-
|
|
4361
|
+
Deletes a node by UUID.
|
|
3419
4362
|
|
|
3420
4363
|
</dd>
|
|
3421
4364
|
</dl>
|
|
@@ -3431,7 +4374,7 @@ Returns all nodes for a graph.
|
|
|
3431
4374
|
<dd>
|
|
3432
4375
|
|
|
3433
4376
|
```typescript
|
|
3434
|
-
await client.graph.node.
|
|
4377
|
+
await client.graph.node.delete("uuid");
|
|
3435
4378
|
```
|
|
3436
4379
|
|
|
3437
4380
|
</dd>
|
|
@@ -3447,15 +4390,7 @@ await client.graph.node.getByGraphId("graph_id", {});
|
|
|
3447
4390
|
<dl>
|
|
3448
4391
|
<dd>
|
|
3449
4392
|
|
|
3450
|
-
**
|
|
3451
|
-
|
|
3452
|
-
</dd>
|
|
3453
|
-
</dl>
|
|
3454
|
-
|
|
3455
|
-
<dl>
|
|
3456
|
-
<dd>
|
|
3457
|
-
|
|
3458
|
-
**request:** `Zep.GraphNodesRequest`
|
|
4393
|
+
**uuid:** `string` — Node UUID
|
|
3459
4394
|
|
|
3460
4395
|
</dd>
|
|
3461
4396
|
</dl>
|
|
@@ -3474,7 +4409,7 @@ await client.graph.node.getByGraphId("graph_id", {});
|
|
|
3474
4409
|
</dl>
|
|
3475
4410
|
</details>
|
|
3476
4411
|
|
|
3477
|
-
<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>
|
|
3478
4413
|
<dl>
|
|
3479
4414
|
<dd>
|
|
3480
4415
|
|
|
@@ -3486,7 +4421,7 @@ await client.graph.node.getByGraphId("graph_id", {});
|
|
|
3486
4421
|
<dl>
|
|
3487
4422
|
<dd>
|
|
3488
4423
|
|
|
3489
|
-
|
|
4424
|
+
Updates an entity node by UUID.
|
|
3490
4425
|
|
|
3491
4426
|
</dd>
|
|
3492
4427
|
</dl>
|
|
@@ -3502,7 +4437,7 @@ Returns all nodes for a user
|
|
|
3502
4437
|
<dd>
|
|
3503
4438
|
|
|
3504
4439
|
```typescript
|
|
3505
|
-
await client.graph.node.
|
|
4440
|
+
await client.graph.node.update("uuid");
|
|
3506
4441
|
```
|
|
3507
4442
|
|
|
3508
4443
|
</dd>
|
|
@@ -3518,7 +4453,7 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3518
4453
|
<dl>
|
|
3519
4454
|
<dd>
|
|
3520
4455
|
|
|
3521
|
-
**
|
|
4456
|
+
**uuid:** `string` — Node UUID
|
|
3522
4457
|
|
|
3523
4458
|
</dd>
|
|
3524
4459
|
</dl>
|
|
@@ -3526,7 +4461,7 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3526
4461
|
<dl>
|
|
3527
4462
|
<dd>
|
|
3528
4463
|
|
|
3529
|
-
**request:** `Zep.
|
|
4464
|
+
**request:** `Zep.graph.UpdateNodeRequest`
|
|
3530
4465
|
|
|
3531
4466
|
</dd>
|
|
3532
4467
|
</dl>
|
|
@@ -3545,7 +4480,9 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3545
4480
|
</dl>
|
|
3546
4481
|
</details>
|
|
3547
4482
|
|
|
3548
|
-
|
|
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>
|
|
3549
4486
|
<dl>
|
|
3550
4487
|
<dd>
|
|
3551
4488
|
|
|
@@ -3557,7 +4494,7 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3557
4494
|
<dl>
|
|
3558
4495
|
<dd>
|
|
3559
4496
|
|
|
3560
|
-
Returns
|
|
4497
|
+
Returns read-only observation nodes for a graph.
|
|
3561
4498
|
|
|
3562
4499
|
</dd>
|
|
3563
4500
|
</dl>
|
|
@@ -3573,7 +4510,7 @@ Returns all edges for a node
|
|
|
3573
4510
|
<dd>
|
|
3574
4511
|
|
|
3575
4512
|
```typescript
|
|
3576
|
-
await client.graph.
|
|
4513
|
+
await client.graph.observation.getByGraphId("graph_id", {});
|
|
3577
4514
|
```
|
|
3578
4515
|
|
|
3579
4516
|
</dd>
|
|
@@ -3589,7 +4526,7 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3589
4526
|
<dl>
|
|
3590
4527
|
<dd>
|
|
3591
4528
|
|
|
3592
|
-
**
|
|
4529
|
+
**graphId:** `string` — Graph ID
|
|
3593
4530
|
|
|
3594
4531
|
</dd>
|
|
3595
4532
|
</dl>
|
|
@@ -3597,7 +4534,15 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3597
4534
|
<dl>
|
|
3598
4535
|
<dd>
|
|
3599
4536
|
|
|
3600
|
-
**
|
|
4537
|
+
**request:** `Zep.GraphObservationsRequest`
|
|
4538
|
+
|
|
4539
|
+
</dd>
|
|
4540
|
+
</dl>
|
|
4541
|
+
|
|
4542
|
+
<dl>
|
|
4543
|
+
<dd>
|
|
4544
|
+
|
|
4545
|
+
**requestOptions:** `Observation.RequestOptions`
|
|
3601
4546
|
|
|
3602
4547
|
</dd>
|
|
3603
4548
|
</dl>
|
|
@@ -3608,7 +4553,7 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3608
4553
|
</dl>
|
|
3609
4554
|
</details>
|
|
3610
4555
|
|
|
3611
|
-
<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>
|
|
3612
4557
|
<dl>
|
|
3613
4558
|
<dd>
|
|
3614
4559
|
|
|
@@ -3620,7 +4565,7 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3620
4565
|
<dl>
|
|
3621
4566
|
<dd>
|
|
3622
4567
|
|
|
3623
|
-
Returns
|
|
4568
|
+
Returns read-only observation nodes for a user's graph.
|
|
3624
4569
|
|
|
3625
4570
|
</dd>
|
|
3626
4571
|
</dl>
|
|
@@ -3636,7 +4581,7 @@ Returns all episodes that mentioned a given node
|
|
|
3636
4581
|
<dd>
|
|
3637
4582
|
|
|
3638
4583
|
```typescript
|
|
3639
|
-
await client.graph.
|
|
4584
|
+
await client.graph.observation.getByUserId("user_id", {});
|
|
3640
4585
|
```
|
|
3641
4586
|
|
|
3642
4587
|
</dd>
|
|
@@ -3652,7 +4597,7 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3652
4597
|
<dl>
|
|
3653
4598
|
<dd>
|
|
3654
4599
|
|
|
3655
|
-
**
|
|
4600
|
+
**userId:** `string` — User ID
|
|
3656
4601
|
|
|
3657
4602
|
</dd>
|
|
3658
4603
|
</dl>
|
|
@@ -3660,7 +4605,15 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3660
4605
|
<dl>
|
|
3661
4606
|
<dd>
|
|
3662
4607
|
|
|
3663
|
-
**
|
|
4608
|
+
**request:** `Zep.GraphObservationsRequest`
|
|
4609
|
+
|
|
4610
|
+
</dd>
|
|
4611
|
+
</dl>
|
|
4612
|
+
|
|
4613
|
+
<dl>
|
|
4614
|
+
<dd>
|
|
4615
|
+
|
|
4616
|
+
**requestOptions:** `Observation.RequestOptions`
|
|
3664
4617
|
|
|
3665
4618
|
</dd>
|
|
3666
4619
|
</dl>
|
|
@@ -3671,7 +4624,7 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3671
4624
|
</dl>
|
|
3672
4625
|
</details>
|
|
3673
4626
|
|
|
3674
|
-
<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>
|
|
3675
4628
|
<dl>
|
|
3676
4629
|
<dd>
|
|
3677
4630
|
|
|
@@ -3683,7 +4636,7 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3683
4636
|
<dl>
|
|
3684
4637
|
<dd>
|
|
3685
4638
|
|
|
3686
|
-
Returns a specific node by
|
|
4639
|
+
Returns a specific observation node by UUID. Observation nodes are read-only.
|
|
3687
4640
|
|
|
3688
4641
|
</dd>
|
|
3689
4642
|
</dl>
|
|
@@ -3699,7 +4652,7 @@ Returns a specific node by its UUID.
|
|
|
3699
4652
|
<dd>
|
|
3700
4653
|
|
|
3701
4654
|
```typescript
|
|
3702
|
-
await client.graph.
|
|
4655
|
+
await client.graph.observation.get("uuid");
|
|
3703
4656
|
```
|
|
3704
4657
|
|
|
3705
4658
|
</dd>
|
|
@@ -3715,7 +4668,7 @@ await client.graph.node.get("uuid");
|
|
|
3715
4668
|
<dl>
|
|
3716
4669
|
<dd>
|
|
3717
4670
|
|
|
3718
|
-
**uuid:** `string` —
|
|
4671
|
+
**uuid:** `string` — Observation UUID
|
|
3719
4672
|
|
|
3720
4673
|
</dd>
|
|
3721
4674
|
</dl>
|
|
@@ -3723,7 +4676,7 @@ await client.graph.node.get("uuid");
|
|
|
3723
4676
|
<dl>
|
|
3724
4677
|
<dd>
|
|
3725
4678
|
|
|
3726
|
-
**requestOptions:** `
|
|
4679
|
+
**requestOptions:** `Observation.RequestOptions`
|
|
3727
4680
|
|
|
3728
4681
|
</dd>
|
|
3729
4682
|
</dl>
|
|
@@ -3734,7 +4687,9 @@ await client.graph.node.get("uuid");
|
|
|
3734
4687
|
</dl>
|
|
3735
4688
|
</details>
|
|
3736
4689
|
|
|
3737
|
-
|
|
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>
|
|
3738
4693
|
<dl>
|
|
3739
4694
|
<dd>
|
|
3740
4695
|
|
|
@@ -3746,7 +4701,7 @@ await client.graph.node.get("uuid");
|
|
|
3746
4701
|
<dl>
|
|
3747
4702
|
<dd>
|
|
3748
4703
|
|
|
3749
|
-
|
|
4704
|
+
Returns incremental thread summaries associated with the graph.
|
|
3750
4705
|
|
|
3751
4706
|
</dd>
|
|
3752
4707
|
</dl>
|
|
@@ -3762,7 +4717,7 @@ Deletes a node by UUID.
|
|
|
3762
4717
|
<dd>
|
|
3763
4718
|
|
|
3764
4719
|
```typescript
|
|
3765
|
-
await client.graph.
|
|
4720
|
+
await client.graph.threadSummary.getByGraphId("graph_id", {});
|
|
3766
4721
|
```
|
|
3767
4722
|
|
|
3768
4723
|
</dd>
|
|
@@ -3778,7 +4733,7 @@ await client.graph.node.delete("uuid");
|
|
|
3778
4733
|
<dl>
|
|
3779
4734
|
<dd>
|
|
3780
4735
|
|
|
3781
|
-
**
|
|
4736
|
+
**graphId:** `string` — Graph ID
|
|
3782
4737
|
|
|
3783
4738
|
</dd>
|
|
3784
4739
|
</dl>
|
|
@@ -3786,7 +4741,15 @@ await client.graph.node.delete("uuid");
|
|
|
3786
4741
|
<dl>
|
|
3787
4742
|
<dd>
|
|
3788
4743
|
|
|
3789
|
-
**
|
|
4744
|
+
**request:** `Zep.GraphThreadSummariesRequest`
|
|
4745
|
+
|
|
4746
|
+
</dd>
|
|
4747
|
+
</dl>
|
|
4748
|
+
|
|
4749
|
+
<dl>
|
|
4750
|
+
<dd>
|
|
4751
|
+
|
|
4752
|
+
**requestOptions:** `ThreadSummary.RequestOptions`
|
|
3790
4753
|
|
|
3791
4754
|
</dd>
|
|
3792
4755
|
</dl>
|
|
@@ -3797,7 +4760,7 @@ await client.graph.node.delete("uuid");
|
|
|
3797
4760
|
</dl>
|
|
3798
4761
|
</details>
|
|
3799
4762
|
|
|
3800
|
-
<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>
|
|
3801
4764
|
<dl>
|
|
3802
4765
|
<dd>
|
|
3803
4766
|
|
|
@@ -3809,7 +4772,7 @@ await client.graph.node.delete("uuid");
|
|
|
3809
4772
|
<dl>
|
|
3810
4773
|
<dd>
|
|
3811
4774
|
|
|
3812
|
-
|
|
4775
|
+
Returns incremental thread summaries generated from messages in each thread associated with the user's graph.
|
|
3813
4776
|
|
|
3814
4777
|
</dd>
|
|
3815
4778
|
</dl>
|
|
@@ -3825,7 +4788,7 @@ Updates an entity node by UUID.
|
|
|
3825
4788
|
<dd>
|
|
3826
4789
|
|
|
3827
4790
|
```typescript
|
|
3828
|
-
await client.graph.
|
|
4791
|
+
await client.graph.threadSummary.getByUserId("user_id", {});
|
|
3829
4792
|
```
|
|
3830
4793
|
|
|
3831
4794
|
</dd>
|
|
@@ -3841,7 +4804,7 @@ await client.graph.node.update("uuid");
|
|
|
3841
4804
|
<dl>
|
|
3842
4805
|
<dd>
|
|
3843
4806
|
|
|
3844
|
-
**
|
|
4807
|
+
**userId:** `string` — User ID
|
|
3845
4808
|
|
|
3846
4809
|
</dd>
|
|
3847
4810
|
</dl>
|
|
@@ -3849,7 +4812,7 @@ await client.graph.node.update("uuid");
|
|
|
3849
4812
|
<dl>
|
|
3850
4813
|
<dd>
|
|
3851
4814
|
|
|
3852
|
-
**request:** `Zep.
|
|
4815
|
+
**request:** `Zep.GraphThreadSummariesRequest`
|
|
3853
4816
|
|
|
3854
4817
|
</dd>
|
|
3855
4818
|
</dl>
|
|
@@ -3857,7 +4820,7 @@ await client.graph.node.update("uuid");
|
|
|
3857
4820
|
<dl>
|
|
3858
4821
|
<dd>
|
|
3859
4822
|
|
|
3860
|
-
**requestOptions:** `
|
|
4823
|
+
**requestOptions:** `ThreadSummary.RequestOptions`
|
|
3861
4824
|
|
|
3862
4825
|
</dd>
|
|
3863
4826
|
</dl>
|