Table of Contents

Namespace OpenAI

Classes

Annotation
BaseResponse
CodeInterpreterResources

CodeInterpreter resources.

ComparisonFilter
CompletionTokensDetails
CompoundFilter
ContainerFileCitation
Content
Error
EventResponse
FileCitation
FilePath
FileSearchOptions
FileSearchResources

FileSearch resources.

Function

https://platform.openai.com/docs/guides/function-calling

FunctionAttribute
FunctionParameterAttribute
FunctionPropertyAttribute
ImageFile

References an image file in the content of a message.

ImageUrl

References an image URL in the content of a message.

InputAudio
JsonSchema

https://platform.openai.com/docs/guides/structured-outputs
https://json-schema.org/overview/what-is-jsonschema

ListQuery
ListResponse<TObject>
LogProbInfo

Contains log probability information.

OpenAIAuthentication

Represents authentication to the OpenAI API endpoint

OpenAIBaseEndpoint
OpenAIClient

Entry point to the OpenAI API, handling auth and allowing access to the various API endpoints

OpenAIClientSettings
OpenAISettings

The client settings for configuring Azure OpenAI or custom domain.

PromptTokensDetails
RankingOptions

The ranking options for the file search. https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings

Reasoning
ResponseFormatObject
ServerSentEvent
StreamOptions
TextContent
TextResponseFormatConfiguration
TextResponseFormatObject
TokenUsage
TokenUsageDetails
Tool
ToolCall
ToolResources

A set of resources to be used by Assistants and Threads. The resources are specific to the type of tool. For example, the CodeInterpreter requres a list of file ids, While the FileSearch requires a list vector store ids.

UrlCitation
Usage
VectorStoreRequest

A helper to create a vector store with file_ids and attach it to an assistant/thread. There can be a maximum of 1 vector store attached to the assistant/thread.

Voice

Interfaces

IAnnotation
IFilter
IListItem
IListResponse<TObject>
IServerSentEvent

Common interface for streaming server sent events

ITool
IToolCall

Enums

AnnotationType
ChatResponseFormat
ComparisonFilterType
CompoundFilterOperator
ContentType
ImageDetail
InputAudioFormat
Modality
ReasoningEffort

Constrains the effort of reasoning for Reasoning Models.
Currently supported values are: Low, Medium, High. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning response.

ReasoningSummary

A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.

Role
SortOrder
TextResponseFormat