Memory Stores
Search memories
Searches the specified memory store for memories relevant to the provided conversation context.
Header parameters
Foundry-Features
enum
required
A feature flag opt-in required when using preview operations or modifying persisted preview resources.
Path parameters
name
string
required
The name of the memory store to search.
Query parameters
api-version
string
required
The API version to use for this operation.
Request Body
scope
string
required
The namespace that logically groups and isolates memories, such as a user ID.
items
OpenAI.InputItem[]
Items for which to search for relevant memories.
previous_search_id
string
The unique ID of the previous search request, enabling incremental memory search from where the last operation left off.
options
MemorySearchOptions
Memory search options.
max_memories
integer
Maximum number of memory items to return.
Responses
The request has succeeded.
Body
search_id
string
required
The unique ID of this search request. Use this value as previous_search_id in subsequent requests to perform incremental searches.
memories
MemorySearchItem[]
required
Related memory items found during the search operation.
usage
MemoryStoreOperationUsage
required
Usage statistics of a memory store operation.
embedding_tokens
integer
required
The number of embedding tokens.
input_tokens_details
OpenAI.ResponseUsageInputTokensDetails
required
output_tokens_details
OpenAI.ResponseUsageOutputTokensDetails
required
Request
POST /memory_stores/{name}:search_memories HTTP/1.1Response
Status: 200
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json