Interface IAssistantService

Namespace

OpenAI.Interfaces

Assembly

AntRunnerLib.dll

public interface IAssistantService

Methods

AssistantCreate(AssistantCreateRequest, String, CancellationToken)

Create an assistant with a model and instructions.

Task<AssistantResponse> AssistantCreate(AssistantCreateRequest request, string modelId = null, CancellationToken cancellationToken = null)

Parameters

request AssistantCreateRequest

modelId System.String

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

cancellationToken CancellationToken

Returns

Task<AssistantResponse>

AssistantDelete(String, CancellationToken)

Delete an assistant.

Task<DeletionStatusResponse> AssistantDelete(string assistantId, CancellationToken cancellationToken = null)

Parameters

assistantId System.String

The ID of the assistant to delete.

cancellationToken CancellationToken

Returns

Task<DeletionStatusResponse>

AssistantList(PaginationRequest, CancellationToken)

Returns a list of assistants.

Task<AssistantListResponse> AssistantList(PaginationRequest request = null, CancellationToken cancellationToken = null)

Parameters

request PaginationRequest

cancellationToken CancellationToken

Returns

Task<AssistantListResponse>

AssistantModify(String, AssistantModifyRequest, CancellationToken)

Modifies an assistant.

Task<AssistantResponse> AssistantModify(string assistantId, AssistantModifyRequest request, CancellationToken cancellationToken = null)

Parameters

assistantId System.String

The ID of the assistant to modify.

request AssistantModifyRequest

cancellationToken CancellationToken

Returns

Task<AssistantResponse>

AssistantRetrieve(String, CancellationToken)

Retrieves an assistant.

Task<AssistantResponse> AssistantRetrieve(string assistantId, CancellationToken cancellationToken = null)

Parameters

assistantId System.String

The ID of the assistant to retrieve.

cancellationToken CancellationToken

Returns

Task<AssistantResponse>