Class BatchRequest

Creates and executes a batch from an uploaded file of requests

Inheritance

object

OpenAIRequest

BatchRequest

Implements

IJsonRequest

Inherited Members

OpenAIRequest.Model

OpenAIRequest.N

OpenAIRequest.Metadata

OpenAIRequest.User

OpenAIRequest.SafetyIdentifier

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Glitch9.AIDevKit.OpenAI

Assembly: Glitch9.AIDevKit.Provider.OpenAI.dll

Syntax

public class BatchRequest : OpenAIRequest, IJsonRequest

Properties

BatchEndpoint

[Required] The endpoint to be used for all requests in the batch. Currently, /v1/chat/completions, /v1/embeddings, and /v1/completions are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.

Declaration

[JsonProperty("endpoint")]
public string BatchEndpoint { get; set; }

Property Value

Type	Description
string

CompletionWindow

[Required] The time frame within which the batch should be processed. Currently only 24h is supported.

Declaration

[JsonProperty("completion_window")]
public string CompletionWindow { get; set; }

Property Value

Type	Description
string

InputFileId

[Required] The ID of an uploaded file that contains requests for the new batch.

Declaration

[JsonProperty("input_file_id")]
public string InputFileId { get; set; }

Property Value

Type	Description
string

Implements

IJsonRequest

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)