@getzep/zep-cloud 3.18.0 → 3.23.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 +18 -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 +24 -1
- package/dist/cjs/api/resources/graph/client/Client.js +109 -102
- package/dist/cjs/api/resources/graph/client/requests/AddDataRequest.d.ts +2 -0
- package/dist/cjs/api/resources/graph/client/requests/AddTripleRequest.d.ts +19 -2
- 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 -3
- 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 +19 -2
- package/dist/cjs/api/resources/thread/client/Client.js +96 -16
- package/dist/cjs/api/resources/thread/client/requests/ThreadGetRequest.d.ts +1 -1
- 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 +24 -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 +13 -0
- package/dist/cjs/api/types/BatchItemStatus.js +15 -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 +13 -0
- package/dist/cjs/api/types/BatchProgress.js +5 -0
- package/dist/cjs/api/types/BatchStatus.d.ts +14 -0
- package/dist/cjs/api/types/BatchStatus.js +16 -0
- package/dist/cjs/api/types/BatchSummary.d.ts +16 -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 +44 -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/GraphSearchResponseMetadata.d.ts +7 -0
- package/dist/cjs/api/types/GraphSearchResponseMetadata.js +5 -0
- package/dist/cjs/api/types/GraphSearchResults.d.ts +4 -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 +35 -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 +31 -0
- package/dist/cjs/api/types/ThreadSummary.js +5 -0
- package/dist/cjs/api/types/index.d.ts +20 -0
- package/dist/cjs/api/types/index.js +20 -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 +14 -0
- package/dist/cjs/serialization/resources/batch/client/requests/ApidataCreateBatchRequest.js +45 -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 +19 -0
- package/dist/cjs/serialization/types/BatchProgress.js +50 -0
- package/dist/cjs/serialization/types/BatchStatus.d.ts +10 -0
- package/dist/cjs/serialization/types/BatchStatus.js +50 -0
- package/dist/cjs/serialization/types/BatchSummary.d.ts +24 -0
- package/dist/cjs/serialization/types/BatchSummary.js +55 -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 +24 -0
- package/dist/cjs/serialization/types/DerivedNode.js +55 -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/GraphSearchResponseMetadata.d.ts +12 -0
- package/dist/cjs/serialization/types/GraphSearchResponseMetadata.js +43 -0
- package/dist/cjs/serialization/types/GraphSearchResults.d.ts +7 -0
- package/dist/cjs/serialization/types/GraphSearchResults.js +7 -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 +21 -0
- package/dist/cjs/serialization/types/GraphitiSagaNode.js +52 -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 +17 -0
- package/dist/cjs/serialization/types/ThreadSummary.js +48 -0
- package/dist/cjs/serialization/types/index.d.ts +20 -0
- package/dist/cjs/serialization/types/index.js +20 -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 +18 -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 +24 -1
- package/dist/esm/api/resources/graph/client/Client.mjs +109 -102
- package/dist/esm/api/resources/graph/client/requests/AddDataRequest.d.mts +2 -0
- package/dist/esm/api/resources/graph/client/requests/AddTripleRequest.d.mts +19 -2
- 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 -3
- 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 +19 -2
- package/dist/esm/api/resources/thread/client/Client.mjs +96 -16
- package/dist/esm/api/resources/thread/client/requests/ThreadGetRequest.d.mts +1 -1
- 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 +24 -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 +13 -0
- package/dist/esm/api/types/BatchItemStatus.mjs +12 -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 +13 -0
- package/dist/esm/api/types/BatchProgress.mjs +4 -0
- package/dist/esm/api/types/BatchStatus.d.mts +14 -0
- package/dist/esm/api/types/BatchStatus.mjs +13 -0
- package/dist/esm/api/types/BatchSummary.d.mts +16 -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 +44 -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/GraphSearchResponseMetadata.d.mts +7 -0
- package/dist/esm/api/types/GraphSearchResponseMetadata.mjs +4 -0
- package/dist/esm/api/types/GraphSearchResults.d.mts +4 -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 +35 -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 +31 -0
- package/dist/esm/api/types/ThreadSummary.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +20 -0
- package/dist/esm/api/types/index.mjs +20 -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 +14 -0
- package/dist/esm/serialization/resources/batch/client/requests/ApidataCreateBatchRequest.mjs +9 -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 +19 -0
- package/dist/esm/serialization/types/BatchProgress.mjs +14 -0
- package/dist/esm/serialization/types/BatchStatus.d.mts +10 -0
- package/dist/esm/serialization/types/BatchStatus.mjs +14 -0
- package/dist/esm/serialization/types/BatchSummary.d.mts +24 -0
- package/dist/esm/serialization/types/BatchSummary.mjs +19 -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 +24 -0
- package/dist/esm/serialization/types/DerivedNode.mjs +19 -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/GraphSearchResponseMetadata.d.mts +12 -0
- package/dist/esm/serialization/types/GraphSearchResponseMetadata.mjs +7 -0
- package/dist/esm/serialization/types/GraphSearchResults.d.mts +7 -0
- package/dist/esm/serialization/types/GraphSearchResults.mjs +7 -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 +21 -0
- package/dist/esm/serialization/types/GraphitiSagaNode.mjs +16 -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 +17 -0
- package/dist/esm/serialization/types/ThreadSummary.mjs +12 -0
- package/dist/esm/serialization/types/index.d.mts +20 -0
- package/dist/esm/serialization/types/index.mjs +20 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +16 -9
- package/reference.md +1481 -451
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,9 @@ await client.graph.search({
|
|
|
1193
1203
|
<dl>
|
|
1194
1204
|
<dd>
|
|
1195
1205
|
|
|
1196
|
-
|
|
1206
|
+
Deprecated. Use the [Batch API](/adding-batch-data) (`client.batch.*`) instead.
|
|
1207
|
+
|
|
1208
|
+
Adds data to the graph in batch mode, processing episodes concurrently.
|
|
1197
1209
|
|
|
1198
1210
|
</dd>
|
|
1199
1211
|
</dl>
|
|
@@ -1209,7 +1221,14 @@ Returns a graph.
|
|
|
1209
1221
|
<dd>
|
|
1210
1222
|
|
|
1211
1223
|
```typescript
|
|
1212
|
-
await client.graph.
|
|
1224
|
+
await client.graph.addBatch({
|
|
1225
|
+
episodes: [
|
|
1226
|
+
{
|
|
1227
|
+
data: "data",
|
|
1228
|
+
type: "text",
|
|
1229
|
+
},
|
|
1230
|
+
],
|
|
1231
|
+
});
|
|
1213
1232
|
```
|
|
1214
1233
|
|
|
1215
1234
|
</dd>
|
|
@@ -1225,7 +1244,7 @@ await client.graph.get("graphId");
|
|
|
1225
1244
|
<dl>
|
|
1226
1245
|
<dd>
|
|
1227
1246
|
|
|
1228
|
-
**
|
|
1247
|
+
**request:** `Zep.AddDataBatchRequest`
|
|
1229
1248
|
|
|
1230
1249
|
</dd>
|
|
1231
1250
|
</dl>
|
|
@@ -1244,7 +1263,7 @@ await client.graph.get("graphId");
|
|
|
1244
1263
|
</dl>
|
|
1245
1264
|
</details>
|
|
1246
1265
|
|
|
1247
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">
|
|
1266
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">addFactTriple</a>({ ...params }) -> Zep.AddTripleResponse</code></summary>
|
|
1248
1267
|
<dl>
|
|
1249
1268
|
<dd>
|
|
1250
1269
|
|
|
@@ -1256,7 +1275,7 @@ await client.graph.get("graphId");
|
|
|
1256
1275
|
<dl>
|
|
1257
1276
|
<dd>
|
|
1258
1277
|
|
|
1259
|
-
|
|
1278
|
+
Add a fact triple for a user or group
|
|
1260
1279
|
|
|
1261
1280
|
</dd>
|
|
1262
1281
|
</dl>
|
|
@@ -1272,7 +1291,10 @@ Deletes a graph. If you would like to delete a user graph, make sure to use user
|
|
|
1272
1291
|
<dd>
|
|
1273
1292
|
|
|
1274
1293
|
```typescript
|
|
1275
|
-
await client.graph.
|
|
1294
|
+
await client.graph.addFactTriple({
|
|
1295
|
+
fact: "fact",
|
|
1296
|
+
factName: "fact_name",
|
|
1297
|
+
});
|
|
1276
1298
|
```
|
|
1277
1299
|
|
|
1278
1300
|
</dd>
|
|
@@ -1288,7 +1310,7 @@ await client.graph.delete("graphId");
|
|
|
1288
1310
|
<dl>
|
|
1289
1311
|
<dd>
|
|
1290
1312
|
|
|
1291
|
-
**
|
|
1313
|
+
**request:** `Zep.AddTripleRequest`
|
|
1292
1314
|
|
|
1293
1315
|
</dd>
|
|
1294
1316
|
</dl>
|
|
@@ -1307,7 +1329,7 @@ await client.graph.delete("graphId");
|
|
|
1307
1329
|
</dl>
|
|
1308
1330
|
</details>
|
|
1309
1331
|
|
|
1310
|
-
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">
|
|
1332
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">clone</a>({ ...params }) -> Zep.CloneGraphResponse</code></summary>
|
|
1311
1333
|
<dl>
|
|
1312
1334
|
<dd>
|
|
1313
1335
|
|
|
@@ -1319,7 +1341,7 @@ await client.graph.delete("graphId");
|
|
|
1319
1341
|
<dl>
|
|
1320
1342
|
<dd>
|
|
1321
1343
|
|
|
1322
|
-
|
|
1344
|
+
Clone a user or group graph.
|
|
1323
1345
|
|
|
1324
1346
|
</dd>
|
|
1325
1347
|
</dl>
|
|
@@ -1335,7 +1357,7 @@ Updates information about a graph.
|
|
|
1335
1357
|
<dd>
|
|
1336
1358
|
|
|
1337
1359
|
```typescript
|
|
1338
|
-
await client.graph.
|
|
1360
|
+
await client.graph.clone();
|
|
1339
1361
|
```
|
|
1340
1362
|
|
|
1341
1363
|
</dd>
|
|
@@ -1351,7 +1373,7 @@ await client.graph.update("graphId");
|
|
|
1351
1373
|
<dl>
|
|
1352
1374
|
<dd>
|
|
1353
1375
|
|
|
1354
|
-
**
|
|
1376
|
+
**request:** `Zep.CloneGraphRequest`
|
|
1355
1377
|
|
|
1356
1378
|
</dd>
|
|
1357
1379
|
</dl>
|
|
@@ -1359,7 +1381,64 @@ await client.graph.update("graphId");
|
|
|
1359
1381
|
<dl>
|
|
1360
1382
|
<dd>
|
|
1361
1383
|
|
|
1362
|
-
**
|
|
1384
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1385
|
+
|
|
1386
|
+
</dd>
|
|
1387
|
+
</dl>
|
|
1388
|
+
</dd>
|
|
1389
|
+
</dl>
|
|
1390
|
+
|
|
1391
|
+
</dd>
|
|
1392
|
+
</dl>
|
|
1393
|
+
</details>
|
|
1394
|
+
|
|
1395
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">create</a>({ ...params }) -> Zep.Graph</code></summary>
|
|
1396
|
+
<dl>
|
|
1397
|
+
<dd>
|
|
1398
|
+
|
|
1399
|
+
#### 📝 Description
|
|
1400
|
+
|
|
1401
|
+
<dl>
|
|
1402
|
+
<dd>
|
|
1403
|
+
|
|
1404
|
+
<dl>
|
|
1405
|
+
<dd>
|
|
1406
|
+
|
|
1407
|
+
Creates a new graph.
|
|
1408
|
+
|
|
1409
|
+
</dd>
|
|
1410
|
+
</dl>
|
|
1411
|
+
</dd>
|
|
1412
|
+
</dl>
|
|
1413
|
+
|
|
1414
|
+
#### 🔌 Usage
|
|
1415
|
+
|
|
1416
|
+
<dl>
|
|
1417
|
+
<dd>
|
|
1418
|
+
|
|
1419
|
+
<dl>
|
|
1420
|
+
<dd>
|
|
1421
|
+
|
|
1422
|
+
```typescript
|
|
1423
|
+
await client.graph.create({
|
|
1424
|
+
graphId: "graph_id",
|
|
1425
|
+
});
|
|
1426
|
+
```
|
|
1427
|
+
|
|
1428
|
+
</dd>
|
|
1429
|
+
</dl>
|
|
1430
|
+
</dd>
|
|
1431
|
+
</dl>
|
|
1432
|
+
|
|
1433
|
+
#### ⚙️ Parameters
|
|
1434
|
+
|
|
1435
|
+
<dl>
|
|
1436
|
+
<dd>
|
|
1437
|
+
|
|
1438
|
+
<dl>
|
|
1439
|
+
<dd>
|
|
1440
|
+
|
|
1441
|
+
**request:** `Zep.CreateGraphRequest`
|
|
1363
1442
|
|
|
1364
1443
|
</dd>
|
|
1365
1444
|
</dl>
|
|
@@ -1378,9 +1457,7 @@ await client.graph.update("graphId");
|
|
|
1378
1457
|
</dl>
|
|
1379
1458
|
</details>
|
|
1380
1459
|
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
<details><summary><code>client.project.<a href="/src/api/resources/project/client/Client.ts">get</a>() -> Zep.ProjectInfoResponse</code></summary>
|
|
1460
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">listAll</a>({ ...params }) -> Zep.GraphListResponse</code></summary>
|
|
1384
1461
|
<dl>
|
|
1385
1462
|
<dd>
|
|
1386
1463
|
|
|
@@ -1392,7 +1469,7 @@ await client.graph.update("graphId");
|
|
|
1392
1469
|
<dl>
|
|
1393
1470
|
<dd>
|
|
1394
1471
|
|
|
1395
|
-
|
|
1472
|
+
Returns all graphs. In order to list users, use user.list_ordered instead
|
|
1396
1473
|
|
|
1397
1474
|
</dd>
|
|
1398
1475
|
</dl>
|
|
@@ -1408,7 +1485,13 @@ Retrieve project info based on the provided api key.
|
|
|
1408
1485
|
<dd>
|
|
1409
1486
|
|
|
1410
1487
|
```typescript
|
|
1411
|
-
await client.
|
|
1488
|
+
await client.graph.listAll({
|
|
1489
|
+
pageNumber: 1,
|
|
1490
|
+
pageSize: 1,
|
|
1491
|
+
search: "search",
|
|
1492
|
+
orderBy: "order_by",
|
|
1493
|
+
asc: true,
|
|
1494
|
+
});
|
|
1412
1495
|
```
|
|
1413
1496
|
|
|
1414
1497
|
</dd>
|
|
@@ -1424,7 +1507,15 @@ await client.project.get();
|
|
|
1424
1507
|
<dl>
|
|
1425
1508
|
<dd>
|
|
1426
1509
|
|
|
1427
|
-
**
|
|
1510
|
+
**request:** `Zep.GraphListAllRequest`
|
|
1511
|
+
|
|
1512
|
+
</dd>
|
|
1513
|
+
</dl>
|
|
1514
|
+
|
|
1515
|
+
<dl>
|
|
1516
|
+
<dd>
|
|
1517
|
+
|
|
1518
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1428
1519
|
|
|
1429
1520
|
</dd>
|
|
1430
1521
|
</dl>
|
|
@@ -1435,9 +1526,7 @@ await client.project.get();
|
|
|
1435
1526
|
</dl>
|
|
1436
1527
|
</details>
|
|
1437
1528
|
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
<details><summary><code>client.task.<a href="/src/api/resources/task/client/Client.ts">get</a>(taskId) -> Zep.GetTaskResponse</code></summary>
|
|
1529
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">detectPatterns</a>({ ...params }) -> Zep.DetectPatternsResponse</code></summary>
|
|
1441
1530
|
<dl>
|
|
1442
1531
|
<dd>
|
|
1443
1532
|
|
|
@@ -1449,7 +1538,10 @@ await client.project.get();
|
|
|
1449
1538
|
<dl>
|
|
1450
1539
|
<dd>
|
|
1451
1540
|
|
|
1452
|
-
|
|
1541
|
+
Detects structural patterns in a knowledge graph including relationship frequencies,
|
|
1542
|
+
multi-hop paths, co-occurrences, hubs, and clusters.
|
|
1543
|
+
When a query is provided, uses hybrid search to discover seed nodes,
|
|
1544
|
+
detects triple-frequency patterns, and returns resolved edges ranked by relevance.
|
|
1453
1545
|
|
|
1454
1546
|
</dd>
|
|
1455
1547
|
</dl>
|
|
@@ -1465,7 +1557,7 @@ Gets a task by its ID
|
|
|
1465
1557
|
<dd>
|
|
1466
1558
|
|
|
1467
1559
|
```typescript
|
|
1468
|
-
await client.
|
|
1560
|
+
await client.graph.detectPatterns();
|
|
1469
1561
|
```
|
|
1470
1562
|
|
|
1471
1563
|
</dd>
|
|
@@ -1481,7 +1573,7 @@ await client.task.get("task_id");
|
|
|
1481
1573
|
<dl>
|
|
1482
1574
|
<dd>
|
|
1483
1575
|
|
|
1484
|
-
**
|
|
1576
|
+
**request:** `Zep.DetectPatternsRequest`
|
|
1485
1577
|
|
|
1486
1578
|
</dd>
|
|
1487
1579
|
</dl>
|
|
@@ -1489,7 +1581,7 @@ await client.task.get("task_id");
|
|
|
1489
1581
|
<dl>
|
|
1490
1582
|
<dd>
|
|
1491
1583
|
|
|
1492
|
-
**requestOptions:** `
|
|
1584
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1493
1585
|
|
|
1494
1586
|
</dd>
|
|
1495
1587
|
</dl>
|
|
@@ -1500,9 +1592,7 @@ await client.task.get("task_id");
|
|
|
1500
1592
|
</dl>
|
|
1501
1593
|
</details>
|
|
1502
1594
|
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">listAll</a>({ ...params }) -> Zep.ThreadListResponse</code></summary>
|
|
1595
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">search</a>({ ...params }) -> Zep.GraphSearchResults</code></summary>
|
|
1506
1596
|
<dl>
|
|
1507
1597
|
<dd>
|
|
1508
1598
|
|
|
@@ -1514,7 +1604,7 @@ await client.task.get("task_id");
|
|
|
1514
1604
|
<dl>
|
|
1515
1605
|
<dd>
|
|
1516
1606
|
|
|
1517
|
-
|
|
1607
|
+
Perform a graph search query.
|
|
1518
1608
|
|
|
1519
1609
|
</dd>
|
|
1520
1610
|
</dl>
|
|
@@ -1530,11 +1620,8 @@ Returns all threads.
|
|
|
1530
1620
|
<dd>
|
|
1531
1621
|
|
|
1532
1622
|
```typescript
|
|
1533
|
-
await client.
|
|
1534
|
-
|
|
1535
|
-
pageSize: 1,
|
|
1536
|
-
orderBy: "order_by",
|
|
1537
|
-
asc: true,
|
|
1623
|
+
await client.graph.search({
|
|
1624
|
+
query: "query",
|
|
1538
1625
|
});
|
|
1539
1626
|
```
|
|
1540
1627
|
|
|
@@ -1551,7 +1638,7 @@ await client.thread.listAll({
|
|
|
1551
1638
|
<dl>
|
|
1552
1639
|
<dd>
|
|
1553
1640
|
|
|
1554
|
-
**request:** `Zep.
|
|
1641
|
+
**request:** `Zep.GraphSearchQuery`
|
|
1555
1642
|
|
|
1556
1643
|
</dd>
|
|
1557
1644
|
</dl>
|
|
@@ -1559,7 +1646,70 @@ await client.thread.listAll({
|
|
|
1559
1646
|
<dl>
|
|
1560
1647
|
<dd>
|
|
1561
1648
|
|
|
1562
|
-
**requestOptions:** `
|
|
1649
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1650
|
+
|
|
1651
|
+
</dd>
|
|
1652
|
+
</dl>
|
|
1653
|
+
</dd>
|
|
1654
|
+
</dl>
|
|
1655
|
+
|
|
1656
|
+
</dd>
|
|
1657
|
+
</dl>
|
|
1658
|
+
</details>
|
|
1659
|
+
|
|
1660
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">get</a>(graphId) -> Zep.Graph</code></summary>
|
|
1661
|
+
<dl>
|
|
1662
|
+
<dd>
|
|
1663
|
+
|
|
1664
|
+
#### 📝 Description
|
|
1665
|
+
|
|
1666
|
+
<dl>
|
|
1667
|
+
<dd>
|
|
1668
|
+
|
|
1669
|
+
<dl>
|
|
1670
|
+
<dd>
|
|
1671
|
+
|
|
1672
|
+
Returns a graph.
|
|
1673
|
+
|
|
1674
|
+
</dd>
|
|
1675
|
+
</dl>
|
|
1676
|
+
</dd>
|
|
1677
|
+
</dl>
|
|
1678
|
+
|
|
1679
|
+
#### 🔌 Usage
|
|
1680
|
+
|
|
1681
|
+
<dl>
|
|
1682
|
+
<dd>
|
|
1683
|
+
|
|
1684
|
+
<dl>
|
|
1685
|
+
<dd>
|
|
1686
|
+
|
|
1687
|
+
```typescript
|
|
1688
|
+
await client.graph.get("graphId");
|
|
1689
|
+
```
|
|
1690
|
+
|
|
1691
|
+
</dd>
|
|
1692
|
+
</dl>
|
|
1693
|
+
</dd>
|
|
1694
|
+
</dl>
|
|
1695
|
+
|
|
1696
|
+
#### ⚙️ Parameters
|
|
1697
|
+
|
|
1698
|
+
<dl>
|
|
1699
|
+
<dd>
|
|
1700
|
+
|
|
1701
|
+
<dl>
|
|
1702
|
+
<dd>
|
|
1703
|
+
|
|
1704
|
+
**graphId:** `string` — The graph_id of the graph to get.
|
|
1705
|
+
|
|
1706
|
+
</dd>
|
|
1707
|
+
</dl>
|
|
1708
|
+
|
|
1709
|
+
<dl>
|
|
1710
|
+
<dd>
|
|
1711
|
+
|
|
1712
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1563
1713
|
|
|
1564
1714
|
</dd>
|
|
1565
1715
|
</dl>
|
|
@@ -1570,7 +1720,896 @@ await client.thread.listAll({
|
|
|
1570
1720
|
</dl>
|
|
1571
1721
|
</details>
|
|
1572
1722
|
|
|
1573
|
-
<details><summary><code>client.
|
|
1723
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">delete</a>(graphId) -> Zep.SuccessResponse</code></summary>
|
|
1724
|
+
<dl>
|
|
1725
|
+
<dd>
|
|
1726
|
+
|
|
1727
|
+
#### 📝 Description
|
|
1728
|
+
|
|
1729
|
+
<dl>
|
|
1730
|
+
<dd>
|
|
1731
|
+
|
|
1732
|
+
<dl>
|
|
1733
|
+
<dd>
|
|
1734
|
+
|
|
1735
|
+
Deletes a graph. If you would like to delete a user graph, make sure to use user.delete instead.
|
|
1736
|
+
|
|
1737
|
+
</dd>
|
|
1738
|
+
</dl>
|
|
1739
|
+
</dd>
|
|
1740
|
+
</dl>
|
|
1741
|
+
|
|
1742
|
+
#### 🔌 Usage
|
|
1743
|
+
|
|
1744
|
+
<dl>
|
|
1745
|
+
<dd>
|
|
1746
|
+
|
|
1747
|
+
<dl>
|
|
1748
|
+
<dd>
|
|
1749
|
+
|
|
1750
|
+
```typescript
|
|
1751
|
+
await client.graph.delete("graphId");
|
|
1752
|
+
```
|
|
1753
|
+
|
|
1754
|
+
</dd>
|
|
1755
|
+
</dl>
|
|
1756
|
+
</dd>
|
|
1757
|
+
</dl>
|
|
1758
|
+
|
|
1759
|
+
#### ⚙️ Parameters
|
|
1760
|
+
|
|
1761
|
+
<dl>
|
|
1762
|
+
<dd>
|
|
1763
|
+
|
|
1764
|
+
<dl>
|
|
1765
|
+
<dd>
|
|
1766
|
+
|
|
1767
|
+
**graphId:** `string` — Graph ID
|
|
1768
|
+
|
|
1769
|
+
</dd>
|
|
1770
|
+
</dl>
|
|
1771
|
+
|
|
1772
|
+
<dl>
|
|
1773
|
+
<dd>
|
|
1774
|
+
|
|
1775
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1776
|
+
|
|
1777
|
+
</dd>
|
|
1778
|
+
</dl>
|
|
1779
|
+
</dd>
|
|
1780
|
+
</dl>
|
|
1781
|
+
|
|
1782
|
+
</dd>
|
|
1783
|
+
</dl>
|
|
1784
|
+
</details>
|
|
1785
|
+
|
|
1786
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">update</a>(graphId, { ...params }) -> Zep.Graph</code></summary>
|
|
1787
|
+
<dl>
|
|
1788
|
+
<dd>
|
|
1789
|
+
|
|
1790
|
+
#### 📝 Description
|
|
1791
|
+
|
|
1792
|
+
<dl>
|
|
1793
|
+
<dd>
|
|
1794
|
+
|
|
1795
|
+
<dl>
|
|
1796
|
+
<dd>
|
|
1797
|
+
|
|
1798
|
+
Updates information about a graph.
|
|
1799
|
+
|
|
1800
|
+
</dd>
|
|
1801
|
+
</dl>
|
|
1802
|
+
</dd>
|
|
1803
|
+
</dl>
|
|
1804
|
+
|
|
1805
|
+
#### 🔌 Usage
|
|
1806
|
+
|
|
1807
|
+
<dl>
|
|
1808
|
+
<dd>
|
|
1809
|
+
|
|
1810
|
+
<dl>
|
|
1811
|
+
<dd>
|
|
1812
|
+
|
|
1813
|
+
```typescript
|
|
1814
|
+
await client.graph.update("graphId");
|
|
1815
|
+
```
|
|
1816
|
+
|
|
1817
|
+
</dd>
|
|
1818
|
+
</dl>
|
|
1819
|
+
</dd>
|
|
1820
|
+
</dl>
|
|
1821
|
+
|
|
1822
|
+
#### ⚙️ Parameters
|
|
1823
|
+
|
|
1824
|
+
<dl>
|
|
1825
|
+
<dd>
|
|
1826
|
+
|
|
1827
|
+
<dl>
|
|
1828
|
+
<dd>
|
|
1829
|
+
|
|
1830
|
+
**graphId:** `string` — Graph ID
|
|
1831
|
+
|
|
1832
|
+
</dd>
|
|
1833
|
+
</dl>
|
|
1834
|
+
|
|
1835
|
+
<dl>
|
|
1836
|
+
<dd>
|
|
1837
|
+
|
|
1838
|
+
**request:** `Zep.UpdateGraphRequest`
|
|
1839
|
+
|
|
1840
|
+
</dd>
|
|
1841
|
+
</dl>
|
|
1842
|
+
|
|
1843
|
+
<dl>
|
|
1844
|
+
<dd>
|
|
1845
|
+
|
|
1846
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1847
|
+
|
|
1848
|
+
</dd>
|
|
1849
|
+
</dl>
|
|
1850
|
+
</dd>
|
|
1851
|
+
</dl>
|
|
1852
|
+
|
|
1853
|
+
</dd>
|
|
1854
|
+
</dl>
|
|
1855
|
+
</details>
|
|
1856
|
+
|
|
1857
|
+
<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">warm</a>(graphId) -> Zep.SuccessResponse</code></summary>
|
|
1858
|
+
<dl>
|
|
1859
|
+
<dd>
|
|
1860
|
+
|
|
1861
|
+
#### 📝 Description
|
|
1862
|
+
|
|
1863
|
+
<dl>
|
|
1864
|
+
<dd>
|
|
1865
|
+
|
|
1866
|
+
<dl>
|
|
1867
|
+
<dd>
|
|
1868
|
+
|
|
1869
|
+
Hints Zep to warm a graph for low-latency search
|
|
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.graph.warm("graphId");
|
|
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
|
+
**graphId:** `string` — The graph_id of the graph to warm.
|
|
1902
|
+
|
|
1903
|
+
</dd>
|
|
1904
|
+
</dl>
|
|
1905
|
+
|
|
1906
|
+
<dl>
|
|
1907
|
+
<dd>
|
|
1908
|
+
|
|
1909
|
+
**requestOptions:** `Graph.RequestOptions`
|
|
1910
|
+
|
|
1911
|
+
</dd>
|
|
1912
|
+
</dl>
|
|
1913
|
+
</dd>
|
|
1914
|
+
</dl>
|
|
1915
|
+
|
|
1916
|
+
</dd>
|
|
1917
|
+
</dl>
|
|
1918
|
+
</details>
|
|
1919
|
+
|
|
1920
|
+
## Project
|
|
1921
|
+
|
|
1922
|
+
<details><summary><code>client.project.<a href="/src/api/resources/project/client/Client.ts">get</a>() -> Zep.ProjectInfoResponse</code></summary>
|
|
1923
|
+
<dl>
|
|
1924
|
+
<dd>
|
|
1925
|
+
|
|
1926
|
+
#### 📝 Description
|
|
1927
|
+
|
|
1928
|
+
<dl>
|
|
1929
|
+
<dd>
|
|
1930
|
+
|
|
1931
|
+
<dl>
|
|
1932
|
+
<dd>
|
|
1933
|
+
|
|
1934
|
+
Retrieve project info based on the provided api key.
|
|
1935
|
+
|
|
1936
|
+
</dd>
|
|
1937
|
+
</dl>
|
|
1938
|
+
</dd>
|
|
1939
|
+
</dl>
|
|
1940
|
+
|
|
1941
|
+
#### 🔌 Usage
|
|
1942
|
+
|
|
1943
|
+
<dl>
|
|
1944
|
+
<dd>
|
|
1945
|
+
|
|
1946
|
+
<dl>
|
|
1947
|
+
<dd>
|
|
1948
|
+
|
|
1949
|
+
```typescript
|
|
1950
|
+
await client.project.get();
|
|
1951
|
+
```
|
|
1952
|
+
|
|
1953
|
+
</dd>
|
|
1954
|
+
</dl>
|
|
1955
|
+
</dd>
|
|
1956
|
+
</dl>
|
|
1957
|
+
|
|
1958
|
+
#### ⚙️ Parameters
|
|
1959
|
+
|
|
1960
|
+
<dl>
|
|
1961
|
+
<dd>
|
|
1962
|
+
|
|
1963
|
+
<dl>
|
|
1964
|
+
<dd>
|
|
1965
|
+
|
|
1966
|
+
**requestOptions:** `Project.RequestOptions`
|
|
1967
|
+
|
|
1968
|
+
</dd>
|
|
1969
|
+
</dl>
|
|
1970
|
+
</dd>
|
|
1971
|
+
</dl>
|
|
1972
|
+
|
|
1973
|
+
</dd>
|
|
1974
|
+
</dl>
|
|
1975
|
+
</details>
|
|
1976
|
+
|
|
1977
|
+
## Task
|
|
1978
|
+
|
|
1979
|
+
<details><summary><code>client.task.<a href="/src/api/resources/task/client/Client.ts">get</a>(taskId) -> Zep.GetTaskResponse</code></summary>
|
|
1980
|
+
<dl>
|
|
1981
|
+
<dd>
|
|
1982
|
+
|
|
1983
|
+
#### 📝 Description
|
|
1984
|
+
|
|
1985
|
+
<dl>
|
|
1986
|
+
<dd>
|
|
1987
|
+
|
|
1988
|
+
<dl>
|
|
1989
|
+
<dd>
|
|
1990
|
+
|
|
1991
|
+
Gets a task by its ID
|
|
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.task.get("task_id");
|
|
2008
|
+
```
|
|
2009
|
+
|
|
2010
|
+
</dd>
|
|
2011
|
+
</dl>
|
|
2012
|
+
</dd>
|
|
2013
|
+
</dl>
|
|
2014
|
+
|
|
2015
|
+
#### ⚙️ Parameters
|
|
2016
|
+
|
|
2017
|
+
<dl>
|
|
2018
|
+
<dd>
|
|
2019
|
+
|
|
2020
|
+
<dl>
|
|
2021
|
+
<dd>
|
|
2022
|
+
|
|
2023
|
+
**taskId:** `string` — Task ID
|
|
2024
|
+
|
|
2025
|
+
</dd>
|
|
2026
|
+
</dl>
|
|
2027
|
+
|
|
2028
|
+
<dl>
|
|
2029
|
+
<dd>
|
|
2030
|
+
|
|
2031
|
+
**requestOptions:** `Task.RequestOptions`
|
|
2032
|
+
|
|
2033
|
+
</dd>
|
|
2034
|
+
</dl>
|
|
2035
|
+
</dd>
|
|
2036
|
+
</dl>
|
|
2037
|
+
|
|
2038
|
+
</dd>
|
|
2039
|
+
</dl>
|
|
2040
|
+
</details>
|
|
2041
|
+
|
|
2042
|
+
## Thread
|
|
2043
|
+
|
|
2044
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">listAll</a>({ ...params }) -> Zep.ThreadListResponse</code></summary>
|
|
2045
|
+
<dl>
|
|
2046
|
+
<dd>
|
|
2047
|
+
|
|
2048
|
+
#### 📝 Description
|
|
2049
|
+
|
|
2050
|
+
<dl>
|
|
2051
|
+
<dd>
|
|
2052
|
+
|
|
2053
|
+
<dl>
|
|
2054
|
+
<dd>
|
|
2055
|
+
|
|
2056
|
+
Returns all threads.
|
|
2057
|
+
|
|
2058
|
+
</dd>
|
|
2059
|
+
</dl>
|
|
2060
|
+
</dd>
|
|
2061
|
+
</dl>
|
|
2062
|
+
|
|
2063
|
+
#### 🔌 Usage
|
|
2064
|
+
|
|
2065
|
+
<dl>
|
|
2066
|
+
<dd>
|
|
2067
|
+
|
|
2068
|
+
<dl>
|
|
2069
|
+
<dd>
|
|
2070
|
+
|
|
2071
|
+
```typescript
|
|
2072
|
+
await client.thread.listAll({
|
|
2073
|
+
pageNumber: 1,
|
|
2074
|
+
pageSize: 1,
|
|
2075
|
+
orderBy: "order_by",
|
|
2076
|
+
asc: true,
|
|
2077
|
+
});
|
|
2078
|
+
```
|
|
2079
|
+
|
|
2080
|
+
</dd>
|
|
2081
|
+
</dl>
|
|
2082
|
+
</dd>
|
|
2083
|
+
</dl>
|
|
2084
|
+
|
|
2085
|
+
#### ⚙️ Parameters
|
|
2086
|
+
|
|
2087
|
+
<dl>
|
|
2088
|
+
<dd>
|
|
2089
|
+
|
|
2090
|
+
<dl>
|
|
2091
|
+
<dd>
|
|
2092
|
+
|
|
2093
|
+
**request:** `Zep.ThreadListAllRequest`
|
|
2094
|
+
|
|
2095
|
+
</dd>
|
|
2096
|
+
</dl>
|
|
2097
|
+
|
|
2098
|
+
<dl>
|
|
2099
|
+
<dd>
|
|
2100
|
+
|
|
2101
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2102
|
+
|
|
2103
|
+
</dd>
|
|
2104
|
+
</dl>
|
|
2105
|
+
</dd>
|
|
2106
|
+
</dl>
|
|
2107
|
+
|
|
2108
|
+
</dd>
|
|
2109
|
+
</dl>
|
|
2110
|
+
</details>
|
|
2111
|
+
|
|
2112
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">create</a>({ ...params }) -> Zep.Thread</code></summary>
|
|
2113
|
+
<dl>
|
|
2114
|
+
<dd>
|
|
2115
|
+
|
|
2116
|
+
#### 📝 Description
|
|
2117
|
+
|
|
2118
|
+
<dl>
|
|
2119
|
+
<dd>
|
|
2120
|
+
|
|
2121
|
+
<dl>
|
|
2122
|
+
<dd>
|
|
2123
|
+
|
|
2124
|
+
Start a new thread.
|
|
2125
|
+
|
|
2126
|
+
</dd>
|
|
2127
|
+
</dl>
|
|
2128
|
+
</dd>
|
|
2129
|
+
</dl>
|
|
2130
|
+
|
|
2131
|
+
#### 🔌 Usage
|
|
2132
|
+
|
|
2133
|
+
<dl>
|
|
2134
|
+
<dd>
|
|
2135
|
+
|
|
2136
|
+
<dl>
|
|
2137
|
+
<dd>
|
|
2138
|
+
|
|
2139
|
+
```typescript
|
|
2140
|
+
await client.thread.create({
|
|
2141
|
+
threadId: "thread_id",
|
|
2142
|
+
userId: "user_id",
|
|
2143
|
+
});
|
|
2144
|
+
```
|
|
2145
|
+
|
|
2146
|
+
</dd>
|
|
2147
|
+
</dl>
|
|
2148
|
+
</dd>
|
|
2149
|
+
</dl>
|
|
2150
|
+
|
|
2151
|
+
#### ⚙️ Parameters
|
|
2152
|
+
|
|
2153
|
+
<dl>
|
|
2154
|
+
<dd>
|
|
2155
|
+
|
|
2156
|
+
<dl>
|
|
2157
|
+
<dd>
|
|
2158
|
+
|
|
2159
|
+
**request:** `Zep.CreateThreadRequest`
|
|
2160
|
+
|
|
2161
|
+
</dd>
|
|
2162
|
+
</dl>
|
|
2163
|
+
|
|
2164
|
+
<dl>
|
|
2165
|
+
<dd>
|
|
2166
|
+
|
|
2167
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2168
|
+
|
|
2169
|
+
</dd>
|
|
2170
|
+
</dl>
|
|
2171
|
+
</dd>
|
|
2172
|
+
</dl>
|
|
2173
|
+
|
|
2174
|
+
</dd>
|
|
2175
|
+
</dl>
|
|
2176
|
+
</details>
|
|
2177
|
+
|
|
2178
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">delete</a>(threadId) -> Zep.SuccessResponse</code></summary>
|
|
2179
|
+
<dl>
|
|
2180
|
+
<dd>
|
|
2181
|
+
|
|
2182
|
+
#### 📝 Description
|
|
2183
|
+
|
|
2184
|
+
<dl>
|
|
2185
|
+
<dd>
|
|
2186
|
+
|
|
2187
|
+
<dl>
|
|
2188
|
+
<dd>
|
|
2189
|
+
|
|
2190
|
+
Deletes a thread.
|
|
2191
|
+
|
|
2192
|
+
</dd>
|
|
2193
|
+
</dl>
|
|
2194
|
+
</dd>
|
|
2195
|
+
</dl>
|
|
2196
|
+
|
|
2197
|
+
#### 🔌 Usage
|
|
2198
|
+
|
|
2199
|
+
<dl>
|
|
2200
|
+
<dd>
|
|
2201
|
+
|
|
2202
|
+
<dl>
|
|
2203
|
+
<dd>
|
|
2204
|
+
|
|
2205
|
+
```typescript
|
|
2206
|
+
await client.thread.delete("threadId");
|
|
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 thread for which memory should be deleted.
|
|
2223
|
+
|
|
2224
|
+
</dd>
|
|
2225
|
+
</dl>
|
|
2226
|
+
|
|
2227
|
+
<dl>
|
|
2228
|
+
<dd>
|
|
2229
|
+
|
|
2230
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2231
|
+
|
|
2232
|
+
</dd>
|
|
2233
|
+
</dl>
|
|
2234
|
+
</dd>
|
|
2235
|
+
</dl>
|
|
2236
|
+
|
|
2237
|
+
</dd>
|
|
2238
|
+
</dl>
|
|
2239
|
+
</details>
|
|
2240
|
+
|
|
2241
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">getUserContext</a>(threadId, { ...params }) -> Zep.ThreadContextResponse</code></summary>
|
|
2242
|
+
<dl>
|
|
2243
|
+
<dd>
|
|
2244
|
+
|
|
2245
|
+
#### 📝 Description
|
|
2246
|
+
|
|
2247
|
+
<dl>
|
|
2248
|
+
<dd>
|
|
2249
|
+
|
|
2250
|
+
<dl>
|
|
2251
|
+
<dd>
|
|
2252
|
+
|
|
2253
|
+
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.
|
|
2254
|
+
|
|
2255
|
+
</dd>
|
|
2256
|
+
</dl>
|
|
2257
|
+
</dd>
|
|
2258
|
+
</dl>
|
|
2259
|
+
|
|
2260
|
+
#### 🔌 Usage
|
|
2261
|
+
|
|
2262
|
+
<dl>
|
|
2263
|
+
<dd>
|
|
2264
|
+
|
|
2265
|
+
<dl>
|
|
2266
|
+
<dd>
|
|
2267
|
+
|
|
2268
|
+
```typescript
|
|
2269
|
+
await client.thread.getUserContext("threadId", {
|
|
2270
|
+
templateId: "template_id",
|
|
2271
|
+
});
|
|
2272
|
+
```
|
|
2273
|
+
|
|
2274
|
+
</dd>
|
|
2275
|
+
</dl>
|
|
2276
|
+
</dd>
|
|
2277
|
+
</dl>
|
|
2278
|
+
|
|
2279
|
+
#### ⚙️ Parameters
|
|
2280
|
+
|
|
2281
|
+
<dl>
|
|
2282
|
+
<dd>
|
|
2283
|
+
|
|
2284
|
+
<dl>
|
|
2285
|
+
<dd>
|
|
2286
|
+
|
|
2287
|
+
**threadId:** `string` — The ID of the current thread (for which context is being retrieved).
|
|
2288
|
+
|
|
2289
|
+
</dd>
|
|
2290
|
+
</dl>
|
|
2291
|
+
|
|
2292
|
+
<dl>
|
|
2293
|
+
<dd>
|
|
2294
|
+
|
|
2295
|
+
**request:** `Zep.ThreadGetUserContextRequest`
|
|
2296
|
+
|
|
2297
|
+
</dd>
|
|
2298
|
+
</dl>
|
|
2299
|
+
|
|
2300
|
+
<dl>
|
|
2301
|
+
<dd>
|
|
2302
|
+
|
|
2303
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2304
|
+
|
|
2305
|
+
</dd>
|
|
2306
|
+
</dl>
|
|
2307
|
+
</dd>
|
|
2308
|
+
</dl>
|
|
2309
|
+
|
|
2310
|
+
</dd>
|
|
2311
|
+
</dl>
|
|
2312
|
+
</details>
|
|
2313
|
+
|
|
2314
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">get</a>(threadId, { ...params }) -> Zep.MessageListResponse</code></summary>
|
|
2315
|
+
<dl>
|
|
2316
|
+
<dd>
|
|
2317
|
+
|
|
2318
|
+
#### 📝 Description
|
|
2319
|
+
|
|
2320
|
+
<dl>
|
|
2321
|
+
<dd>
|
|
2322
|
+
|
|
2323
|
+
<dl>
|
|
2324
|
+
<dd>
|
|
2325
|
+
|
|
2326
|
+
Returns messages for a thread.
|
|
2327
|
+
|
|
2328
|
+
</dd>
|
|
2329
|
+
</dl>
|
|
2330
|
+
</dd>
|
|
2331
|
+
</dl>
|
|
2332
|
+
|
|
2333
|
+
#### 🔌 Usage
|
|
2334
|
+
|
|
2335
|
+
<dl>
|
|
2336
|
+
<dd>
|
|
2337
|
+
|
|
2338
|
+
<dl>
|
|
2339
|
+
<dd>
|
|
2340
|
+
|
|
2341
|
+
```typescript
|
|
2342
|
+
await client.thread.get("threadId", {
|
|
2343
|
+
limit: 1,
|
|
2344
|
+
cursor: 1000000,
|
|
2345
|
+
lastn: 1,
|
|
2346
|
+
});
|
|
2347
|
+
```
|
|
2348
|
+
|
|
2349
|
+
</dd>
|
|
2350
|
+
</dl>
|
|
2351
|
+
</dd>
|
|
2352
|
+
</dl>
|
|
2353
|
+
|
|
2354
|
+
#### ⚙️ Parameters
|
|
2355
|
+
|
|
2356
|
+
<dl>
|
|
2357
|
+
<dd>
|
|
2358
|
+
|
|
2359
|
+
<dl>
|
|
2360
|
+
<dd>
|
|
2361
|
+
|
|
2362
|
+
**threadId:** `string` — Thread ID
|
|
2363
|
+
|
|
2364
|
+
</dd>
|
|
2365
|
+
</dl>
|
|
2366
|
+
|
|
2367
|
+
<dl>
|
|
2368
|
+
<dd>
|
|
2369
|
+
|
|
2370
|
+
**request:** `Zep.ThreadGetRequest`
|
|
2371
|
+
|
|
2372
|
+
</dd>
|
|
2373
|
+
</dl>
|
|
2374
|
+
|
|
2375
|
+
<dl>
|
|
2376
|
+
<dd>
|
|
2377
|
+
|
|
2378
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2379
|
+
|
|
2380
|
+
</dd>
|
|
2381
|
+
</dl>
|
|
2382
|
+
</dd>
|
|
2383
|
+
</dl>
|
|
2384
|
+
|
|
2385
|
+
</dd>
|
|
2386
|
+
</dl>
|
|
2387
|
+
</details>
|
|
2388
|
+
|
|
2389
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">addMessages</a>(threadId, { ...params }) -> Zep.AddThreadMessagesResponse</code></summary>
|
|
2390
|
+
<dl>
|
|
2391
|
+
<dd>
|
|
2392
|
+
|
|
2393
|
+
#### 📝 Description
|
|
2394
|
+
|
|
2395
|
+
<dl>
|
|
2396
|
+
<dd>
|
|
2397
|
+
|
|
2398
|
+
<dl>
|
|
2399
|
+
<dd>
|
|
2400
|
+
|
|
2401
|
+
Add messages to a thread.
|
|
2402
|
+
|
|
2403
|
+
</dd>
|
|
2404
|
+
</dl>
|
|
2405
|
+
</dd>
|
|
2406
|
+
</dl>
|
|
2407
|
+
|
|
2408
|
+
#### 🔌 Usage
|
|
2409
|
+
|
|
2410
|
+
<dl>
|
|
2411
|
+
<dd>
|
|
2412
|
+
|
|
2413
|
+
<dl>
|
|
2414
|
+
<dd>
|
|
2415
|
+
|
|
2416
|
+
```typescript
|
|
2417
|
+
await client.thread.addMessages("threadId", {
|
|
2418
|
+
messages: [
|
|
2419
|
+
{
|
|
2420
|
+
content: "content",
|
|
2421
|
+
role: "norole",
|
|
2422
|
+
},
|
|
2423
|
+
],
|
|
2424
|
+
});
|
|
2425
|
+
```
|
|
2426
|
+
|
|
2427
|
+
</dd>
|
|
2428
|
+
</dl>
|
|
2429
|
+
</dd>
|
|
2430
|
+
</dl>
|
|
2431
|
+
|
|
2432
|
+
#### ⚙️ Parameters
|
|
2433
|
+
|
|
2434
|
+
<dl>
|
|
2435
|
+
<dd>
|
|
2436
|
+
|
|
2437
|
+
<dl>
|
|
2438
|
+
<dd>
|
|
2439
|
+
|
|
2440
|
+
**threadId:** `string` — The ID of the thread to which messages should be added.
|
|
2441
|
+
|
|
2442
|
+
</dd>
|
|
2443
|
+
</dl>
|
|
2444
|
+
|
|
2445
|
+
<dl>
|
|
2446
|
+
<dd>
|
|
2447
|
+
|
|
2448
|
+
**request:** `Zep.AddThreadMessagesRequest`
|
|
2449
|
+
|
|
2450
|
+
</dd>
|
|
2451
|
+
</dl>
|
|
2452
|
+
|
|
2453
|
+
<dl>
|
|
2454
|
+
<dd>
|
|
2455
|
+
|
|
2456
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2457
|
+
|
|
2458
|
+
</dd>
|
|
2459
|
+
</dl>
|
|
2460
|
+
</dd>
|
|
2461
|
+
</dl>
|
|
2462
|
+
|
|
2463
|
+
</dd>
|
|
2464
|
+
</dl>
|
|
2465
|
+
</details>
|
|
2466
|
+
|
|
2467
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">addMessagesBatch</a>(threadId, { ...params }) -> Zep.AddThreadMessagesResponse</code></summary>
|
|
2468
|
+
<dl>
|
|
2469
|
+
<dd>
|
|
2470
|
+
|
|
2471
|
+
#### 📝 Description
|
|
2472
|
+
|
|
2473
|
+
<dl>
|
|
2474
|
+
<dd>
|
|
2475
|
+
|
|
2476
|
+
<dl>
|
|
2477
|
+
<dd>
|
|
2478
|
+
|
|
2479
|
+
Deprecated. Use the [Batch API](/adding-batch-data) (`client.batch.*` with `type: "thread_message"`) instead.
|
|
2480
|
+
|
|
2481
|
+
Adds messages to a thread in batch mode, processing messages concurrently.
|
|
2482
|
+
|
|
2483
|
+
</dd>
|
|
2484
|
+
</dl>
|
|
2485
|
+
</dd>
|
|
2486
|
+
</dl>
|
|
2487
|
+
|
|
2488
|
+
#### 🔌 Usage
|
|
2489
|
+
|
|
2490
|
+
<dl>
|
|
2491
|
+
<dd>
|
|
2492
|
+
|
|
2493
|
+
<dl>
|
|
2494
|
+
<dd>
|
|
2495
|
+
|
|
2496
|
+
```typescript
|
|
2497
|
+
await client.thread.addMessagesBatch("threadId", {
|
|
2498
|
+
messages: [
|
|
2499
|
+
{
|
|
2500
|
+
content: "content",
|
|
2501
|
+
role: "norole",
|
|
2502
|
+
},
|
|
2503
|
+
],
|
|
2504
|
+
});
|
|
2505
|
+
```
|
|
2506
|
+
|
|
2507
|
+
</dd>
|
|
2508
|
+
</dl>
|
|
2509
|
+
</dd>
|
|
2510
|
+
</dl>
|
|
2511
|
+
|
|
2512
|
+
#### ⚙️ Parameters
|
|
2513
|
+
|
|
2514
|
+
<dl>
|
|
2515
|
+
<dd>
|
|
2516
|
+
|
|
2517
|
+
<dl>
|
|
2518
|
+
<dd>
|
|
2519
|
+
|
|
2520
|
+
**threadId:** `string` — The ID of the thread to which messages should be added.
|
|
2521
|
+
|
|
2522
|
+
</dd>
|
|
2523
|
+
</dl>
|
|
2524
|
+
|
|
2525
|
+
<dl>
|
|
2526
|
+
<dd>
|
|
2527
|
+
|
|
2528
|
+
**request:** `Zep.AddThreadMessagesRequest`
|
|
2529
|
+
|
|
2530
|
+
</dd>
|
|
2531
|
+
</dl>
|
|
2532
|
+
|
|
2533
|
+
<dl>
|
|
2534
|
+
<dd>
|
|
2535
|
+
|
|
2536
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2537
|
+
|
|
2538
|
+
</dd>
|
|
2539
|
+
</dl>
|
|
2540
|
+
</dd>
|
|
2541
|
+
</dl>
|
|
2542
|
+
|
|
2543
|
+
</dd>
|
|
2544
|
+
</dl>
|
|
2545
|
+
</details>
|
|
2546
|
+
|
|
2547
|
+
<details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">getSummary</a>(threadId) -> Zep.ThreadSummary</code></summary>
|
|
2548
|
+
<dl>
|
|
2549
|
+
<dd>
|
|
2550
|
+
|
|
2551
|
+
#### 📝 Description
|
|
2552
|
+
|
|
2553
|
+
<dl>
|
|
2554
|
+
<dd>
|
|
2555
|
+
|
|
2556
|
+
<dl>
|
|
2557
|
+
<dd>
|
|
2558
|
+
|
|
2559
|
+
Returns the incremental summary generated from messages in the thread. Returns 404 if no summary exists for the thread.
|
|
2560
|
+
|
|
2561
|
+
</dd>
|
|
2562
|
+
</dl>
|
|
2563
|
+
</dd>
|
|
2564
|
+
</dl>
|
|
2565
|
+
|
|
2566
|
+
#### 🔌 Usage
|
|
2567
|
+
|
|
2568
|
+
<dl>
|
|
2569
|
+
<dd>
|
|
2570
|
+
|
|
2571
|
+
<dl>
|
|
2572
|
+
<dd>
|
|
2573
|
+
|
|
2574
|
+
```typescript
|
|
2575
|
+
await client.thread.getSummary("threadId");
|
|
2576
|
+
```
|
|
2577
|
+
|
|
2578
|
+
</dd>
|
|
2579
|
+
</dl>
|
|
2580
|
+
</dd>
|
|
2581
|
+
</dl>
|
|
2582
|
+
|
|
2583
|
+
#### ⚙️ Parameters
|
|
2584
|
+
|
|
2585
|
+
<dl>
|
|
2586
|
+
<dd>
|
|
2587
|
+
|
|
2588
|
+
<dl>
|
|
2589
|
+
<dd>
|
|
2590
|
+
|
|
2591
|
+
**threadId:** `string` — The thread ID.
|
|
2592
|
+
|
|
2593
|
+
</dd>
|
|
2594
|
+
</dl>
|
|
2595
|
+
|
|
2596
|
+
<dl>
|
|
2597
|
+
<dd>
|
|
2598
|
+
|
|
2599
|
+
**requestOptions:** `Thread.RequestOptions`
|
|
2600
|
+
|
|
2601
|
+
</dd>
|
|
2602
|
+
</dl>
|
|
2603
|
+
</dd>
|
|
2604
|
+
</dl>
|
|
2605
|
+
|
|
2606
|
+
</dd>
|
|
2607
|
+
</dl>
|
|
2608
|
+
</details>
|
|
2609
|
+
|
|
2610
|
+
## User
|
|
2611
|
+
|
|
2612
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">listUserSummaryInstructions</a>({ ...params }) -> Zep.ListUserInstructionsResponse</code></summary>
|
|
1574
2613
|
<dl>
|
|
1575
2614
|
<dd>
|
|
1576
2615
|
|
|
@@ -1582,7 +2621,7 @@ await client.thread.listAll({
|
|
|
1582
2621
|
<dl>
|
|
1583
2622
|
<dd>
|
|
1584
2623
|
|
|
1585
|
-
|
|
2624
|
+
Lists all user summary instructions for a project, user.
|
|
1586
2625
|
|
|
1587
2626
|
</dd>
|
|
1588
2627
|
</dl>
|
|
@@ -1598,8 +2637,7 @@ Start a new thread.
|
|
|
1598
2637
|
<dd>
|
|
1599
2638
|
|
|
1600
2639
|
```typescript
|
|
1601
|
-
await client.
|
|
1602
|
-
threadId: "thread_id",
|
|
2640
|
+
await client.user.listUserSummaryInstructions({
|
|
1603
2641
|
userId: "user_id",
|
|
1604
2642
|
});
|
|
1605
2643
|
```
|
|
@@ -1617,7 +2655,7 @@ await client.thread.create({
|
|
|
1617
2655
|
<dl>
|
|
1618
2656
|
<dd>
|
|
1619
2657
|
|
|
1620
|
-
**request:** `Zep.
|
|
2658
|
+
**request:** `Zep.UserListUserSummaryInstructionsRequest`
|
|
1621
2659
|
|
|
1622
2660
|
</dd>
|
|
1623
2661
|
</dl>
|
|
@@ -1625,7 +2663,7 @@ await client.thread.create({
|
|
|
1625
2663
|
<dl>
|
|
1626
2664
|
<dd>
|
|
1627
2665
|
|
|
1628
|
-
**requestOptions:** `
|
|
2666
|
+
**requestOptions:** `User.RequestOptions`
|
|
1629
2667
|
|
|
1630
2668
|
</dd>
|
|
1631
2669
|
</dl>
|
|
@@ -1636,7 +2674,7 @@ await client.thread.create({
|
|
|
1636
2674
|
</dl>
|
|
1637
2675
|
</details>
|
|
1638
2676
|
|
|
1639
|
-
<details><summary><code>client.
|
|
2677
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">addUserSummaryInstructions</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
|
|
1640
2678
|
<dl>
|
|
1641
2679
|
<dd>
|
|
1642
2680
|
|
|
@@ -1648,7 +2686,7 @@ await client.thread.create({
|
|
|
1648
2686
|
<dl>
|
|
1649
2687
|
<dd>
|
|
1650
2688
|
|
|
1651
|
-
|
|
2689
|
+
Adds new summary instructions for users graphs without removing existing ones. If user_ids is empty, adds to project-wide default instructions.
|
|
1652
2690
|
|
|
1653
2691
|
</dd>
|
|
1654
2692
|
</dl>
|
|
@@ -1664,7 +2702,14 @@ Deletes a thread.
|
|
|
1664
2702
|
<dd>
|
|
1665
2703
|
|
|
1666
2704
|
```typescript
|
|
1667
|
-
await client.
|
|
2705
|
+
await client.user.addUserSummaryInstructions({
|
|
2706
|
+
instructions: [
|
|
2707
|
+
{
|
|
2708
|
+
name: "name",
|
|
2709
|
+
text: "text",
|
|
2710
|
+
},
|
|
2711
|
+
],
|
|
2712
|
+
});
|
|
1668
2713
|
```
|
|
1669
2714
|
|
|
1670
2715
|
</dd>
|
|
@@ -1680,7 +2725,7 @@ await client.thread.delete("threadId");
|
|
|
1680
2725
|
<dl>
|
|
1681
2726
|
<dd>
|
|
1682
2727
|
|
|
1683
|
-
**
|
|
2728
|
+
**request:** `Zep.AddUserInstructionsRequest`
|
|
1684
2729
|
|
|
1685
2730
|
</dd>
|
|
1686
2731
|
</dl>
|
|
@@ -1688,7 +2733,7 @@ await client.thread.delete("threadId");
|
|
|
1688
2733
|
<dl>
|
|
1689
2734
|
<dd>
|
|
1690
2735
|
|
|
1691
|
-
**requestOptions:** `
|
|
2736
|
+
**requestOptions:** `User.RequestOptions`
|
|
1692
2737
|
|
|
1693
2738
|
</dd>
|
|
1694
2739
|
</dl>
|
|
@@ -1699,7 +2744,7 @@ await client.thread.delete("threadId");
|
|
|
1699
2744
|
</dl>
|
|
1700
2745
|
</details>
|
|
1701
2746
|
|
|
1702
|
-
<details><summary><code>client.
|
|
2747
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">deleteUserSummaryInstructions</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
|
|
1703
2748
|
<dl>
|
|
1704
2749
|
<dd>
|
|
1705
2750
|
|
|
@@ -1711,7 +2756,7 @@ await client.thread.delete("threadId");
|
|
|
1711
2756
|
<dl>
|
|
1712
2757
|
<dd>
|
|
1713
2758
|
|
|
1714
|
-
|
|
2759
|
+
Deletes user summary/instructions for users or project wide defaults.
|
|
1715
2760
|
|
|
1716
2761
|
</dd>
|
|
1717
2762
|
</dl>
|
|
@@ -1727,9 +2772,7 @@ Returns most relevant context from the user graph (including memory from any/all
|
|
|
1727
2772
|
<dd>
|
|
1728
2773
|
|
|
1729
2774
|
```typescript
|
|
1730
|
-
await client.
|
|
1731
|
-
templateId: "template_id",
|
|
1732
|
-
});
|
|
2775
|
+
await client.user.deleteUserSummaryInstructions();
|
|
1733
2776
|
```
|
|
1734
2777
|
|
|
1735
2778
|
</dd>
|
|
@@ -1745,15 +2788,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1745
2788
|
<dl>
|
|
1746
2789
|
<dd>
|
|
1747
2790
|
|
|
1748
|
-
**
|
|
1749
|
-
|
|
1750
|
-
</dd>
|
|
1751
|
-
</dl>
|
|
1752
|
-
|
|
1753
|
-
<dl>
|
|
1754
|
-
<dd>
|
|
1755
|
-
|
|
1756
|
-
**request:** `Zep.ThreadGetUserContextRequest`
|
|
2791
|
+
**request:** `Zep.DeleteUserInstructionsRequest`
|
|
1757
2792
|
|
|
1758
2793
|
</dd>
|
|
1759
2794
|
</dl>
|
|
@@ -1761,7 +2796,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1761
2796
|
<dl>
|
|
1762
2797
|
<dd>
|
|
1763
2798
|
|
|
1764
|
-
**requestOptions:** `
|
|
2799
|
+
**requestOptions:** `User.RequestOptions`
|
|
1765
2800
|
|
|
1766
2801
|
</dd>
|
|
1767
2802
|
</dl>
|
|
@@ -1772,7 +2807,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1772
2807
|
</dl>
|
|
1773
2808
|
</details>
|
|
1774
2809
|
|
|
1775
|
-
<details><summary><code>client.
|
|
2810
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">add</a>({ ...params }) -> Zep.User</code></summary>
|
|
1776
2811
|
<dl>
|
|
1777
2812
|
<dd>
|
|
1778
2813
|
|
|
@@ -1784,7 +2819,7 @@ await client.thread.getUserContext("threadId", {
|
|
|
1784
2819
|
<dl>
|
|
1785
2820
|
<dd>
|
|
1786
2821
|
|
|
1787
|
-
|
|
2822
|
+
Adds a user.
|
|
1788
2823
|
|
|
1789
2824
|
</dd>
|
|
1790
2825
|
</dl>
|
|
@@ -1800,10 +2835,8 @@ Returns messages for a thread.
|
|
|
1800
2835
|
<dd>
|
|
1801
2836
|
|
|
1802
2837
|
```typescript
|
|
1803
|
-
await client.
|
|
1804
|
-
|
|
1805
|
-
cursor: 1,
|
|
1806
|
-
lastn: 1,
|
|
2838
|
+
await client.user.add({
|
|
2839
|
+
userId: "user_id",
|
|
1807
2840
|
});
|
|
1808
2841
|
```
|
|
1809
2842
|
|
|
@@ -1820,15 +2853,7 @@ await client.thread.get("threadId", {
|
|
|
1820
2853
|
<dl>
|
|
1821
2854
|
<dd>
|
|
1822
2855
|
|
|
1823
|
-
**
|
|
1824
|
-
|
|
1825
|
-
</dd>
|
|
1826
|
-
</dl>
|
|
1827
|
-
|
|
1828
|
-
<dl>
|
|
1829
|
-
<dd>
|
|
1830
|
-
|
|
1831
|
-
**request:** `Zep.ThreadGetRequest`
|
|
2856
|
+
**request:** `Zep.CreateUserRequest`
|
|
1832
2857
|
|
|
1833
2858
|
</dd>
|
|
1834
2859
|
</dl>
|
|
@@ -1836,7 +2861,7 @@ await client.thread.get("threadId", {
|
|
|
1836
2861
|
<dl>
|
|
1837
2862
|
<dd>
|
|
1838
2863
|
|
|
1839
|
-
**requestOptions:** `
|
|
2864
|
+
**requestOptions:** `User.RequestOptions`
|
|
1840
2865
|
|
|
1841
2866
|
</dd>
|
|
1842
2867
|
</dl>
|
|
@@ -1847,7 +2872,7 @@ await client.thread.get("threadId", {
|
|
|
1847
2872
|
</dl>
|
|
1848
2873
|
</details>
|
|
1849
2874
|
|
|
1850
|
-
<details><summary><code>client.
|
|
2875
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">listOrdered</a>({ ...params }) -> Zep.UserListResponse</code></summary>
|
|
1851
2876
|
<dl>
|
|
1852
2877
|
<dd>
|
|
1853
2878
|
|
|
@@ -1859,7 +2884,7 @@ await client.thread.get("threadId", {
|
|
|
1859
2884
|
<dl>
|
|
1860
2885
|
<dd>
|
|
1861
2886
|
|
|
1862
|
-
|
|
2887
|
+
Returns all users.
|
|
1863
2888
|
|
|
1864
2889
|
</dd>
|
|
1865
2890
|
</dl>
|
|
@@ -1875,13 +2900,12 @@ Add messages to a thread.
|
|
|
1875
2900
|
<dd>
|
|
1876
2901
|
|
|
1877
2902
|
```typescript
|
|
1878
|
-
await client.
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
],
|
|
2903
|
+
await client.user.listOrdered({
|
|
2904
|
+
pageNumber: 1,
|
|
2905
|
+
pageSize: 1,
|
|
2906
|
+
search: "search",
|
|
2907
|
+
orderBy: "order_by",
|
|
2908
|
+
asc: true,
|
|
1885
2909
|
});
|
|
1886
2910
|
```
|
|
1887
2911
|
|
|
@@ -1898,15 +2922,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1898
2922
|
<dl>
|
|
1899
2923
|
<dd>
|
|
1900
2924
|
|
|
1901
|
-
**
|
|
1902
|
-
|
|
1903
|
-
</dd>
|
|
1904
|
-
</dl>
|
|
1905
|
-
|
|
1906
|
-
<dl>
|
|
1907
|
-
<dd>
|
|
1908
|
-
|
|
1909
|
-
**request:** `Zep.AddThreadMessagesRequest`
|
|
2925
|
+
**request:** `Zep.UserListOrderedRequest`
|
|
1910
2926
|
|
|
1911
2927
|
</dd>
|
|
1912
2928
|
</dl>
|
|
@@ -1914,7 +2930,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1914
2930
|
<dl>
|
|
1915
2931
|
<dd>
|
|
1916
2932
|
|
|
1917
|
-
**requestOptions:** `
|
|
2933
|
+
**requestOptions:** `User.RequestOptions`
|
|
1918
2934
|
|
|
1919
2935
|
</dd>
|
|
1920
2936
|
</dl>
|
|
@@ -1925,7 +2941,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1925
2941
|
</dl>
|
|
1926
2942
|
</details>
|
|
1927
2943
|
|
|
1928
|
-
<details><summary><code>client.
|
|
2944
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">get</a>(userId) -> Zep.User</code></summary>
|
|
1929
2945
|
<dl>
|
|
1930
2946
|
<dd>
|
|
1931
2947
|
|
|
@@ -1937,7 +2953,7 @@ await client.thread.addMessages("threadId", {
|
|
|
1937
2953
|
<dl>
|
|
1938
2954
|
<dd>
|
|
1939
2955
|
|
|
1940
|
-
|
|
2956
|
+
Returns a user.
|
|
1941
2957
|
|
|
1942
2958
|
</dd>
|
|
1943
2959
|
</dl>
|
|
@@ -1953,14 +2969,7 @@ Add messages to a thread in batch mode. This will process messages concurrently,
|
|
|
1953
2969
|
<dd>
|
|
1954
2970
|
|
|
1955
2971
|
```typescript
|
|
1956
|
-
await client.
|
|
1957
|
-
messages: [
|
|
1958
|
-
{
|
|
1959
|
-
content: "content",
|
|
1960
|
-
role: "norole",
|
|
1961
|
-
},
|
|
1962
|
-
],
|
|
1963
|
-
});
|
|
2972
|
+
await client.user.get("userId");
|
|
1964
2973
|
```
|
|
1965
2974
|
|
|
1966
2975
|
</dd>
|
|
@@ -1976,15 +2985,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
1976
2985
|
<dl>
|
|
1977
2986
|
<dd>
|
|
1978
2987
|
|
|
1979
|
-
**
|
|
1980
|
-
|
|
1981
|
-
</dd>
|
|
1982
|
-
</dl>
|
|
1983
|
-
|
|
1984
|
-
<dl>
|
|
1985
|
-
<dd>
|
|
1986
|
-
|
|
1987
|
-
**request:** `Zep.AddThreadMessagesRequest`
|
|
2988
|
+
**userId:** `string` — The user_id of the user to get.
|
|
1988
2989
|
|
|
1989
2990
|
</dd>
|
|
1990
2991
|
</dl>
|
|
@@ -1992,7 +2993,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
1992
2993
|
<dl>
|
|
1993
2994
|
<dd>
|
|
1994
2995
|
|
|
1995
|
-
**requestOptions:** `
|
|
2996
|
+
**requestOptions:** `User.RequestOptions`
|
|
1996
2997
|
|
|
1997
2998
|
</dd>
|
|
1998
2999
|
</dl>
|
|
@@ -2003,9 +3004,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
2003
3004
|
</dl>
|
|
2004
3005
|
</details>
|
|
2005
3006
|
|
|
2006
|
-
|
|
2007
|
-
|
|
2008
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">listUserSummaryInstructions</a>({ ...params }) -> Zep.ListUserInstructionsResponse</code></summary>
|
|
3007
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">delete</a>(userId) -> Zep.SuccessResponse</code></summary>
|
|
2009
3008
|
<dl>
|
|
2010
3009
|
<dd>
|
|
2011
3010
|
|
|
@@ -2017,7 +3016,7 @@ await client.thread.addMessagesBatch("threadId", {
|
|
|
2017
3016
|
<dl>
|
|
2018
3017
|
<dd>
|
|
2019
3018
|
|
|
2020
|
-
|
|
3019
|
+
Deletes a user.
|
|
2021
3020
|
|
|
2022
3021
|
</dd>
|
|
2023
3022
|
</dl>
|
|
@@ -2033,9 +3032,7 @@ Lists all user summary instructions for a project, user.
|
|
|
2033
3032
|
<dd>
|
|
2034
3033
|
|
|
2035
3034
|
```typescript
|
|
2036
|
-
await client.user.
|
|
2037
|
-
userId: "user_id",
|
|
2038
|
-
});
|
|
3035
|
+
await client.user.delete("userId");
|
|
2039
3036
|
```
|
|
2040
3037
|
|
|
2041
3038
|
</dd>
|
|
@@ -2051,7 +3048,7 @@ await client.user.listUserSummaryInstructions({
|
|
|
2051
3048
|
<dl>
|
|
2052
3049
|
<dd>
|
|
2053
3050
|
|
|
2054
|
-
**
|
|
3051
|
+
**userId:** `string` — User ID
|
|
2055
3052
|
|
|
2056
3053
|
</dd>
|
|
2057
3054
|
</dl>
|
|
@@ -2070,7 +3067,7 @@ await client.user.listUserSummaryInstructions({
|
|
|
2070
3067
|
</dl>
|
|
2071
3068
|
</details>
|
|
2072
3069
|
|
|
2073
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">
|
|
3070
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">update</a>(userId, { ...params }) -> Zep.User</code></summary>
|
|
2074
3071
|
<dl>
|
|
2075
3072
|
<dd>
|
|
2076
3073
|
|
|
@@ -2082,7 +3079,7 @@ await client.user.listUserSummaryInstructions({
|
|
|
2082
3079
|
<dl>
|
|
2083
3080
|
<dd>
|
|
2084
3081
|
|
|
2085
|
-
|
|
3082
|
+
Updates a user.
|
|
2086
3083
|
|
|
2087
3084
|
</dd>
|
|
2088
3085
|
</dl>
|
|
@@ -2098,14 +3095,7 @@ Adds new summary instructions for users graphs without removing existing ones. I
|
|
|
2098
3095
|
<dd>
|
|
2099
3096
|
|
|
2100
3097
|
```typescript
|
|
2101
|
-
await client.user.
|
|
2102
|
-
instructions: [
|
|
2103
|
-
{
|
|
2104
|
-
name: "name",
|
|
2105
|
-
text: "text",
|
|
2106
|
-
},
|
|
2107
|
-
],
|
|
2108
|
-
});
|
|
3098
|
+
await client.user.update("userId");
|
|
2109
3099
|
```
|
|
2110
3100
|
|
|
2111
3101
|
</dd>
|
|
@@ -2121,7 +3111,15 @@ await client.user.addUserSummaryInstructions({
|
|
|
2121
3111
|
<dl>
|
|
2122
3112
|
<dd>
|
|
2123
3113
|
|
|
2124
|
-
**
|
|
3114
|
+
**userId:** `string` — User ID
|
|
3115
|
+
|
|
3116
|
+
</dd>
|
|
3117
|
+
</dl>
|
|
3118
|
+
|
|
3119
|
+
<dl>
|
|
3120
|
+
<dd>
|
|
3121
|
+
|
|
3122
|
+
**request:** `Zep.UpdateUserRequest`
|
|
2125
3123
|
|
|
2126
3124
|
</dd>
|
|
2127
3125
|
</dl>
|
|
@@ -2140,7 +3138,7 @@ await client.user.addUserSummaryInstructions({
|
|
|
2140
3138
|
</dl>
|
|
2141
3139
|
</details>
|
|
2142
3140
|
|
|
2143
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">
|
|
3141
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getNode</a>(userId) -> Zep.UserNodeResponse</code></summary>
|
|
2144
3142
|
<dl>
|
|
2145
3143
|
<dd>
|
|
2146
3144
|
|
|
@@ -2152,7 +3150,7 @@ await client.user.addUserSummaryInstructions({
|
|
|
2152
3150
|
<dl>
|
|
2153
3151
|
<dd>
|
|
2154
3152
|
|
|
2155
|
-
|
|
3153
|
+
Returns a user's node.
|
|
2156
3154
|
|
|
2157
3155
|
</dd>
|
|
2158
3156
|
</dl>
|
|
@@ -2168,7 +3166,7 @@ Deletes user summary/instructions for users or project wide defaults.
|
|
|
2168
3166
|
<dd>
|
|
2169
3167
|
|
|
2170
3168
|
```typescript
|
|
2171
|
-
await client.user.
|
|
3169
|
+
await client.user.getNode("userId");
|
|
2172
3170
|
```
|
|
2173
3171
|
|
|
2174
3172
|
</dd>
|
|
@@ -2184,7 +3182,7 @@ await client.user.deleteUserSummaryInstructions();
|
|
|
2184
3182
|
<dl>
|
|
2185
3183
|
<dd>
|
|
2186
3184
|
|
|
2187
|
-
**
|
|
3185
|
+
**userId:** `string` — The user_id of the user to get the node for.
|
|
2188
3186
|
|
|
2189
3187
|
</dd>
|
|
2190
3188
|
</dl>
|
|
@@ -2203,7 +3201,7 @@ await client.user.deleteUserSummaryInstructions();
|
|
|
2203
3201
|
</dl>
|
|
2204
3202
|
</details>
|
|
2205
3203
|
|
|
2206
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">
|
|
3204
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">getThreads</a>(userId) -> Zep.Thread[]</code></summary>
|
|
2207
3205
|
<dl>
|
|
2208
3206
|
<dd>
|
|
2209
3207
|
|
|
@@ -2215,7 +3213,7 @@ await client.user.deleteUserSummaryInstructions();
|
|
|
2215
3213
|
<dl>
|
|
2216
3214
|
<dd>
|
|
2217
3215
|
|
|
2218
|
-
|
|
3216
|
+
Returns all threads for a user.
|
|
2219
3217
|
|
|
2220
3218
|
</dd>
|
|
2221
3219
|
</dl>
|
|
@@ -2231,9 +3229,7 @@ Adds a user.
|
|
|
2231
3229
|
<dd>
|
|
2232
3230
|
|
|
2233
3231
|
```typescript
|
|
2234
|
-
await client.user.
|
|
2235
|
-
userId: "user_id",
|
|
2236
|
-
});
|
|
3232
|
+
await client.user.getThreads("userId");
|
|
2237
3233
|
```
|
|
2238
3234
|
|
|
2239
3235
|
</dd>
|
|
@@ -2249,7 +3245,7 @@ await client.user.add({
|
|
|
2249
3245
|
<dl>
|
|
2250
3246
|
<dd>
|
|
2251
3247
|
|
|
2252
|
-
**
|
|
3248
|
+
**userId:** `string` — User ID
|
|
2253
3249
|
|
|
2254
3250
|
</dd>
|
|
2255
3251
|
</dl>
|
|
@@ -2268,7 +3264,7 @@ await client.user.add({
|
|
|
2268
3264
|
</dl>
|
|
2269
3265
|
</details>
|
|
2270
3266
|
|
|
2271
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">
|
|
3267
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">warm</a>(userId) -> Zep.SuccessResponse</code></summary>
|
|
2272
3268
|
<dl>
|
|
2273
3269
|
<dd>
|
|
2274
3270
|
|
|
@@ -2280,7 +3276,7 @@ await client.user.add({
|
|
|
2280
3276
|
<dl>
|
|
2281
3277
|
<dd>
|
|
2282
3278
|
|
|
2283
|
-
|
|
3279
|
+
Hints Zep to warm a user's graph for low-latency search
|
|
2284
3280
|
|
|
2285
3281
|
</dd>
|
|
2286
3282
|
</dl>
|
|
@@ -2296,13 +3292,7 @@ Returns all users.
|
|
|
2296
3292
|
<dd>
|
|
2297
3293
|
|
|
2298
3294
|
```typescript
|
|
2299
|
-
await client.user.
|
|
2300
|
-
pageNumber: 1,
|
|
2301
|
-
pageSize: 1,
|
|
2302
|
-
search: "search",
|
|
2303
|
-
orderBy: "order_by",
|
|
2304
|
-
asc: true,
|
|
2305
|
-
});
|
|
3295
|
+
await client.user.warm("userId");
|
|
2306
3296
|
```
|
|
2307
3297
|
|
|
2308
3298
|
</dd>
|
|
@@ -2318,7 +3308,7 @@ await client.user.listOrdered({
|
|
|
2318
3308
|
<dl>
|
|
2319
3309
|
<dd>
|
|
2320
3310
|
|
|
2321
|
-
**
|
|
3311
|
+
**userId:** `string` — User ID
|
|
2322
3312
|
|
|
2323
3313
|
</dd>
|
|
2324
3314
|
</dl>
|
|
@@ -2337,7 +3327,9 @@ await client.user.listOrdered({
|
|
|
2337
3327
|
</dl>
|
|
2338
3328
|
</details>
|
|
2339
3329
|
|
|
2340
|
-
|
|
3330
|
+
## Graph Edge
|
|
3331
|
+
|
|
3332
|
+
<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
3333
|
<dl>
|
|
2342
3334
|
<dd>
|
|
2343
3335
|
|
|
@@ -2349,7 +3341,7 @@ await client.user.listOrdered({
|
|
|
2349
3341
|
<dl>
|
|
2350
3342
|
<dd>
|
|
2351
3343
|
|
|
2352
|
-
Returns a
|
|
3344
|
+
Returns all edges for a graph.
|
|
2353
3345
|
|
|
2354
3346
|
</dd>
|
|
2355
3347
|
</dl>
|
|
@@ -2365,7 +3357,7 @@ Returns a user.
|
|
|
2365
3357
|
<dd>
|
|
2366
3358
|
|
|
2367
3359
|
```typescript
|
|
2368
|
-
await client.
|
|
3360
|
+
await client.graph.edge.getByGraphId("graph_id", {});
|
|
2369
3361
|
```
|
|
2370
3362
|
|
|
2371
3363
|
</dd>
|
|
@@ -2381,7 +3373,7 @@ await client.user.get("userId");
|
|
|
2381
3373
|
<dl>
|
|
2382
3374
|
<dd>
|
|
2383
3375
|
|
|
2384
|
-
**
|
|
3376
|
+
**graphId:** `string` — Graph ID
|
|
2385
3377
|
|
|
2386
3378
|
</dd>
|
|
2387
3379
|
</dl>
|
|
@@ -2389,7 +3381,15 @@ await client.user.get("userId");
|
|
|
2389
3381
|
<dl>
|
|
2390
3382
|
<dd>
|
|
2391
3383
|
|
|
2392
|
-
**
|
|
3384
|
+
**request:** `Zep.GraphEdgesRequest`
|
|
3385
|
+
|
|
3386
|
+
</dd>
|
|
3387
|
+
</dl>
|
|
3388
|
+
|
|
3389
|
+
<dl>
|
|
3390
|
+
<dd>
|
|
3391
|
+
|
|
3392
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2393
3393
|
|
|
2394
3394
|
</dd>
|
|
2395
3395
|
</dl>
|
|
@@ -2400,7 +3400,7 @@ await client.user.get("userId");
|
|
|
2400
3400
|
</dl>
|
|
2401
3401
|
</details>
|
|
2402
3402
|
|
|
2403
|
-
<details><summary><code>client.
|
|
3403
|
+
<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
3404
|
<dl>
|
|
2405
3405
|
<dd>
|
|
2406
3406
|
|
|
@@ -2412,7 +3412,7 @@ await client.user.get("userId");
|
|
|
2412
3412
|
<dl>
|
|
2413
3413
|
<dd>
|
|
2414
3414
|
|
|
2415
|
-
|
|
3415
|
+
Returns all edges for a user.
|
|
2416
3416
|
|
|
2417
3417
|
</dd>
|
|
2418
3418
|
</dl>
|
|
@@ -2428,7 +3428,7 @@ Deletes a user.
|
|
|
2428
3428
|
<dd>
|
|
2429
3429
|
|
|
2430
3430
|
```typescript
|
|
2431
|
-
await client.
|
|
3431
|
+
await client.graph.edge.getByUserId("user_id", {});
|
|
2432
3432
|
```
|
|
2433
3433
|
|
|
2434
3434
|
</dd>
|
|
@@ -2452,7 +3452,15 @@ await client.user.delete("userId");
|
|
|
2452
3452
|
<dl>
|
|
2453
3453
|
<dd>
|
|
2454
3454
|
|
|
2455
|
-
**
|
|
3455
|
+
**request:** `Zep.GraphEdgesRequest`
|
|
3456
|
+
|
|
3457
|
+
</dd>
|
|
3458
|
+
</dl>
|
|
3459
|
+
|
|
3460
|
+
<dl>
|
|
3461
|
+
<dd>
|
|
3462
|
+
|
|
3463
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2456
3464
|
|
|
2457
3465
|
</dd>
|
|
2458
3466
|
</dl>
|
|
@@ -2463,7 +3471,7 @@ await client.user.delete("userId");
|
|
|
2463
3471
|
</dl>
|
|
2464
3472
|
</details>
|
|
2465
3473
|
|
|
2466
|
-
<details><summary><code>client.
|
|
3474
|
+
<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
3475
|
<dl>
|
|
2468
3476
|
<dd>
|
|
2469
3477
|
|
|
@@ -2475,7 +3483,7 @@ await client.user.delete("userId");
|
|
|
2475
3483
|
<dl>
|
|
2476
3484
|
<dd>
|
|
2477
3485
|
|
|
2478
|
-
|
|
3486
|
+
Returns a specific edge by its UUID.
|
|
2479
3487
|
|
|
2480
3488
|
</dd>
|
|
2481
3489
|
</dl>
|
|
@@ -2491,7 +3499,7 @@ Updates a user.
|
|
|
2491
3499
|
<dd>
|
|
2492
3500
|
|
|
2493
3501
|
```typescript
|
|
2494
|
-
await client.
|
|
3502
|
+
await client.graph.edge.get("uuid");
|
|
2495
3503
|
```
|
|
2496
3504
|
|
|
2497
3505
|
</dd>
|
|
@@ -2507,15 +3515,7 @@ await client.user.update("userId");
|
|
|
2507
3515
|
<dl>
|
|
2508
3516
|
<dd>
|
|
2509
3517
|
|
|
2510
|
-
**
|
|
2511
|
-
|
|
2512
|
-
</dd>
|
|
2513
|
-
</dl>
|
|
2514
|
-
|
|
2515
|
-
<dl>
|
|
2516
|
-
<dd>
|
|
2517
|
-
|
|
2518
|
-
**request:** `Zep.UpdateUserRequest`
|
|
3518
|
+
**uuid:** `string` — Edge UUID
|
|
2519
3519
|
|
|
2520
3520
|
</dd>
|
|
2521
3521
|
</dl>
|
|
@@ -2523,7 +3523,7 @@ await client.user.update("userId");
|
|
|
2523
3523
|
<dl>
|
|
2524
3524
|
<dd>
|
|
2525
3525
|
|
|
2526
|
-
**requestOptions:** `
|
|
3526
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2527
3527
|
|
|
2528
3528
|
</dd>
|
|
2529
3529
|
</dl>
|
|
@@ -2534,7 +3534,7 @@ await client.user.update("userId");
|
|
|
2534
3534
|
</dl>
|
|
2535
3535
|
</details>
|
|
2536
3536
|
|
|
2537
|
-
<details><summary><code>client.
|
|
3537
|
+
<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
3538
|
<dl>
|
|
2539
3539
|
<dd>
|
|
2540
3540
|
|
|
@@ -2546,7 +3546,7 @@ await client.user.update("userId");
|
|
|
2546
3546
|
<dl>
|
|
2547
3547
|
<dd>
|
|
2548
3548
|
|
|
2549
|
-
|
|
3549
|
+
Deletes an edge by UUID.
|
|
2550
3550
|
|
|
2551
3551
|
</dd>
|
|
2552
3552
|
</dl>
|
|
@@ -2562,7 +3562,7 @@ Returns a user's node.
|
|
|
2562
3562
|
<dd>
|
|
2563
3563
|
|
|
2564
3564
|
```typescript
|
|
2565
|
-
await client.
|
|
3565
|
+
await client.graph.edge.delete("uuid");
|
|
2566
3566
|
```
|
|
2567
3567
|
|
|
2568
3568
|
</dd>
|
|
@@ -2578,7 +3578,7 @@ await client.user.getNode("userId");
|
|
|
2578
3578
|
<dl>
|
|
2579
3579
|
<dd>
|
|
2580
3580
|
|
|
2581
|
-
**
|
|
3581
|
+
**uuid:** `string` — Edge UUID
|
|
2582
3582
|
|
|
2583
3583
|
</dd>
|
|
2584
3584
|
</dl>
|
|
@@ -2586,7 +3586,7 @@ await client.user.getNode("userId");
|
|
|
2586
3586
|
<dl>
|
|
2587
3587
|
<dd>
|
|
2588
3588
|
|
|
2589
|
-
**requestOptions:** `
|
|
3589
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2590
3590
|
|
|
2591
3591
|
</dd>
|
|
2592
3592
|
</dl>
|
|
@@ -2597,7 +3597,7 @@ await client.user.getNode("userId");
|
|
|
2597
3597
|
</dl>
|
|
2598
3598
|
</details>
|
|
2599
3599
|
|
|
2600
|
-
<details><summary><code>client.
|
|
3600
|
+
<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
3601
|
<dl>
|
|
2602
3602
|
<dd>
|
|
2603
3603
|
|
|
@@ -2609,7 +3609,7 @@ await client.user.getNode("userId");
|
|
|
2609
3609
|
<dl>
|
|
2610
3610
|
<dd>
|
|
2611
3611
|
|
|
2612
|
-
|
|
3612
|
+
Updates an entity edge by UUID.
|
|
2613
3613
|
|
|
2614
3614
|
</dd>
|
|
2615
3615
|
</dl>
|
|
@@ -2625,7 +3625,7 @@ Returns all threads for a user.
|
|
|
2625
3625
|
<dd>
|
|
2626
3626
|
|
|
2627
3627
|
```typescript
|
|
2628
|
-
await client.
|
|
3628
|
+
await client.graph.edge.update("uuid");
|
|
2629
3629
|
```
|
|
2630
3630
|
|
|
2631
3631
|
</dd>
|
|
@@ -2641,7 +3641,7 @@ await client.user.getThreads("userId");
|
|
|
2641
3641
|
<dl>
|
|
2642
3642
|
<dd>
|
|
2643
3643
|
|
|
2644
|
-
**
|
|
3644
|
+
**uuid:** `string` — Edge UUID
|
|
2645
3645
|
|
|
2646
3646
|
</dd>
|
|
2647
3647
|
</dl>
|
|
@@ -2649,7 +3649,15 @@ await client.user.getThreads("userId");
|
|
|
2649
3649
|
<dl>
|
|
2650
3650
|
<dd>
|
|
2651
3651
|
|
|
2652
|
-
**
|
|
3652
|
+
**request:** `Zep.graph.UpdateEdgeRequest`
|
|
3653
|
+
|
|
3654
|
+
</dd>
|
|
3655
|
+
</dl>
|
|
3656
|
+
|
|
3657
|
+
<dl>
|
|
3658
|
+
<dd>
|
|
3659
|
+
|
|
3660
|
+
**requestOptions:** `Edge.RequestOptions`
|
|
2653
3661
|
|
|
2654
3662
|
</dd>
|
|
2655
3663
|
</dl>
|
|
@@ -2660,7 +3668,9 @@ await client.user.getThreads("userId");
|
|
|
2660
3668
|
</dl>
|
|
2661
3669
|
</details>
|
|
2662
3670
|
|
|
2663
|
-
|
|
3671
|
+
## Graph Episode
|
|
3672
|
+
|
|
3673
|
+
<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
3674
|
<dl>
|
|
2665
3675
|
<dd>
|
|
2666
3676
|
|
|
@@ -2672,7 +3682,7 @@ await client.user.getThreads("userId");
|
|
|
2672
3682
|
<dl>
|
|
2673
3683
|
<dd>
|
|
2674
3684
|
|
|
2675
|
-
|
|
3685
|
+
Returns episodes by graph id.
|
|
2676
3686
|
|
|
2677
3687
|
</dd>
|
|
2678
3688
|
</dl>
|
|
@@ -2688,7 +3698,9 @@ Hints Zep to warm a user's graph for low-latency search
|
|
|
2688
3698
|
<dd>
|
|
2689
3699
|
|
|
2690
3700
|
```typescript
|
|
2691
|
-
await client.
|
|
3701
|
+
await client.graph.episode.getByGraphId("graph_id", {
|
|
3702
|
+
lastn: 1,
|
|
3703
|
+
});
|
|
2692
3704
|
```
|
|
2693
3705
|
|
|
2694
3706
|
</dd>
|
|
@@ -2704,7 +3716,7 @@ await client.user.warm("userId");
|
|
|
2704
3716
|
<dl>
|
|
2705
3717
|
<dd>
|
|
2706
3718
|
|
|
2707
|
-
**
|
|
3719
|
+
**graphId:** `string` — Graph ID
|
|
2708
3720
|
|
|
2709
3721
|
</dd>
|
|
2710
3722
|
</dl>
|
|
@@ -2712,7 +3724,15 @@ await client.user.warm("userId");
|
|
|
2712
3724
|
<dl>
|
|
2713
3725
|
<dd>
|
|
2714
3726
|
|
|
2715
|
-
**
|
|
3727
|
+
**request:** `Zep.graph.EpisodeGetByGraphIdRequest`
|
|
3728
|
+
|
|
3729
|
+
</dd>
|
|
3730
|
+
</dl>
|
|
3731
|
+
|
|
3732
|
+
<dl>
|
|
3733
|
+
<dd>
|
|
3734
|
+
|
|
3735
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2716
3736
|
|
|
2717
3737
|
</dd>
|
|
2718
3738
|
</dl>
|
|
@@ -2723,9 +3743,7 @@ await client.user.warm("userId");
|
|
|
2723
3743
|
</dl>
|
|
2724
3744
|
</details>
|
|
2725
3745
|
|
|
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>
|
|
3746
|
+
<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
3747
|
<dl>
|
|
2730
3748
|
<dd>
|
|
2731
3749
|
|
|
@@ -2737,7 +3755,7 @@ await client.user.warm("userId");
|
|
|
2737
3755
|
<dl>
|
|
2738
3756
|
<dd>
|
|
2739
3757
|
|
|
2740
|
-
Returns
|
|
3758
|
+
Returns episodes by user id.
|
|
2741
3759
|
|
|
2742
3760
|
</dd>
|
|
2743
3761
|
</dl>
|
|
@@ -2753,7 +3771,9 @@ Returns all edges for a graph.
|
|
|
2753
3771
|
<dd>
|
|
2754
3772
|
|
|
2755
3773
|
```typescript
|
|
2756
|
-
await client.graph.
|
|
3774
|
+
await client.graph.episode.getByUserId("user_id", {
|
|
3775
|
+
lastn: 1,
|
|
3776
|
+
});
|
|
2757
3777
|
```
|
|
2758
3778
|
|
|
2759
3779
|
</dd>
|
|
@@ -2769,7 +3789,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2769
3789
|
<dl>
|
|
2770
3790
|
<dd>
|
|
2771
3791
|
|
|
2772
|
-
**
|
|
3792
|
+
**userId:** `string` — User ID
|
|
2773
3793
|
|
|
2774
3794
|
</dd>
|
|
2775
3795
|
</dl>
|
|
@@ -2777,7 +3797,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2777
3797
|
<dl>
|
|
2778
3798
|
<dd>
|
|
2779
3799
|
|
|
2780
|
-
**request:** `Zep.
|
|
3800
|
+
**request:** `Zep.graph.EpisodeGetByUserIdRequest`
|
|
2781
3801
|
|
|
2782
3802
|
</dd>
|
|
2783
3803
|
</dl>
|
|
@@ -2785,7 +3805,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2785
3805
|
<dl>
|
|
2786
3806
|
<dd>
|
|
2787
3807
|
|
|
2788
|
-
**requestOptions:** `
|
|
3808
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2789
3809
|
|
|
2790
3810
|
</dd>
|
|
2791
3811
|
</dl>
|
|
@@ -2796,7 +3816,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2796
3816
|
</dl>
|
|
2797
3817
|
</details>
|
|
2798
3818
|
|
|
2799
|
-
<details><summary><code>client.graph.
|
|
3819
|
+
<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
3820
|
<dl>
|
|
2801
3821
|
<dd>
|
|
2802
3822
|
|
|
@@ -2808,7 +3828,7 @@ await client.graph.edge.getByGraphId("graph_id", {});
|
|
|
2808
3828
|
<dl>
|
|
2809
3829
|
<dd>
|
|
2810
3830
|
|
|
2811
|
-
Returns
|
|
3831
|
+
Returns episodes by UUID
|
|
2812
3832
|
|
|
2813
3833
|
</dd>
|
|
2814
3834
|
</dl>
|
|
@@ -2824,7 +3844,7 @@ Returns all edges for a user.
|
|
|
2824
3844
|
<dd>
|
|
2825
3845
|
|
|
2826
3846
|
```typescript
|
|
2827
|
-
await client.graph.
|
|
3847
|
+
await client.graph.episode.get("uuid");
|
|
2828
3848
|
```
|
|
2829
3849
|
|
|
2830
3850
|
</dd>
|
|
@@ -2840,15 +3860,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2840
3860
|
<dl>
|
|
2841
3861
|
<dd>
|
|
2842
3862
|
|
|
2843
|
-
**
|
|
2844
|
-
|
|
2845
|
-
</dd>
|
|
2846
|
-
</dl>
|
|
2847
|
-
|
|
2848
|
-
<dl>
|
|
2849
|
-
<dd>
|
|
2850
|
-
|
|
2851
|
-
**request:** `Zep.GraphEdgesRequest`
|
|
3863
|
+
**uuid:** `string` — Episode UUID
|
|
2852
3864
|
|
|
2853
3865
|
</dd>
|
|
2854
3866
|
</dl>
|
|
@@ -2856,7 +3868,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2856
3868
|
<dl>
|
|
2857
3869
|
<dd>
|
|
2858
3870
|
|
|
2859
|
-
**requestOptions:** `
|
|
3871
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2860
3872
|
|
|
2861
3873
|
</dd>
|
|
2862
3874
|
</dl>
|
|
@@ -2867,7 +3879,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2867
3879
|
</dl>
|
|
2868
3880
|
</details>
|
|
2869
3881
|
|
|
2870
|
-
<details><summary><code>client.graph.
|
|
3882
|
+
<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
3883
|
<dl>
|
|
2872
3884
|
<dd>
|
|
2873
3885
|
|
|
@@ -2879,7 +3891,7 @@ await client.graph.edge.getByUserId("user_id", {});
|
|
|
2879
3891
|
<dl>
|
|
2880
3892
|
<dd>
|
|
2881
3893
|
|
|
2882
|
-
|
|
3894
|
+
Deletes an episode by its UUID.
|
|
2883
3895
|
|
|
2884
3896
|
</dd>
|
|
2885
3897
|
</dl>
|
|
@@ -2895,7 +3907,7 @@ Returns a specific edge by its UUID.
|
|
|
2895
3907
|
<dd>
|
|
2896
3908
|
|
|
2897
3909
|
```typescript
|
|
2898
|
-
await client.graph.
|
|
3910
|
+
await client.graph.episode.delete("uuid");
|
|
2899
3911
|
```
|
|
2900
3912
|
|
|
2901
3913
|
</dd>
|
|
@@ -2911,7 +3923,7 @@ await client.graph.edge.get("uuid");
|
|
|
2911
3923
|
<dl>
|
|
2912
3924
|
<dd>
|
|
2913
3925
|
|
|
2914
|
-
**uuid:** `string` —
|
|
3926
|
+
**uuid:** `string` — Episode UUID
|
|
2915
3927
|
|
|
2916
3928
|
</dd>
|
|
2917
3929
|
</dl>
|
|
@@ -2919,7 +3931,7 @@ await client.graph.edge.get("uuid");
|
|
|
2919
3931
|
<dl>
|
|
2920
3932
|
<dd>
|
|
2921
3933
|
|
|
2922
|
-
**requestOptions:** `
|
|
3934
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2923
3935
|
|
|
2924
3936
|
</dd>
|
|
2925
3937
|
</dl>
|
|
@@ -2930,7 +3942,7 @@ await client.graph.edge.get("uuid");
|
|
|
2930
3942
|
</dl>
|
|
2931
3943
|
</details>
|
|
2932
3944
|
|
|
2933
|
-
<details><summary><code>client.graph.
|
|
3945
|
+
<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
3946
|
<dl>
|
|
2935
3947
|
<dd>
|
|
2936
3948
|
|
|
@@ -2942,7 +3954,7 @@ await client.graph.edge.get("uuid");
|
|
|
2942
3954
|
<dl>
|
|
2943
3955
|
<dd>
|
|
2944
3956
|
|
|
2945
|
-
|
|
3957
|
+
Update episode metadata with merge semantics. Supplied keys overwrite or add to existing metadata; keys set to null are removed.
|
|
2946
3958
|
|
|
2947
3959
|
</dd>
|
|
2948
3960
|
</dl>
|
|
@@ -2958,7 +3970,11 @@ Deletes an edge by UUID.
|
|
|
2958
3970
|
<dd>
|
|
2959
3971
|
|
|
2960
3972
|
```typescript
|
|
2961
|
-
await client.graph.
|
|
3973
|
+
await client.graph.episode.update("uuid", {
|
|
3974
|
+
metadata: {
|
|
3975
|
+
key: "value",
|
|
3976
|
+
},
|
|
3977
|
+
});
|
|
2962
3978
|
```
|
|
2963
3979
|
|
|
2964
3980
|
</dd>
|
|
@@ -2974,7 +3990,7 @@ await client.graph.edge.delete("uuid");
|
|
|
2974
3990
|
<dl>
|
|
2975
3991
|
<dd>
|
|
2976
3992
|
|
|
2977
|
-
**uuid:** `string` —
|
|
3993
|
+
**uuid:** `string` — Episode UUID
|
|
2978
3994
|
|
|
2979
3995
|
</dd>
|
|
2980
3996
|
</dl>
|
|
@@ -2982,7 +3998,15 @@ await client.graph.edge.delete("uuid");
|
|
|
2982
3998
|
<dl>
|
|
2983
3999
|
<dd>
|
|
2984
4000
|
|
|
2985
|
-
**
|
|
4001
|
+
**request:** `Zep.graph.UpdateEpisodeRequest`
|
|
4002
|
+
|
|
4003
|
+
</dd>
|
|
4004
|
+
</dl>
|
|
4005
|
+
|
|
4006
|
+
<dl>
|
|
4007
|
+
<dd>
|
|
4008
|
+
|
|
4009
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
2986
4010
|
|
|
2987
4011
|
</dd>
|
|
2988
4012
|
</dl>
|
|
@@ -2993,7 +4017,7 @@ await client.graph.edge.delete("uuid");
|
|
|
2993
4017
|
</dl>
|
|
2994
4018
|
</details>
|
|
2995
4019
|
|
|
2996
|
-
<details><summary><code>client.graph.
|
|
4020
|
+
<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
4021
|
<dl>
|
|
2998
4022
|
<dd>
|
|
2999
4023
|
|
|
@@ -3005,7 +4029,7 @@ await client.graph.edge.delete("uuid");
|
|
|
3005
4029
|
<dl>
|
|
3006
4030
|
<dd>
|
|
3007
4031
|
|
|
3008
|
-
|
|
4032
|
+
Returns nodes and edges mentioned in an episode
|
|
3009
4033
|
|
|
3010
4034
|
</dd>
|
|
3011
4035
|
</dl>
|
|
@@ -3021,7 +4045,7 @@ Updates an entity edge by UUID.
|
|
|
3021
4045
|
<dd>
|
|
3022
4046
|
|
|
3023
4047
|
```typescript
|
|
3024
|
-
await client.graph.
|
|
4048
|
+
await client.graph.episode.getNodesAndEdges("uuid");
|
|
3025
4049
|
```
|
|
3026
4050
|
|
|
3027
4051
|
</dd>
|
|
@@ -3037,15 +4061,7 @@ await client.graph.edge.update("uuid");
|
|
|
3037
4061
|
<dl>
|
|
3038
4062
|
<dd>
|
|
3039
4063
|
|
|
3040
|
-
**uuid:** `string` —
|
|
3041
|
-
|
|
3042
|
-
</dd>
|
|
3043
|
-
</dl>
|
|
3044
|
-
|
|
3045
|
-
<dl>
|
|
3046
|
-
<dd>
|
|
3047
|
-
|
|
3048
|
-
**request:** `Zep.graph.UpdateEdgeRequest`
|
|
4064
|
+
**uuid:** `string` — Episode uuid
|
|
3049
4065
|
|
|
3050
4066
|
</dd>
|
|
3051
4067
|
</dl>
|
|
@@ -3053,7 +4069,7 @@ await client.graph.edge.update("uuid");
|
|
|
3053
4069
|
<dl>
|
|
3054
4070
|
<dd>
|
|
3055
4071
|
|
|
3056
|
-
**requestOptions:** `
|
|
4072
|
+
**requestOptions:** `Episode.RequestOptions`
|
|
3057
4073
|
|
|
3058
4074
|
</dd>
|
|
3059
4075
|
</dl>
|
|
@@ -3064,9 +4080,9 @@ await client.graph.edge.update("uuid");
|
|
|
3064
4080
|
</dl>
|
|
3065
4081
|
</details>
|
|
3066
4082
|
|
|
3067
|
-
## Graph
|
|
4083
|
+
## Graph Node
|
|
3068
4084
|
|
|
3069
|
-
<details><summary><code>client.graph.
|
|
4085
|
+
<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
4086
|
<dl>
|
|
3071
4087
|
<dd>
|
|
3072
4088
|
|
|
@@ -3078,7 +4094,7 @@ await client.graph.edge.update("uuid");
|
|
|
3078
4094
|
<dl>
|
|
3079
4095
|
<dd>
|
|
3080
4096
|
|
|
3081
|
-
Returns
|
|
4097
|
+
Returns all nodes for a graph.
|
|
3082
4098
|
|
|
3083
4099
|
</dd>
|
|
3084
4100
|
</dl>
|
|
@@ -3094,9 +4110,7 @@ Returns episodes by graph id.
|
|
|
3094
4110
|
<dd>
|
|
3095
4111
|
|
|
3096
4112
|
```typescript
|
|
3097
|
-
await client.graph.
|
|
3098
|
-
lastn: 1,
|
|
3099
|
-
});
|
|
4113
|
+
await client.graph.node.getByGraphId("graph_id", {});
|
|
3100
4114
|
```
|
|
3101
4115
|
|
|
3102
4116
|
</dd>
|
|
@@ -3120,7 +4134,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3120
4134
|
<dl>
|
|
3121
4135
|
<dd>
|
|
3122
4136
|
|
|
3123
|
-
**request:** `Zep.
|
|
4137
|
+
**request:** `Zep.GraphNodesRequest`
|
|
3124
4138
|
|
|
3125
4139
|
</dd>
|
|
3126
4140
|
</dl>
|
|
@@ -3128,7 +4142,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3128
4142
|
<dl>
|
|
3129
4143
|
<dd>
|
|
3130
4144
|
|
|
3131
|
-
**requestOptions:** `
|
|
4145
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3132
4146
|
|
|
3133
4147
|
</dd>
|
|
3134
4148
|
</dl>
|
|
@@ -3139,7 +4153,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3139
4153
|
</dl>
|
|
3140
4154
|
</details>
|
|
3141
4155
|
|
|
3142
|
-
<details><summary><code>client.graph.
|
|
4156
|
+
<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
4157
|
<dl>
|
|
3144
4158
|
<dd>
|
|
3145
4159
|
|
|
@@ -3151,7 +4165,7 @@ await client.graph.episode.getByGraphId("graph_id", {
|
|
|
3151
4165
|
<dl>
|
|
3152
4166
|
<dd>
|
|
3153
4167
|
|
|
3154
|
-
Returns
|
|
4168
|
+
Returns all nodes for a user
|
|
3155
4169
|
|
|
3156
4170
|
</dd>
|
|
3157
4171
|
</dl>
|
|
@@ -3167,9 +4181,7 @@ Returns episodes by user id.
|
|
|
3167
4181
|
<dd>
|
|
3168
4182
|
|
|
3169
4183
|
```typescript
|
|
3170
|
-
await client.graph.
|
|
3171
|
-
lastn: 1,
|
|
3172
|
-
});
|
|
4184
|
+
await client.graph.node.getByUserId("user_id", {});
|
|
3173
4185
|
```
|
|
3174
4186
|
|
|
3175
4187
|
</dd>
|
|
@@ -3193,7 +4205,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3193
4205
|
<dl>
|
|
3194
4206
|
<dd>
|
|
3195
4207
|
|
|
3196
|
-
**request:** `Zep.
|
|
4208
|
+
**request:** `Zep.GraphNodesRequest`
|
|
3197
4209
|
|
|
3198
4210
|
</dd>
|
|
3199
4211
|
</dl>
|
|
@@ -3201,7 +4213,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3201
4213
|
<dl>
|
|
3202
4214
|
<dd>
|
|
3203
4215
|
|
|
3204
|
-
**requestOptions:** `
|
|
4216
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3205
4217
|
|
|
3206
4218
|
</dd>
|
|
3207
4219
|
</dl>
|
|
@@ -3212,7 +4224,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3212
4224
|
</dl>
|
|
3213
4225
|
</details>
|
|
3214
4226
|
|
|
3215
|
-
<details><summary><code>client.graph.
|
|
4227
|
+
<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
4228
|
<dl>
|
|
3217
4229
|
<dd>
|
|
3218
4230
|
|
|
@@ -3224,7 +4236,7 @@ await client.graph.episode.getByUserId("user_id", {
|
|
|
3224
4236
|
<dl>
|
|
3225
4237
|
<dd>
|
|
3226
4238
|
|
|
3227
|
-
Returns
|
|
4239
|
+
Returns all edges for a node
|
|
3228
4240
|
|
|
3229
4241
|
</dd>
|
|
3230
4242
|
</dl>
|
|
@@ -3240,7 +4252,7 @@ Returns episodes by UUID
|
|
|
3240
4252
|
<dd>
|
|
3241
4253
|
|
|
3242
4254
|
```typescript
|
|
3243
|
-
await client.graph.
|
|
4255
|
+
await client.graph.node.getEdges("node_uuid");
|
|
3244
4256
|
```
|
|
3245
4257
|
|
|
3246
4258
|
</dd>
|
|
@@ -3256,7 +4268,7 @@ await client.graph.episode.get("uuid");
|
|
|
3256
4268
|
<dl>
|
|
3257
4269
|
<dd>
|
|
3258
4270
|
|
|
3259
|
-
**
|
|
4271
|
+
**nodeUuid:** `string` — Node UUID
|
|
3260
4272
|
|
|
3261
4273
|
</dd>
|
|
3262
4274
|
</dl>
|
|
@@ -3264,7 +4276,7 @@ await client.graph.episode.get("uuid");
|
|
|
3264
4276
|
<dl>
|
|
3265
4277
|
<dd>
|
|
3266
4278
|
|
|
3267
|
-
**requestOptions:** `
|
|
4279
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3268
4280
|
|
|
3269
4281
|
</dd>
|
|
3270
4282
|
</dl>
|
|
@@ -3275,7 +4287,7 @@ await client.graph.episode.get("uuid");
|
|
|
3275
4287
|
</dl>
|
|
3276
4288
|
</details>
|
|
3277
4289
|
|
|
3278
|
-
<details><summary><code>client.graph.
|
|
4290
|
+
<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
4291
|
<dl>
|
|
3280
4292
|
<dd>
|
|
3281
4293
|
|
|
@@ -3287,7 +4299,7 @@ await client.graph.episode.get("uuid");
|
|
|
3287
4299
|
<dl>
|
|
3288
4300
|
<dd>
|
|
3289
4301
|
|
|
3290
|
-
|
|
4302
|
+
Returns all episodes that mentioned a given node
|
|
3291
4303
|
|
|
3292
4304
|
</dd>
|
|
3293
4305
|
</dl>
|
|
@@ -3303,7 +4315,7 @@ Deletes an episode by its UUID.
|
|
|
3303
4315
|
<dd>
|
|
3304
4316
|
|
|
3305
4317
|
```typescript
|
|
3306
|
-
await client.graph.
|
|
4318
|
+
await client.graph.node.getEpisodes("node_uuid");
|
|
3307
4319
|
```
|
|
3308
4320
|
|
|
3309
4321
|
</dd>
|
|
@@ -3319,7 +4331,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3319
4331
|
<dl>
|
|
3320
4332
|
<dd>
|
|
3321
4333
|
|
|
3322
|
-
**
|
|
4334
|
+
**nodeUuid:** `string` — Node UUID
|
|
3323
4335
|
|
|
3324
4336
|
</dd>
|
|
3325
4337
|
</dl>
|
|
@@ -3327,7 +4339,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3327
4339
|
<dl>
|
|
3328
4340
|
<dd>
|
|
3329
4341
|
|
|
3330
|
-
**requestOptions:** `
|
|
4342
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3331
4343
|
|
|
3332
4344
|
</dd>
|
|
3333
4345
|
</dl>
|
|
@@ -3338,7 +4350,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3338
4350
|
</dl>
|
|
3339
4351
|
</details>
|
|
3340
4352
|
|
|
3341
|
-
<details><summary><code>client.graph.
|
|
4353
|
+
<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
4354
|
<dl>
|
|
3343
4355
|
<dd>
|
|
3344
4356
|
|
|
@@ -3350,7 +4362,7 @@ await client.graph.episode.delete("uuid");
|
|
|
3350
4362
|
<dl>
|
|
3351
4363
|
<dd>
|
|
3352
4364
|
|
|
3353
|
-
Returns
|
|
4365
|
+
Returns a specific node by its UUID.
|
|
3354
4366
|
|
|
3355
4367
|
</dd>
|
|
3356
4368
|
</dl>
|
|
@@ -3366,7 +4378,7 @@ Returns nodes and edges mentioned in an episode
|
|
|
3366
4378
|
<dd>
|
|
3367
4379
|
|
|
3368
4380
|
```typescript
|
|
3369
|
-
await client.graph.
|
|
4381
|
+
await client.graph.node.get("uuid");
|
|
3370
4382
|
```
|
|
3371
4383
|
|
|
3372
4384
|
</dd>
|
|
@@ -3382,7 +4394,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3382
4394
|
<dl>
|
|
3383
4395
|
<dd>
|
|
3384
4396
|
|
|
3385
|
-
**uuid:** `string` —
|
|
4397
|
+
**uuid:** `string` — Node UUID
|
|
3386
4398
|
|
|
3387
4399
|
</dd>
|
|
3388
4400
|
</dl>
|
|
@@ -3390,7 +4402,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3390
4402
|
<dl>
|
|
3391
4403
|
<dd>
|
|
3392
4404
|
|
|
3393
|
-
**requestOptions:** `
|
|
4405
|
+
**requestOptions:** `Node.RequestOptions`
|
|
3394
4406
|
|
|
3395
4407
|
</dd>
|
|
3396
4408
|
</dl>
|
|
@@ -3401,9 +4413,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3401
4413
|
</dl>
|
|
3402
4414
|
</details>
|
|
3403
4415
|
|
|
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>
|
|
4416
|
+
<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
4417
|
<dl>
|
|
3408
4418
|
<dd>
|
|
3409
4419
|
|
|
@@ -3415,7 +4425,7 @@ await client.graph.episode.getNodesAndEdges("uuid");
|
|
|
3415
4425
|
<dl>
|
|
3416
4426
|
<dd>
|
|
3417
4427
|
|
|
3418
|
-
|
|
4428
|
+
Deletes a node by UUID.
|
|
3419
4429
|
|
|
3420
4430
|
</dd>
|
|
3421
4431
|
</dl>
|
|
@@ -3431,7 +4441,7 @@ Returns all nodes for a graph.
|
|
|
3431
4441
|
<dd>
|
|
3432
4442
|
|
|
3433
4443
|
```typescript
|
|
3434
|
-
await client.graph.node.
|
|
4444
|
+
await client.graph.node.delete("uuid");
|
|
3435
4445
|
```
|
|
3436
4446
|
|
|
3437
4447
|
</dd>
|
|
@@ -3447,15 +4457,7 @@ await client.graph.node.getByGraphId("graph_id", {});
|
|
|
3447
4457
|
<dl>
|
|
3448
4458
|
<dd>
|
|
3449
4459
|
|
|
3450
|
-
**
|
|
3451
|
-
|
|
3452
|
-
</dd>
|
|
3453
|
-
</dl>
|
|
3454
|
-
|
|
3455
|
-
<dl>
|
|
3456
|
-
<dd>
|
|
3457
|
-
|
|
3458
|
-
**request:** `Zep.GraphNodesRequest`
|
|
4460
|
+
**uuid:** `string` — Node UUID
|
|
3459
4461
|
|
|
3460
4462
|
</dd>
|
|
3461
4463
|
</dl>
|
|
@@ -3474,7 +4476,7 @@ await client.graph.node.getByGraphId("graph_id", {});
|
|
|
3474
4476
|
</dl>
|
|
3475
4477
|
</details>
|
|
3476
4478
|
|
|
3477
|
-
<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">
|
|
4479
|
+
<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
4480
|
<dl>
|
|
3479
4481
|
<dd>
|
|
3480
4482
|
|
|
@@ -3486,7 +4488,7 @@ await client.graph.node.getByGraphId("graph_id", {});
|
|
|
3486
4488
|
<dl>
|
|
3487
4489
|
<dd>
|
|
3488
4490
|
|
|
3489
|
-
|
|
4491
|
+
Updates an entity node by UUID.
|
|
3490
4492
|
|
|
3491
4493
|
</dd>
|
|
3492
4494
|
</dl>
|
|
@@ -3502,7 +4504,7 @@ Returns all nodes for a user
|
|
|
3502
4504
|
<dd>
|
|
3503
4505
|
|
|
3504
4506
|
```typescript
|
|
3505
|
-
await client.graph.node.
|
|
4507
|
+
await client.graph.node.update("uuid");
|
|
3506
4508
|
```
|
|
3507
4509
|
|
|
3508
4510
|
</dd>
|
|
@@ -3518,7 +4520,7 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3518
4520
|
<dl>
|
|
3519
4521
|
<dd>
|
|
3520
4522
|
|
|
3521
|
-
**
|
|
4523
|
+
**uuid:** `string` — Node UUID
|
|
3522
4524
|
|
|
3523
4525
|
</dd>
|
|
3524
4526
|
</dl>
|
|
@@ -3526,7 +4528,7 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3526
4528
|
<dl>
|
|
3527
4529
|
<dd>
|
|
3528
4530
|
|
|
3529
|
-
**request:** `Zep.
|
|
4531
|
+
**request:** `Zep.graph.UpdateNodeRequest`
|
|
3530
4532
|
|
|
3531
4533
|
</dd>
|
|
3532
4534
|
</dl>
|
|
@@ -3545,7 +4547,9 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3545
4547
|
</dl>
|
|
3546
4548
|
</details>
|
|
3547
4549
|
|
|
3548
|
-
|
|
4550
|
+
## Graph Observation
|
|
4551
|
+
|
|
4552
|
+
<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
4553
|
<dl>
|
|
3550
4554
|
<dd>
|
|
3551
4555
|
|
|
@@ -3557,7 +4561,7 @@ await client.graph.node.getByUserId("user_id", {});
|
|
|
3557
4561
|
<dl>
|
|
3558
4562
|
<dd>
|
|
3559
4563
|
|
|
3560
|
-
Returns
|
|
4564
|
+
Returns read-only observation nodes for a graph.
|
|
3561
4565
|
|
|
3562
4566
|
</dd>
|
|
3563
4567
|
</dl>
|
|
@@ -3573,7 +4577,7 @@ Returns all edges for a node
|
|
|
3573
4577
|
<dd>
|
|
3574
4578
|
|
|
3575
4579
|
```typescript
|
|
3576
|
-
await client.graph.
|
|
4580
|
+
await client.graph.observation.getByGraphId("graph_id", {});
|
|
3577
4581
|
```
|
|
3578
4582
|
|
|
3579
4583
|
</dd>
|
|
@@ -3589,7 +4593,7 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3589
4593
|
<dl>
|
|
3590
4594
|
<dd>
|
|
3591
4595
|
|
|
3592
|
-
**
|
|
4596
|
+
**graphId:** `string` — Graph ID
|
|
3593
4597
|
|
|
3594
4598
|
</dd>
|
|
3595
4599
|
</dl>
|
|
@@ -3597,7 +4601,15 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3597
4601
|
<dl>
|
|
3598
4602
|
<dd>
|
|
3599
4603
|
|
|
3600
|
-
**
|
|
4604
|
+
**request:** `Zep.GraphObservationsRequest`
|
|
4605
|
+
|
|
4606
|
+
</dd>
|
|
4607
|
+
</dl>
|
|
4608
|
+
|
|
4609
|
+
<dl>
|
|
4610
|
+
<dd>
|
|
4611
|
+
|
|
4612
|
+
**requestOptions:** `Observation.RequestOptions`
|
|
3601
4613
|
|
|
3602
4614
|
</dd>
|
|
3603
4615
|
</dl>
|
|
@@ -3608,7 +4620,7 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3608
4620
|
</dl>
|
|
3609
4621
|
</details>
|
|
3610
4622
|
|
|
3611
|
-
<details><summary><code>client.graph.
|
|
4623
|
+
<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
4624
|
<dl>
|
|
3613
4625
|
<dd>
|
|
3614
4626
|
|
|
@@ -3620,7 +4632,7 @@ await client.graph.node.getEdges("node_uuid");
|
|
|
3620
4632
|
<dl>
|
|
3621
4633
|
<dd>
|
|
3622
4634
|
|
|
3623
|
-
Returns
|
|
4635
|
+
Returns read-only observation nodes for a user's graph.
|
|
3624
4636
|
|
|
3625
4637
|
</dd>
|
|
3626
4638
|
</dl>
|
|
@@ -3636,7 +4648,7 @@ Returns all episodes that mentioned a given node
|
|
|
3636
4648
|
<dd>
|
|
3637
4649
|
|
|
3638
4650
|
```typescript
|
|
3639
|
-
await client.graph.
|
|
4651
|
+
await client.graph.observation.getByUserId("user_id", {});
|
|
3640
4652
|
```
|
|
3641
4653
|
|
|
3642
4654
|
</dd>
|
|
@@ -3652,7 +4664,7 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3652
4664
|
<dl>
|
|
3653
4665
|
<dd>
|
|
3654
4666
|
|
|
3655
|
-
**
|
|
4667
|
+
**userId:** `string` — User ID
|
|
3656
4668
|
|
|
3657
4669
|
</dd>
|
|
3658
4670
|
</dl>
|
|
@@ -3660,7 +4672,15 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3660
4672
|
<dl>
|
|
3661
4673
|
<dd>
|
|
3662
4674
|
|
|
3663
|
-
**
|
|
4675
|
+
**request:** `Zep.GraphObservationsRequest`
|
|
4676
|
+
|
|
4677
|
+
</dd>
|
|
4678
|
+
</dl>
|
|
4679
|
+
|
|
4680
|
+
<dl>
|
|
4681
|
+
<dd>
|
|
4682
|
+
|
|
4683
|
+
**requestOptions:** `Observation.RequestOptions`
|
|
3664
4684
|
|
|
3665
4685
|
</dd>
|
|
3666
4686
|
</dl>
|
|
@@ -3671,7 +4691,7 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3671
4691
|
</dl>
|
|
3672
4692
|
</details>
|
|
3673
4693
|
|
|
3674
|
-
<details><summary><code>client.graph.
|
|
4694
|
+
<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
4695
|
<dl>
|
|
3676
4696
|
<dd>
|
|
3677
4697
|
|
|
@@ -3683,7 +4703,7 @@ await client.graph.node.getEpisodes("node_uuid");
|
|
|
3683
4703
|
<dl>
|
|
3684
4704
|
<dd>
|
|
3685
4705
|
|
|
3686
|
-
Returns a specific node by
|
|
4706
|
+
Returns a specific observation node by UUID. Observation nodes are read-only.
|
|
3687
4707
|
|
|
3688
4708
|
</dd>
|
|
3689
4709
|
</dl>
|
|
@@ -3699,7 +4719,7 @@ Returns a specific node by its UUID.
|
|
|
3699
4719
|
<dd>
|
|
3700
4720
|
|
|
3701
4721
|
```typescript
|
|
3702
|
-
await client.graph.
|
|
4722
|
+
await client.graph.observation.get("uuid");
|
|
3703
4723
|
```
|
|
3704
4724
|
|
|
3705
4725
|
</dd>
|
|
@@ -3715,7 +4735,7 @@ await client.graph.node.get("uuid");
|
|
|
3715
4735
|
<dl>
|
|
3716
4736
|
<dd>
|
|
3717
4737
|
|
|
3718
|
-
**uuid:** `string` —
|
|
4738
|
+
**uuid:** `string` — Observation UUID
|
|
3719
4739
|
|
|
3720
4740
|
</dd>
|
|
3721
4741
|
</dl>
|
|
@@ -3723,7 +4743,7 @@ await client.graph.node.get("uuid");
|
|
|
3723
4743
|
<dl>
|
|
3724
4744
|
<dd>
|
|
3725
4745
|
|
|
3726
|
-
**requestOptions:** `
|
|
4746
|
+
**requestOptions:** `Observation.RequestOptions`
|
|
3727
4747
|
|
|
3728
4748
|
</dd>
|
|
3729
4749
|
</dl>
|
|
@@ -3734,7 +4754,9 @@ await client.graph.node.get("uuid");
|
|
|
3734
4754
|
</dl>
|
|
3735
4755
|
</details>
|
|
3736
4756
|
|
|
3737
|
-
|
|
4757
|
+
## Graph ThreadSummary
|
|
4758
|
+
|
|
4759
|
+
<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
4760
|
<dl>
|
|
3739
4761
|
<dd>
|
|
3740
4762
|
|
|
@@ -3746,7 +4768,7 @@ await client.graph.node.get("uuid");
|
|
|
3746
4768
|
<dl>
|
|
3747
4769
|
<dd>
|
|
3748
4770
|
|
|
3749
|
-
|
|
4771
|
+
Returns incremental thread summaries associated with the graph.
|
|
3750
4772
|
|
|
3751
4773
|
</dd>
|
|
3752
4774
|
</dl>
|
|
@@ -3762,7 +4784,7 @@ Deletes a node by UUID.
|
|
|
3762
4784
|
<dd>
|
|
3763
4785
|
|
|
3764
4786
|
```typescript
|
|
3765
|
-
await client.graph.
|
|
4787
|
+
await client.graph.threadSummary.getByGraphId("graph_id", {});
|
|
3766
4788
|
```
|
|
3767
4789
|
|
|
3768
4790
|
</dd>
|
|
@@ -3778,7 +4800,7 @@ await client.graph.node.delete("uuid");
|
|
|
3778
4800
|
<dl>
|
|
3779
4801
|
<dd>
|
|
3780
4802
|
|
|
3781
|
-
**
|
|
4803
|
+
**graphId:** `string` — Graph ID
|
|
3782
4804
|
|
|
3783
4805
|
</dd>
|
|
3784
4806
|
</dl>
|
|
@@ -3786,7 +4808,15 @@ await client.graph.node.delete("uuid");
|
|
|
3786
4808
|
<dl>
|
|
3787
4809
|
<dd>
|
|
3788
4810
|
|
|
3789
|
-
**
|
|
4811
|
+
**request:** `Zep.GraphThreadSummariesRequest`
|
|
4812
|
+
|
|
4813
|
+
</dd>
|
|
4814
|
+
</dl>
|
|
4815
|
+
|
|
4816
|
+
<dl>
|
|
4817
|
+
<dd>
|
|
4818
|
+
|
|
4819
|
+
**requestOptions:** `ThreadSummary.RequestOptions`
|
|
3790
4820
|
|
|
3791
4821
|
</dd>
|
|
3792
4822
|
</dl>
|
|
@@ -3797,7 +4827,7 @@ await client.graph.node.delete("uuid");
|
|
|
3797
4827
|
</dl>
|
|
3798
4828
|
</details>
|
|
3799
4829
|
|
|
3800
|
-
<details><summary><code>client.graph.
|
|
4830
|
+
<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
4831
|
<dl>
|
|
3802
4832
|
<dd>
|
|
3803
4833
|
|
|
@@ -3809,7 +4839,7 @@ await client.graph.node.delete("uuid");
|
|
|
3809
4839
|
<dl>
|
|
3810
4840
|
<dd>
|
|
3811
4841
|
|
|
3812
|
-
|
|
4842
|
+
Returns incremental thread summaries generated from messages in each thread associated with the user's graph.
|
|
3813
4843
|
|
|
3814
4844
|
</dd>
|
|
3815
4845
|
</dl>
|
|
@@ -3825,7 +4855,7 @@ Updates an entity node by UUID.
|
|
|
3825
4855
|
<dd>
|
|
3826
4856
|
|
|
3827
4857
|
```typescript
|
|
3828
|
-
await client.graph.
|
|
4858
|
+
await client.graph.threadSummary.getByUserId("user_id", {});
|
|
3829
4859
|
```
|
|
3830
4860
|
|
|
3831
4861
|
</dd>
|
|
@@ -3841,7 +4871,7 @@ await client.graph.node.update("uuid");
|
|
|
3841
4871
|
<dl>
|
|
3842
4872
|
<dd>
|
|
3843
4873
|
|
|
3844
|
-
**
|
|
4874
|
+
**userId:** `string` — User ID
|
|
3845
4875
|
|
|
3846
4876
|
</dd>
|
|
3847
4877
|
</dl>
|
|
@@ -3849,7 +4879,7 @@ await client.graph.node.update("uuid");
|
|
|
3849
4879
|
<dl>
|
|
3850
4880
|
<dd>
|
|
3851
4881
|
|
|
3852
|
-
**request:** `Zep.
|
|
4882
|
+
**request:** `Zep.GraphThreadSummariesRequest`
|
|
3853
4883
|
|
|
3854
4884
|
</dd>
|
|
3855
4885
|
</dl>
|
|
@@ -3857,7 +4887,7 @@ await client.graph.node.update("uuid");
|
|
|
3857
4887
|
<dl>
|
|
3858
4888
|
<dd>
|
|
3859
4889
|
|
|
3860
|
-
**requestOptions:** `
|
|
4890
|
+
**requestOptions:** `ThreadSummary.RequestOptions`
|
|
3861
4891
|
|
|
3862
4892
|
</dd>
|
|
3863
4893
|
</dl>
|