AI DevKit
Search Results for

    Show / Hide Table of Contents

    Class MessageService

    Messages: https://platform.openai.com/docs/api-reference/messages

    Inheritance
    object
    CRUDServiceBase<OpenAI>
    MessageService
    Inherited Members
    CRUDServiceBase<OpenAI>.client
    CRUDServiceBase<OpenAI>.IsBetaService
    CRUDServiceBase<OpenAI>.CustomApiKey
    CRUDServiceBase<OpenAI>.CustomBetaHeaders
    Namespace: Glitch9.AIDevKit.OpenAI.Services
    Assembly: .dll
    Syntax
    public class MessageService : CRUDServiceBase<OpenAI>

    Constructors

    MessageService(OpenAI, params RESTHeader[])

    Declaration
    public MessageService(OpenAI client, params RESTHeader[] extraHeaders)
    Parameters
    Type Name Description
    OpenAI client
    RESTHeader[] extraHeaders

    Methods

    CreateAsync(string, ThreadMessageRequest)

    Declaration
    public UniTask<ThreadMessage> CreateAsync(string threadId, ThreadMessageRequest req)
    Parameters
    Type Name Description
    string threadId
    ThreadMessageRequest req
    Returns
    Type Description
    UniTask<ThreadMessage>

    DeleteAsync(string, string, RESTRequestOptions)

    Declaration
    public UniTask<bool> DeleteAsync(string threadId, string messageId, RESTRequestOptions options = null)
    Parameters
    Type Name Description
    string threadId
    string messageId
    RESTRequestOptions options
    Returns
    Type Description
    UniTask<bool>

    ListAsync(string, CursorQuery, RESTRequestOptions)

    Declaration
    public UniTask<RESTQueryResponse<ThreadMessage>> ListAsync(string threadId, CursorQuery query = null, RESTRequestOptions options = null)
    Parameters
    Type Name Description
    string threadId
    CursorQuery query
    RESTRequestOptions options
    Returns
    Type Description
    UniTask<RESTQueryResponse<ThreadMessage>>

    ListFilesAsync(string, string, CursorQuery, RESTRequestOptions)

    Declaration
    public UniTask<RESTQueryResponse<MessageFile>> ListFilesAsync(string threadId, string messageId, CursorQuery query = null, RESTRequestOptions options = null)
    Parameters
    Type Name Description
    string threadId
    string messageId
    CursorQuery query
    RESTRequestOptions options
    Returns
    Type Description
    UniTask<RESTQueryResponse<MessageFile>>

    RetrieveAsync(string, string, RESTRequestOptions)

    Declaration
    public UniTask<ThreadMessage> RetrieveAsync(string threadId, string messageId, RESTRequestOptions options = null)
    Parameters
    Type Name Description
    string threadId
    string messageId
    RESTRequestOptions options
    Returns
    Type Description
    UniTask<ThreadMessage>

    RetrieveFileAsync(string, string, string, RESTRequestOptions)

    Declaration
    public UniTask<MessageFile> RetrieveFileAsync(string threadId, string messageId, string fileId, RESTRequestOptions options = null)
    Parameters
    Type Name Description
    string threadId
    string messageId
    string fileId
    RESTRequestOptions options
    Returns
    Type Description
    UniTask<MessageFile>

    UpdateAsync(string, string, ThreadMessageRequest)

    Declaration
    public UniTask<ThreadMessage> UpdateAsync(string threadId, string messageId, ThreadMessageRequest req)
    Parameters
    Type Name Description
    string threadId
    string messageId
    ThreadMessageRequest req
    Returns
    Type Description
    UniTask<ThreadMessage>
    In this article
    Back to top Generated by DocFX