Search Results for

    Show / Hide Table of Contents

    Class ResponseService

    OpenAI's most advanced interface for generating model responses. Supports text and image inputs, and text outputs. Create stateful interactions with the model, using the output of previous responses as input. Extend the model's capabilities with built-in tools for file search, web search, computer use, and more. Allow the model access to external systems and data using function calling. https://platform.openai.com/docs/api-reference/responses

    Inheritance
    object
    CrudServiceBase<OpenAIClient>
    ResponseService
    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 ResponseService : CrudServiceBase<OpenAIClient>, ICrudService

    Constructors

    | Edit this page View Source

    ResponseService(OpenAIClient)

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

    Methods

    | Edit this page View Source

    CancelAsync(string, RequestOptions)

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

    CreateAsync(ResponseRequest, RequestOptions)

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

    DeleteAsync(string, RequestOptions)

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

    ListInputItemsAsync(string, CursorQuery, RequestOptions)

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

    RetrieveAsync(string, ResponseQuery, RequestOptions)

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

    StreamAsync(ResponseRequest, RequestOptions)

    Declaration
    public IGenerativeStream<ResponseEventBase, ConversationItem> StreamAsync(ResponseRequest request, RequestOptions options = null)
    Parameters
    Type Name Description
    ResponseRequest request
    RequestOptions options
    Returns
    Type Description
    IGenerativeStream<ResponseEventBase, ConversationItem>

    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