AI DevKit
Search Results for

    Show / Hide Table of Contents

    Class ChatCompletionRequest

    Inheritance
    object
    RESTRequestBody
    OpenAIRequest
    CompletionRequest
    ChatCompletionRequest
    Inherited Members
    CompletionRequest.Prompt
    CompletionRequest.SystemInstruction
    CompletionRequest.Stream
    CompletionRequest.StreamOptions
    CompletionRequest.Temperature
    CompletionRequest.Seed
    CompletionRequest.MaxTokens
    CompletionRequest.ResponseFormat
    CompletionRequest.AttachedFiles
    CompletionRequest.Stop
    CompletionRequest.Options
    OpenAIRequest.Model
    OpenAIRequest.N
    OpenAIRequest.Metadata
    OpenAIRequest.User
    Namespace: Glitch9.AIDevKit
    Assembly: .dll
    Syntax
    public class ChatCompletionRequest : CompletionRequest

    Properties

    Messages

    Required. The messages in the conversation.

    Declaration
    public List<ChatMessage> Messages { get; set; }
    Property Value
    Type Description
    List<ChatMessage>

    Modalities

    Output types that you would like the model to generate. Most models are capable of generating text, which is the default:

    Declaration
    public Modality? Modalities { get; set; }
    Property Value
    Type Description
    Modality?

    StartingMessage

    Declaration
    public string StartingMessage { get; set; }
    Property Value
    Type Description
    string

    Summary

    Declaration
    public string Summary { get; set; }
    Property Value
    Type Description
    string

    ToolChoice

    Controls which (if any) Function is called by the model. none means the model will not call a Function and instead generates a message. auto means the model can pick between generating a message or calling a Function. Specifying a particular Function via {"type: "Function", "Function": {"name": "my_function"}} forces the model to call that Function. none is the default when no functions are present. auto is the default if functions are present.

    Declaration
    public ToolCall ToolChoice { get; set; }
    Property Value
    Type Description
    ToolCall

    Tools

    Optional. List of tools in JSON for the model to use if supported.

    Declaration
    public ToolCall[] Tools { get; set; }
    Property Value
    Type Description
    ToolCall[]

    Extension Methods

    ChatMessageExtensions.AppendUserMessageWithAttachments(ChatCompletionRequest)
    RequestExtensions.ExecuteAsync(ChatCompletionRequest)
    RequestExtensions.StreamAsync(ChatCompletionRequest)
    RequestExtensions.ExecuteAsync(ChatCompletionRequest)
    RequestExtensions.StreamAsync(ChatCompletionRequest)
    RequestExtensions.ExecuteAsync(ChatCompletionRequest)
    RequestExtensions.StreamAsync(ChatCompletionRequest)
    RequestExtensions.ExecuteAsync(CompletionRequest)
    RequestExtensions.StreamAsync(CompletionRequest)
    RequestExtensions.ExecuteAsync(CompletionRequest)
    RequestExtensions.StreamAsync(CompletionRequest)
    In this article
    Back to top Generated by DocFX