AIProjectMemoryStoresOperations.DeleteScopeAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| DeleteScopeAsync(String, BinaryContent, RequestOptions) |
[Protocol Method] Delete all memories associated with a specific scope from a memory store.
|
| DeleteScopeAsync(String, String, CancellationToken) |
Delete all memories associated with a specific scope from a memory store. |
DeleteScopeAsync(String, BinaryContent, RequestOptions)
[Protocol Method] Delete all memories associated with a specific scope from a memory store.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult> DeleteScopeAsync(string name, System.ClientModel.BinaryContent content, System.ClientModel.Primitives.RequestOptions options = default);abstract member DeleteScopeAsync : string * System.ClientModel.BinaryContent * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
override this.DeleteScopeAsync : string * System.ClientModel.BinaryContent * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>Public Overridable Function DeleteScopeAsync (name As String, content As BinaryContent, Optional options As RequestOptions = Nothing) As Task(Of ClientResult)Parameters
- name
- String
The name of the memory store.
- content
- BinaryContent
The content to send as the body of the request.
- options
- RequestOptions
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
name or content is null.
name is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
DeleteScopeAsync(String, String, CancellationToken)
Delete all memories associated with a specific scope from a memory store.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.MemoryStoreDeleteScopeResponse>> DeleteScopeAsync(string name, string scope, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteScopeAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.MemoryStoreDeleteScopeResponse>>
override this.DeleteScopeAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.MemoryStoreDeleteScopeResponse>>Public Overridable Function DeleteScopeAsync (name As String, scope As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of MemoryStoreDeleteScopeResponse))Parameters
- name
- String
The name of the memory store.
- scope
- String
The namespace that logically groups and isolates memories to delete, such as a user ID.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
name or scope is null.
name or scope is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
