Search memory for the specified session (cloud only)

Deprecated

POST

Search memory for the specified session. Deprecated, please use search_sessions method instead

Path parameters

sessionIdstringRequired

The ID of the session for which memory should be searched.

Query parameters

limitintegerOptional

The maximum number of search results to return. Defaults to None (no limit).

Request

This endpoint expects an object.

metadatamap from strings to anyOptional

Metadata Filter

min_fact_ratingdoubleOptional

min_scoredoubleOptional

mmr_lambdadoubleOptional

search_scopeenumOptional

Allowed values: messagessummaryfacts

search_type"similarity" or "mmr"Optional

Allowed values: similaritymmr

textstringOptional

Response

This endpoint returns a list of objects.

messageobjectOptional

metadatamap from strings to anyOptional

scoredoubleOptional

summaryobjectOptional

Errors

POST

1 curl -X POST https://api.getzep.com/api/v2/sessions/sessionId/search \
2      -H "Authorization: Api-Key <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Successful

1 [
2   {
3     "message": {
4       "content": "content",
5       "role_type": "norole",
6       "created_at": "created_at",
7       "metadata": {
8         "key": "value"
9       },
10       "role": "role",
11       "token_count": 1,
12       "updated_at": "updated_at",
13       "uuid": "uuid"
14     },
15     "metadata": {
16       "key": "value"
17     },
18     "score": 1.1,
19     "summary": {
20       "content": "content",
21       "created_at": "created_at",
22       "metadata": {
23         "key": "value"
24       },
25       "related_message_uuids": [
26         "related_message_uuids"
27       ],
28       "token_count": 1,
29       "uuid": "uuid"
30     }
31   }
32 ]

Built with

1	curl -X POST https://api.getzep.com/api/v2/sessions/sessionId/search \
2	-H "Authorization: Api-Key <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	[
2	{
3	"message": {
4	"content": "content",
5	"role_type": "norole",
6	"created_at": "created_at",
7	"metadata": {
8	"key": "value"
9	},
10	"role": "role",
11	"token_count": 1,
12	"updated_at": "updated_at",
13	"uuid": "uuid"
14	},
15	"metadata": {
16	"key": "value"
17	},
18	"score": 1.1,
19	"summary": {
20	"content": "content",
21	"created_at": "created_at",
22	"metadata": {
23	"key": "value"
24	},
25	"related_message_uuids": [
26	"related_message_uuids"
27	],
28	"token_count": 1,
29	"uuid": "uuid"
30	}
31	}
32	]