Table of Contents

Namespace Glitch9.AIDevKit.OpenAI

Classes

Assistant

Renamed from AssistantObject to Assistant (2024.06.14)

AssistantsApiToolOutput
Attachment
Batch
BatchErrorData
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

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
MessageFile

A list of files attached to a message.

MessageInfo
ModerationDetail
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

NoiseReductionConfig
OpenAIAudioFormat
OpenAIClient

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

OpenAIErrorHandler
OpenAIFile

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

OpenAIFileUploadRequest

Upload a file that can be used across various endpoints. The size of all the files uploaded by one organization can be up to 100 GB. The size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. See the Assistants Tools guide to learn more about the types of files supported. The Fine-tuning API only supports .jsonl files.

Please contact us if you need to increase these storage limits. https://help.openai.com/en/

OpenAIImageStreamEvent
OpenAIModelData

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

OpenAIObject
OpenAISettings
OpenAISpeechGenerationEvent
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.

OpenAIVoice
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)

ThreadExtensions
ThreadMessage

Represents a message within a thread.

ThreadMessageDelta

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

ThreadMessageExtensions

Extension methods for ThreadMessage and Message.

ThreadMessageRequest
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.

TracingConfig
TranscriptionConfig

Configuration for input audio transcription, defaults to off and can be set to null to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through the /audio/transcriptions endpoint and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.

VectorStore
VectorStoreFile
VectorStoreFileRequest
VectorStoreFilesBatch
VectorStoreFilesBatchRequest
VectorStoreRequest

Enums

CodeInterpreterOutputType
EncodingFormat
FineTuningJobStatus
ModelEndpoint

Represents the endpoints available for AI models.

RequiredActionType
RunStatus

Enum representing the various statuses a Run can have during its lifecycle.