AssistantsClient.UnlinkAssistantFileAsync Method

Reference

Definition

Namespace:: Azure.AI.OpenAI.Assistants

Assembly:: Azure.AI.OpenAI.Assistants.dll

Package:: Azure.AI.OpenAI.Assistants v1.0.0-beta.4

Source:: AssistantsClient.cs

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.

Removes an association between an uploaded file and an assistant, making it inaccessible to supported tools for that assistant.

public virtual System.Threading.Tasks.Task<Azure.Response<bool>> UnlinkAssistantFileAsync (string assistantId, string fileId, System.Threading.CancellationToken cancellationToken = default);

abstract member UnlinkAssistantFileAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.UnlinkAssistantFileAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>

Public Overridable Function UnlinkAssistantFileAsync (assistantId As String, fileId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))

Parameters

assistantId: String

The ID of the assistant associated with the attached file to delete.

fileId: String

The ID of the attached file to delete.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<Boolean>>

Exceptions

ArgumentNullException

assistantId or fileId is null.

ArgumentException

assistantId or fileId is an empty string, and was expected to be non-empty.

Remarks

This operation only removes the link between the file and assistant; it does not delete the file itself. To delete the file, use DeleteFile(String, CancellationToken), instead.

Applies to

Share via