batch_delete_memory_records¶
Operation¶
batch_delete_memory_records
¶
batch_delete_memory_records(request: BatchDeleteMemoryRecordsInput | BatchDeleteMemoryRecordsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[BatchDeleteMemoryRecordsInputDict]) -> BatchDeleteMemoryRecordsOutput
Deletes multiple memory records in a single batch operation from the specified memory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
BatchDeleteMemoryRecordsInput | BatchDeleteMemoryRecordsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[BatchDeleteMemoryRecordsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
BatchDeleteMemoryRecordsOutput
|
An instance of |
batch_delete_memory_records
async
¶
batch_delete_memory_records(request: BatchDeleteMemoryRecordsInput | BatchDeleteMemoryRecordsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[BatchDeleteMemoryRecordsInputDict]) -> BatchDeleteMemoryRecordsOutput
Deletes multiple memory records in a single batch operation from the specified memory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
BatchDeleteMemoryRecordsInput | BatchDeleteMemoryRecordsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[BatchDeleteMemoryRecordsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
BatchDeleteMemoryRecordsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
BatchDeleteMemoryRecordsInputDict
¶
BatchDeleteMemoryRecordsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for BatchDeleteMemoryRecordsInput structure.
Attributes¶
memory_id
class-attribute
instance-attribute
¶
memory_id: str | None = ...
The unique ID of the memory resource where records will be deleted.
records
class-attribute
instance-attribute
¶
records: list[MemoryRecordDeleteInput] | None = ...
A list of memory record deletion inputs to be processed in the batch operation.
Output¶
BatchDeleteMemoryRecordsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for BatchDeleteMemoryRecordsOutput structure.
Attributes¶
failed_records
instance-attribute
¶
failed_records: list[MemoryRecordOutput]
A list of memory records that failed to be deleted, including error details for each failure.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
successful_records
instance-attribute
¶
successful_records: list[MemoryRecordOutput]
A list of memory records that were successfully deleted during the batch operation.