Namespace Glitch9.AIDevKit.OpenAI

Classes

ActionRequest

Details on the action required to continue the Run.

Will be null if no action is required.

Assistant

Renamed from AssistantObject to Assistant (2024.06.14)

Give Assistants access to OpenAI-hosted tools like Issue Interpreter and Knowledge Retrieval, or build your own tools using Function calling. Usage of OpenAI-hosted tools comes at an additional fee — visit our help center article to learn more about how these tools are priced.

AssistantRequest.Builder

Attachment

Batch

BatchErrorData

BatchErrors

The errors that occurred during the batch.

BatchRequest

Creates and executes a batch from an uploaded file of requests

BatchRequest.Builder

BatchRequestInput

The per-line object of the batch input file

BatchRequestOutput

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

ChunkingStrategy

ChunkingStrategyStatic

CodeInterpreterCall

CodeInterpreterImageOutput

CodeInterpreterLogOutput

CodeInterpreterOutput

CodeInterpreterOutputConverter

CodeInterpreterResources

CodeInterpreterTool

Embedding

EmbeddingRequest

Returns a list of embedding objects.

EmbeddingRequest.Builder

Expiration

File

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

FileCounts

FileRequest

FileSearchCall

FileSearchResources

FileSearchTool

For now, this is always going to be an empty object.

FileUploadRequest

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/

FileUploadRequest.Builder

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

FineTuningRequest.Builder

FluentAPIExtensions

HttpResponse

HyperParameters

The hyperparameters used for the fine-tuning job.

Image

Represents the Url or the content of an image generated by the OpenAI API.

ImageCreationRequest

ImageEditRequest

ImageRequest<T>

Creates an image given a prompt: https://api.openai.com/v1/images/generations Creates an edited or extended image given an original image and a prompt: https://api.openai.com/v1/images/edits Creates a variation of a given image: https://api.openai.com/v1/images/variations

ImageRequest<T>.Builder

ImageVariationRequest

IncompleteDetails

Details on why the run is incomplete. Will be null if the run is not incomplete.

MessageFile

A list of files attached to a message.

MessageInfo

ModerationDetail

ModerationRequest

ModerationRequest.Builder

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

OpenAI

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

OpenAIClientSettingsFactory

OpenAIModel

OpenAIModelData

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

OpenAISettings

OpenAITranscript

Represents a verbose json transcription response returned by model, based on the provided input.

OpenAIVoice

RequestCounts

The request counts for different statuses within the batch.

RequestExtensions

Extension methods for the all OpenAI requests that calls OpenAiClient's DefaultInstance to process the request.

ResponseExtensions

Run

Represents an execution run on a Thread.

Renamed from RunObject to Run (2024.06.14)

RunBase

Base class for Run and RunStep.

RunRequest

RunRequest.Builder

RunStep

RunStepDelta

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

RunStepDeltaValue

SegmentObject

SpeechRequest

Generates audio from the input text.

SpeechRequest.Builder

StepDetails

The details of the run step.

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

ThreadMessageRequest

ThreadMessageRequest.Builder

ThreadRequest

ThreadRequest.Builder

ToolCallConverter

ToolChoice

This can be a String or an Object Specifies a tool the model should use. Use to force the model to call a specific tool.

ToolChoiceConverter

ToolOutput

ToolOutputsRequest

ToolOutputsRequest.Builder

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

Enums