Table of Contents

Class ResponseRequest

Namespace
Glitch9.AIDevKit.Responses
public class ResponseRequest : LanguageModelRequest<ResponseRequest, ConversationItem, Response>, ILanguageModelRequest, IGenerativeRequest, ISequentialRequest
Inheritance
object
ResponseRequest
Implements
Inherited Members
Extension Methods

Constructors

ResponseRequest() 

public ResponseRequest()

ResponseRequest(ConversationItem) 

public ResponseRequest(ConversationItem prompt)

Parameters

prompt ConversationItem

Properties

ConversationId

Optional. Defaults to null The conversation that this response belongs to. Items from this conversation are prepended to input_items for this response request. Input items and output items from this response are automatically added to this conversation after this response completes.

public string ConversationId { get; set; }

Property Value

string

Include

Optional. Specify additional output data to include in the model response.

public string[] Include { get; set; }

Property Value

string[]

IncludeObfuscation 

public bool? IncludeObfuscation { get; set; }

Property Value

bool?

Input

Optional. Text, image, or file inputs to the model, used to generate a response.

public StringOrArray<ConversationItem> Input { get; set; }

Property Value

StringOrArray<ConversationItem>

MaxToolCalls

Optional. The maximum number of total calls to built-in tools that can be processed in a response.

public int? MaxToolCalls { get; set; }

Property Value

int?

PreviousResponseId

Optional. The unique ID of the previous response to the model.

public string PreviousResponseId { get; set; }

Property Value

string

PromptCacheKey

Optional. Used by OpenAI to cache responses for similar requests to optimize your cache hit rates.

public string PromptCacheKey { get; set; }

Property Value

string

PromptReference

Optional. Reference to a prompt template and its variables.

public PromptTemplate PromptReference { get; set; }

Property Value

PromptTemplate

ResponseFormat

Defines how the response should be formatted (e.g., text, JSON).

public override ResponseFormat ResponseFormat { get; }

Property Value

ResponseFormat

Store

Optional. Defaults to true Whether to store the generated model response for later retrieval via API.

public bool? Store { get; set; }

Property Value

bool?

TextResponseOptions

Optional. Configuration options for a text response from the model.

public TextResponseOptions TextResponseOptions { get; set; }

Property Value

TextResponseOptions

Truncation

Optional. Defaults to disabled The truncation strategy to use for the model response.

public TruncationStrategy Truncation { get; set; }

Property Value

TruncationStrategy

Type 

public override FluentApiRequestType Type { get; }

Property Value

FluentApiRequestType

Methods

AddInput(ConversationItem) 

public ResponseRequest AddInput(ConversationItem item)

Parameters

item ConversationItem

Returns

ResponseRequest

AddInputRange(IEnumerable<ConversationItem>) 

public ResponseRequest AddInputRange(IEnumerable<ConversationItem> items)

Parameters

items IEnumerable<ConversationItem>

Returns

ResponseRequest

AddMessageRange(IEnumerable<Message>) 

public override ResponseRequest AddMessageRange(IEnumerable<Message> messages)

Parameters

messages IEnumerable<Message>

Returns

ResponseRequest

CreateStreamAsyncInternal() 

protected override UniTask<IO.Networking.RESTApi.IRESTStream<INoopStreamEvent<Response>>> CreateStreamAsyncInternal()

Returns

UniTask<IRESTStream<INoopStreamEvent<Response>>>

ExecuteAsyncInternal() 

protected override UniTask<Response> ExecuteAsyncInternal()

Returns

UniTask<Response>

GetMessages() 

public override List<Message> GetMessages()

Returns

List<Message>

SetConversationId(string) 

public ResponseRequest SetConversationId(string conversationId)

Parameters

conversationId string

Returns

ResponseRequest

SetIncludeObfuscation(bool) 

public ResponseRequest SetIncludeObfuscation(bool includeObfuscation)

Parameters

includeObfuscation bool

Returns

ResponseRequest

SetPreviousResponseId(string) 

public ResponseRequest SetPreviousResponseId(string responseId)

Parameters

responseId string

Returns

ResponseRequest