Namespace OpenAI
Classes
- CodeInterpreterResources
CodeInterpreter resources.
- FileSearchResources
FileSearch resources.
- ImageFile
References an image file in the content of a message.
- ImageUrl
References an image URL in the content of a message.
- JsonSchema
https://platform.openai.com/docs/guides/structured-outputs
https://json-schema.org/overview/what-is-jsonschema
- LogProbInfo
Contains log probability information.
- OpenAIAuthentication
Represents authentication to the OpenAI API endpoint
- OpenAIClient
Entry point to the OpenAI API, handling auth and allowing access to the various API endpoints
- OpenAISettings
The client settings for configuring Azure OpenAI or custom domain.
- RankingOptions
The ranking options for the file search. https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings
- 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.
- 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.
Interfaces
- IServerSentEvent
Common interface for streaming server sent events
Enums
- ReasoningEffort
Constrains the effort of reasoning for Reasoning Models.
Currently supported values are: Minimal, 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, ordetailed.