Search Results for

    Show / Hide Table of Contents

    Class ConversationService

    Inheritance
    object
    CrudServiceBase<OpenAIClient>
    ConversationService
    Implements
    ICrudService
    Inherited Members
    CrudServiceBase<OpenAIClient>.client
    CrudServiceBase<OpenAIClient>.ApiKey
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Glitch9.AIDevKit.OpenAI.Services
    Assembly: Glitch9.AIDevKit.Provider.OpenAI.dll
    Syntax
    public sealed class ConversationService : CrudServiceBase<OpenAIClient>, ICrudService

    Constructors

    | Edit this page View Source

    ConversationService(OpenAIClient)

    Declaration
    public ConversationService(OpenAIClient client)
    Parameters
    Type Name Description
    OpenAIClient client

    Methods

    | Edit this page View Source

    CreateAsync(RequestOptions)

    Declaration
    public UniTask<Conversation> CreateAsync(RequestOptions options = null)
    Parameters
    Type Name Description
    RequestOptions options
    Returns
    Type Description
    UniTask<Conversation>
    | Edit this page View Source

    CreateAsync(string, RequestOptions)

    Declaration
    public UniTask<Conversation> CreateAsync(string agentId, RequestOptions options = null)
    Parameters
    Type Name Description
    string agentId
    RequestOptions options
    Returns
    Type Description
    UniTask<Conversation>
    | Edit this page View Source

    CreateItemsAsync(string, ConversationItem[], RequestOptions)

    Create items in a conversation with the given ID.

    Declaration
    public UniTask<Queried<ConversationItem>> CreateItemsAsync(string conversationId, ConversationItem[] items, RequestOptions options = null)
    Parameters
    Type Name Description
    string conversationId
    ConversationItem[] items
    RequestOptions options
    Returns
    Type Description
    UniTask<Queried<ConversationItem>>
    | Edit this page View Source

    DeleteAsync(string, RequestOptions)

    Declaration
    public UniTask<bool> DeleteAsync(string id, RequestOptions options = null)
    Parameters
    Type Name Description
    string id
    RequestOptions options
    Returns
    Type Description
    UniTask<bool>
    | Edit this page View Source

    DeleteItemAsync(string, string, RequestOptions)

    Delete an item from a conversation with the given IDs.

    Declaration
    public UniTask<Conversation> DeleteItemAsync(string conversationId, string itemId, RequestOptions options = null)
    Parameters
    Type Name Description
    string conversationId
    string itemId
    RequestOptions options
    Returns
    Type Description
    UniTask<Conversation>
    | Edit this page View Source

    GetList()

    Declaration
    public List<Conversation> GetList()
    Returns
    Type Description
    List<Conversation>
    | Edit this page View Source

    ListItemsAsync(string, CursorQuery, RequestOptions)

    List all items for a conversation with the given ID.

    Declaration
    public UniTask<Queried<ConversationItem>> ListItemsAsync(string conversationId, CursorQuery query = null, RequestOptions options = null)
    Parameters
    Type Name Description
    string conversationId
    CursorQuery query
    RequestOptions options
    Returns
    Type Description
    UniTask<Queried<ConversationItem>>
    | Edit this page View Source

    RetrieveAsync(string, RequestOptions)

    Declaration
    public UniTask<Conversation> RetrieveAsync(string id, RequestOptions options = null)
    Parameters
    Type Name Description
    string id
    RequestOptions options
    Returns
    Type Description
    UniTask<Conversation>
    | Edit this page View Source

    RetrieveItemAsync(string, string, OutputDataList, RequestOptions)

    Get a single item from a conversation with the given IDs.

    Declaration
    public UniTask<ConversationItem> RetrieveItemAsync(string conversationId, string itemId, OutputDataList Include = null, RequestOptions options = null)
    Parameters
    Type Name Description
    string conversationId
    string itemId
    OutputDataList Include
    RequestOptions options
    Returns
    Type Description
    UniTask<ConversationItem>
    | Edit this page View Source

    UpdateAsync(string, ServerDictionary, RequestOptions)

    Declaration
    public UniTask<Conversation> UpdateAsync(string id, ServerDictionary metadata, RequestOptions options = null)
    Parameters
    Type Name Description
    string id
    ServerDictionary metadata
    RequestOptions options
    Returns
    Type Description
    UniTask<Conversation>

    Implements

    ICrudService

    Extension Methods

    ArrayExtensions.ToArrayOrEmpty<T>(T)
    ArrayExtensions.ToArrayOrNull<T>(T)
    EventExtensions.ToDelta<T>(T, string, int, string, bool)
    EventExtensions.ToDone<T>(T, string, int, string)
    EventExtensions.ToEvent<T>(T)
    EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)
    FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)
    ResponseCastingExtensions.GetResult<T>(T)
    SystemExtensions.GetName(object)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation