Namespace Glitch9.AIDevKit.OpenAI

Classes

Assistant

Renamed from AssistantObject to Assistant (2024.06.14)

BatchErrors

The errors that occurred during the batch.

BatchRequest

Creates and executes a batch from an uploaded file of requests

BatchRequestInput

The per-line object of the batch input file

BatchRequestOutput

The per-line object of the batch output and error files

ChatCompletion

Response from a LLM (Large Language Model) for a chat completion request.

This class contains a list of ChatCompletionChoice objects, each representing a message generated by the model in response to a chat prompt.
Message can be accessed through the ChatCompletionChoice (e.g., Choices[0].Message).
If 'n' used in the request is greater than 1, this can contain multiple choices. Otherwise, it will always contain a single choice.

If this is a streamed response, the ChatCompletionChoice objects will contain MessageDelta instead of Message.

ChatCompletionAudioData

OpenAI style Generated Audio Data used by OpenAI.

ChatCompletionBase<TChoice>

ChatCompletionChoice

ChatCompletionChoiceBase

ChatCompletionChoiceDelta

ChatCompletionEvent

ChunkingStrategy

ChunkingStrategyStatic

CodeInterpreterImageOutput

CodeInterpreterLogOutput

CodeInterpreterOutput

CodeInterpreterResources

CodeInterpreterTool

Container

ContainerFile

ContainerFileRequest

ContainerRequest

ExpiresAfter

FileCounts

FileSearchResources

FineTuningEvent

Fine-tuning job event object

FineTuningJob

The fine_tuning.job object represents a fine-tuning job that has been created through the API.

FineTuningRequest

HttpResponse

IncludeOptions

IncludeQuery

LogprobsInfo

Log probability information for the choice.

MessageDelta

MessageFile

A list of files attached to a message.

MessageInfo

ModerationResponse

Given some input Text, outputs if the model classifies it as potentially harmful across several categories. Related guide: https://platform.openai.com/docs/guides/moderation POST https://api.openai.com/v1/moderations

ModerationResult

OpenAIClient

Represents the OpenAI service with methods to interact with the API.

OpenAIConfig

OpenAIExceptionParser

OpenAIFile

The File object represents a document that has been uploaded to OpenAI.

OpenAIImageData

OpenAIModelInfo

Describes an OpenAI model offering that can be used with the API.

OpenAIObject

Base class for all OpenAI API response objects. Provides common properties shared across different OpenAI API endpoints.

OpenAIRequest

OpenAISettings

OpenAISpeechEvent

OpenAISpeechGenerationRequest

Generates audio from the input text.

OpenAITranscriptionEvent

OpenAITranscriptionRequest

Transcribes audio into the input language.

OpenAITranscriptionRequest.ChunkingStrategyWrapper

OpenAITranscriptionRequest.ChunkingStrategyWrapper.ServerVad

OpenAITranslationRequest

Translates audio into English.

OpenAIVectorStore

OpenAIVectorStoreRequest

RequestCounts

The request counts for different statuses within the batch.

RequiredAction

Details on the action required to continue the Run.

Will be null if no action is required.

Run

Represents an execution run on a Thread.

Renamed from RunObject to Run (2024.06.14)

RunBase

Base class for Run and RunStep.

RunRequest

RunStep

RunStepDelta

https://platform.openai.com/docs/api-reference/assistants-streaming/run-step-delta-object

RunStepDeltaValue

SoraRemixVideoRequest

SoraVideoJob

SoraVideoJob.SoraError

SoraVideoRequest

StepDetails

The details of the run step.

TextEmbeddingRequest

Returns a list of embedding objects.

Thread

Thread object that assistants can interact with.

Renamed from ThreadObject to Thread (2024.06.14)

ThreadConversationExtensions

ThreadExtensions

ThreadMessage

Represents a message within a thread.

ThreadMessageDelta

https://platform.openai.com/docs/api-reference/assistants-streaming/message-delta-object

ThreadMessageExtensions

ThreadMessageRequest

TokenLogProb

A list of message content tokens with log probability information.

ToolEnvelope

ToolEnvelopeExtensions

ToolOutputSubmissionRequest

ToolOutputsSubmission

When a run has the status: RequiresAction and Type is SubmitToolOutputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

All outputs must be submitted in a single request.

ToolResources

A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

Namespace Glitch9.AIDevKit.OpenAI

Classes

Structs

Enums