Class AssistantsEndpoint

Namespace

OpenAI.Assistants

Assembly

OpenAI-DotNet.dll

public sealed class AssistantsEndpoint : OpenAIBaseEndpoint

Inheritance

object

OpenAIBaseEndpoint

AssistantsEndpoint

Inherited Members

OpenAIBaseEndpoint.EnableDebug

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Root

The root endpoint address.

protected override string Root { get; }

Property Value

string

Methods

CreateAssistantAsync(CreateAssistantRequest, CancellationToken)

Create an assistant.

public Task<AssistantResponse> CreateAssistantAsync(CreateAssistantRequest request = null, CancellationToken cancellationToken = default)

Parameters

request CreateAssistantRequest

CreateAssistantRequest.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<AssistantResponse>

AssistantResponse.

CreateAssistantAsync<T>(CreateAssistantRequest, CancellationToken)

Create an assistant.

public Task<AssistantResponse> CreateAssistantAsync<T>(CreateAssistantRequest request = null, CancellationToken cancellationToken = default)

Parameters

request CreateAssistantRequest

CreateAssistantRequest.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<AssistantResponse>

AssistantResponse.

Type Parameters

T

JsonSchema to use for structured outputs.

DeleteAssistantAsync(string, CancellationToken)

Delete an assistant.

public Task<bool> DeleteAssistantAsync(string assistantId, CancellationToken cancellationToken = default)

Parameters

assistantId string

The ID of the assistant to delete.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<bool>

True, if the assistant was deleted.

ListAssistantsAsync(ListQuery, CancellationToken)

Get list of assistants.

public Task<ListResponse<AssistantResponse>> ListAssistantsAsync(ListQuery query = null, CancellationToken cancellationToken = default)

Parameters

query ListQuery

ListQuery.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<ListResponse<AssistantResponse>>

ListResponse<TObject>.

ModifyAssistantAsync(string, CreateAssistantRequest, CancellationToken)

Modifies an assistant.

public Task<AssistantResponse> ModifyAssistantAsync(string assistantId, CreateAssistantRequest request, CancellationToken cancellationToken = default)

Parameters

assistantId string

The ID of the assistant to modify.

request CreateAssistantRequest

CreateAssistantRequest.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<AssistantResponse>

AssistantResponse.

RetrieveAssistantAsync(string, CancellationToken)

Retrieves an assistant.

public Task<AssistantResponse> RetrieveAssistantAsync(string assistantId, CancellationToken cancellationToken = default)

Parameters

assistantId string

The ID of the assistant to retrieve.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<AssistantResponse>

AssistantResponse.