UOpenAIProvider Class Reference

Inheritance diagram for UOpenAIProvider:

Public Member Functions
void	SetAPI (const TSharedPtr< OpenAI::IAPI > &API)
void	ListModels (const FOpenAIAuth &Auth)
void	RetrieveModel (const FString &ModelName, const FOpenAIAuth &Auth)
void	DeleteFineTunedModel (const FString &ModelID, const FOpenAIAuth &Auth)
void	CreateCompletion (const FCompletion &Completion, const FOpenAIAuth &Auth)
void	CreateChatCompletion (const FChatCompletion &Completion, const FOpenAIAuth &Auth)
void	CreateImage (const FOpenAIImage &Image, const FOpenAIAuth &Auth)
void	CreateImageEdit (const FOpenAIImageEdit &ImageEdit, const FOpenAIAuth &Auth)
void	CreateImageVariation (const FOpenAIImageVariation &ImageVariation, const FOpenAIAuth &Auth)
void	CreateEmbeddings (const FEmbeddings &Embeddings, const FOpenAIAuth &Auth)
void	CreateSpeech (const FSpeech &Speech, const FOpenAIAuth &Auth)
void	CreateAudioTranscription (const FAudioTranscription &AudioTranscription, const FOpenAIAuth &Auth)
void	CreateAudioTranslation (const FAudioTranslation &AudioTranslation, const FOpenAIAuth &Auth)
void	ListFiles (const FOpenAIAuth &Auth)
void	UploadFile (const FUploadFile &UploadFile, const FOpenAIAuth &Auth)
void	DeleteFile (const FString &FileID, const FOpenAIAuth &Auth)
void	RetrieveFile (const FString &FileID, const FOpenAIAuth &Auth)
void	RetrieveFileContent (const FString &FileID, const FOpenAIAuth &Auth)
void	CreateModerations (const FModerations &Moderations, const FOpenAIAuth &Auth)
void	CreateFineTuningJob (const FFineTuningJob &FineTuningJob, const FOpenAIAuth &Auth)
void	ListFineTuningJobs (const FOpenAIAuth &Auth, const FFineTuningQueryParameters &FineTuningQueryParameters={})
void	ListFineTuningEvents (const FString &FineTuningJobID, const FOpenAIAuth &Auth, const FFineTuningQueryParameters &FineTuningQueryParameters={})
void	ListFineTuningCheckpoints (const FString &FineTuningJobID, const FOpenAIAuth &Auth, const FFineTuningQueryParameters &FineTuningQueryParameters={})
void	RetrieveFineTuningJob (const FString &FineTuningJobID, const FOpenAIAuth &Auth)
void	CancelFineTuningJob (const FString &FineTuneID, const FOpenAIAuth &Auth)
void	CreateBatch (const FCreateBatch &CreateBatch, const FOpenAIAuth &Auth)
void	RetrieveBatch (const FString &BatchId, const FOpenAIAuth &Auth)
void	CancelBatch (const FString &BatchId, const FOpenAIAuth &Auth)
void	ListBatch (const FListBatch &ListBatch, const FOpenAIAuth &Auth)
void	CreateUpload (const FCreateUpload &CreateUpload, const FOpenAIAuth &Auth)
void	AddUploadPart (const FString &UploadId, const FAddUploadPart &AddUploadPart, const FOpenAIAuth &Auth)
void	CompleteUpload (const FString &UploadId, const FCompleteUpload &CompleteUpload, const FOpenAIAuth &Auth)
void	CancelUpload (const FString &UploadId, const FOpenAIAuth &Auth)
void	CreateAssistant (const FCreateAssistant &CreateAssistant, const FOpenAIAuth &Auth)
void	ListAssistants (const FListAssistants &ListAssistants, const FOpenAIAuth &Auth)
void	RetrieveAssistant (const FString &AssistantId, const FOpenAIAuth &Auth)
void	ModifyAssistant (const FString &AssistantId, const FModifyAssistant &ModifyAssistant, const FOpenAIAuth &Auth)
void	DeleteAssistant (const FString &AssistantId, const FOpenAIAuth &Auth)
void	SetLogEnabled (bool LogEnabled)
FOnRequestError &	OnRequestError ()

Private Member Functions
void	ProcessRequest (FHttpRequestRef HttpRequest)
bool	Success (FHttpResponsePtr Response, bool WasSuccessful)
void	Log (const FString &Info) const
void	LogResponse (FHttpResponsePtr Response) const
void	LogError (const FString &ErrorText) const
template<typename OutStructType >
FString	SerializeRequest (const OutStructType &OutStruct) const
FHttpRequestRef	MakeRequestHeaders (const FOpenAIAuth &Auth) const
FOpenAIResponseMetadata	GetResponseHeaders (FHttpResponsePtr Response) const
template<typename OutStructType >
FHttpRequestRef	MakeRequest (const OutStructType &OutStruct, const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
FHttpRequestRef	MakeRequest (const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
FHttpRequestRef	MakeRequest (const FChatCompletion &ChatCompletion, const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
template<typename ParsedResponseType , typename DelegateType >
void	HandleResponse (FHttpResponsePtr Response, bool WasSuccessful, DelegateType &Delegate)
virtual TSharedRef< IHttpRequest, ESPMode::ThreadSafe >	CreateRequest () const
void	SetOptional (TSharedPtr< FJsonObject > RequestBody, const TOptional< FString > &Param, const FString &ParamName)
void	SetOptional (TSharedPtr< FJsonObject > RequestBody, const TOptional< bool > &Param, const FString &ParamName)
void	SetOptional (TSharedPtr< FJsonObject > RequestBody, const TOptional< TArray< float > > &Param, const FString &ParamName)
template<typename NumberType >
void	SetOptional (TSharedPtr< FJsonObject > RequestBody, const TOptional< NumberType > &Param, const FString &ParamName)
TTuple< FString, FString >	GetErrorData (FHttpRequestPtr Request, FHttpResponsePtr Response) const
template<typename ResponseType >
bool	ParseStreamRequest (FHttpResponsePtr Response, TArray< ResponseType > &Responses)
template<typename ResponseType , typename DelegateType >
void	OnStreamProgress (FHttpRequestPtr Request, uint64 BytesSent, uint64 BytesReceived, DelegateType &Delegate)
template<typename ResponseType , typename DelegateType >
void	OnStreamCompleted (FHttpRequestPtr Request, FHttpResponsePtr Response, bool WasSuccessful, DelegateType &Delegate)

Private Attributes
TSharedPtr< OpenAI::IAPI >	API
bool	bLogEnabled {true}
FOnRequestError	RequestError

Member Function Documentation

AddUploadPart()

void UOpenAIProvider::AddUploadPart	(	const FString &	UploadId,
		const FAddUploadPart &	AddUploadPart,
		const FOpenAIAuth &	Auth
	)

Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload. https://platform.openai.com/docs/api-reference/uploads/add-part

CancelBatch()

void UOpenAIProvider::CancelBatch	(	const FString &	BatchId,
		const FOpenAIAuth &	Auth
	)

Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled, where it will have partial results (if any) available in the output file. https://platform.openai.com/docs/api-reference/batch/cancel

CancelFineTuningJob()

void UOpenAIProvider::CancelFineTuningJob	(	const FString &	FineTuneID,
		const FOpenAIAuth &	Auth
	)

Immediately cancel a fine-tune job. https://platform.openai.com/docs/api-reference/fine-tuning/cancel

CancelUpload()

void UOpenAIProvider::CancelUpload	(	const FString &	UploadId,
		const FOpenAIAuth &	Auth
	)

Cancels the Upload. No Parts may be added after an Upload is cancelled. https://platform.openai.com/docs/api-reference/uploads/cancel

CompleteUpload()

void UOpenAIProvider::CompleteUpload	(	const FString &	UploadId,
		const FCompleteUpload &	CompleteUpload,
		const FOpenAIAuth &	Auth
	)

Completes the Upload. Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform. https://platform.openai.com/docs/api-reference/uploads/complete

CreateAssistant()

void UOpenAIProvider::CreateAssistant	(	const FCreateAssistant &	CreateAssistant,
		const FOpenAIAuth &	Auth
	)

Create an assistant with a model and instructions. https://platform.openai.com/docs/api-reference/assistants/createAssistant

CreateAudioTranscription()

void UOpenAIProvider::CreateAudioTranscription	(	const FAudioTranscription &	AudioTranscription,
		const FOpenAIAuth &	Auth
	)

Transcribes audio into the input language. https://platform.openai.com/docs/api-reference/audio/create

CreateAudioTranslation()

void UOpenAIProvider::CreateAudioTranslation	(	const FAudioTranslation &	AudioTranslation,
		const FOpenAIAuth &	Auth
	)

Translates audio into into English. https://platform.openai.com/docs/api-reference/audio/create

CreateBatch()

void UOpenAIProvider::CreateBatch	(	const FCreateBatch &	CreateBatch,
		const FOpenAIAuth &	Auth
	)

Create large batches of API requests for asynchronous processing. The Batch API returns completions within 24 hours for a 50% discount. https://platform.openai.com/docs/api-reference/batch/create

CreateChatCompletion()

void UOpenAIProvider::CreateChatCompletion	(	const FChatCompletion &	Completion,
		const FOpenAIAuth &	Auth
	)

Creates a completion for the chat message. https://platform.openai.com/docs/api-reference/chat/create

CreateCompletion()

void UOpenAIProvider::CreateCompletion	(	const FCompletion &	Completion,
		const FOpenAIAuth &	Auth
	)

Creates a completion for the provided prompt and parameters. https://platform.openai.com/docs/api-reference/completions/create

CreateEmbeddings()

void UOpenAIProvider::CreateEmbeddings	(	const FEmbeddings &	Embeddings,
		const FOpenAIAuth &	Auth
	)

Creates an embedding vector representing the input text. https://platform.openai.com/docs/api-reference/embeddings/create

CreateFineTuningJob()

void UOpenAIProvider::CreateFineTuningJob	(	const FFineTuningJob &	FineTuningJob,
		const FOpenAIAuth &	Auth
	)

Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. https://platform.openai.com/docs/api-reference/fine-tuning/create

CreateImage()

void UOpenAIProvider::CreateImage	(	const FOpenAIImage &	Image,
		const FOpenAIAuth &	Auth
	)

Creates an image given a prompt. https://platform.openai.com/docs/api-reference/images/create

CreateImageEdit()

void UOpenAIProvider::CreateImageEdit	(	const FOpenAIImageEdit &	ImageEdit,
		const FOpenAIAuth &	Auth
	)

Creates an edited or extended image given an original image and a prompt. https://platform.openai.com/docs/api-reference/images/create-edit

CreateImageVariation()

void UOpenAIProvider::CreateImageVariation	(	const FOpenAIImageVariation &	ImageVariation,
		const FOpenAIAuth &	Auth
	)

Creates a variation of a given image. https://platform.openai.com/docs/api-reference/images/create-variation

CreateModerations()

void UOpenAIProvider::CreateModerations	(	const FModerations &	Moderations,
		const FOpenAIAuth &	Auth
	)

Classifies if text violates OpenAI's Content Policy https://platform.openai.com/docs/api-reference/moderations/create

CreateSpeech()

void UOpenAIProvider::CreateSpeech	(	const FSpeech &	Speech,
		const FOpenAIAuth &	Auth
	)

Generates audio from the input text. https://platform.openai.com/docs/api-reference/audio/createSpeech

CreateUpload()

void UOpenAIProvider::CreateUpload	(	const FCreateUpload &	CreateUpload,
		const FOpenAIAuth &	Auth
	)

Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it. https://platform.openai.com/docs/api-reference/uploads/create

DeleteAssistant()

void UOpenAIProvider::DeleteAssistant	(	const FString &	AssistantId,
		const FOpenAIAuth &	Auth
	)

Delete an assistant. https://platform.openai.com/docs/api-reference/assistants/deleteAssistant

DeleteFile()

void UOpenAIProvider::DeleteFile	(	const FString &	FileID,
		const FOpenAIAuth &	Auth
	)

Delete a file. https://platform.openai.com/docs/api-reference/files/delete

DeleteFineTunedModel()

void UOpenAIProvider::DeleteFineTunedModel	(	const FString &	ModelID,
		const FOpenAIAuth &	Auth
	)

Delete a fine-tuned model. You must have the Owner role in your organization. https://platform.openai.com/docs/api-reference/models/delete

ListAssistants()

void UOpenAIProvider::ListAssistants	(	const FListAssistants &	ListAssistants,
		const FOpenAIAuth &	Auth
	)

Returns a list of assistants. https://platform.openai.com/docs/api-reference/assistants/listAssistants

ListBatch()

void UOpenAIProvider::ListBatch	(	const FListBatch &	ListBatch,
		const FOpenAIAuth &	Auth
	)

List your organization's batches. https://platform.openai.com/docs/api-reference/batch/list

ListFiles()

void UOpenAIProvider::ListFiles

(

const FOpenAIAuth &

Auth

)

Returns a list of files that belong to the user's organization. https://platform.openai.com/docs/api-reference/files/list

ListFineTuningCheckpoints()

void UOpenAIProvider::ListFineTuningCheckpoints	(	const FString &	FineTuningJobID,
		const FOpenAIAuth &	Auth,
		const FFineTuningQueryParameters &	FineTuningQueryParameters = {}
	)

Get status updates for a fine-tuning job. https://platform.openai.com/docs/api-reference/fine-tuning/list-events

ListFineTuningEvents()

void UOpenAIProvider::ListFineTuningEvents	(	const FString &	FineTuningJobID,
		const FOpenAIAuth &	Auth,
		const FFineTuningQueryParameters &	FineTuningQueryParameters = {}
	)

Get status updates for a fine-tuning job. https://platform.openai.com/docs/api-reference/fine-tuning/list-events

ListFineTuningJobs()

void UOpenAIProvider::ListFineTuningJobs	(	const FOpenAIAuth &	Auth,
		const FFineTuningQueryParameters &	FineTuningQueryParameters = {}
	)

List your organization's fine-tuning jobs. https://platform.openai.com/docs/api-reference/fine-tuning/list

ListModels()

void UOpenAIProvider::ListModels

(

const FOpenAIAuth &

Auth

)

Lists the currently available models, and provides basic information about each one such as the owner and availability. https://platform.openai.com/docs/api-reference/models/list

ModifyAssistant()

void UOpenAIProvider::ModifyAssistant	(	const FString &	AssistantId,
		const FModifyAssistant &	ModifyAssistant,
		const FOpenAIAuth &	Auth
	)

Modifies an assistant. https://platform.openai.com/docs/api-reference/assistants/modifyAssistant

RetrieveAssistant()

void UOpenAIProvider::RetrieveAssistant	(	const FString &	AssistantId,
		const FOpenAIAuth &	Auth
	)

Retrieves an assistant. https://platform.openai.com/docs/api-reference/assistants/getAssistant

RetrieveBatch()

void UOpenAIProvider::RetrieveBatch	(	const FString &	BatchId,
		const FOpenAIAuth &	Auth
	)

Retrieves a batch. https://platform.openai.com/docs/api-reference/batch/retrieve

RetrieveFile()

void UOpenAIProvider::RetrieveFile	(	const FString &	FileID,
		const FOpenAIAuth &	Auth
	)

Returns information about a specific file. https://platform.openai.com/docs/api-reference/files/retrieve

RetrieveFileContent()

void UOpenAIProvider::RetrieveFileContent	(	const FString &	FileID,
		const FOpenAIAuth &	Auth
	)

Returns the contents of the specified file. https://platform.openai.com/docs/api-reference/files/retrieve-content

RetrieveFineTuningJob()

void UOpenAIProvider::RetrieveFineTuningJob	(	const FString &	FineTuningJobID,
		const FOpenAIAuth &	Auth
	)

Get info about a fine-tuning job. https://platform.openai.com/docs/api-reference/fine-tuning/retrieve

RetrieveModel()

void UOpenAIProvider::RetrieveModel	(	const FString &	ModelName,
		const FOpenAIAuth &	Auth
	)

Retrieves a model instance, providing basic information about the model such as the owner and permissioning. https://platform.openai.com/docs/api-reference/models/retrieve

SetLogEnabled()

void UOpenAIProvider::SetLogEnabled ( bool  LogEnabled )

inline

Print response to console

UploadFile()

void UOpenAIProvider::UploadFile	(	const FUploadFile &	UploadFile,
		const FOpenAIAuth &	Auth
	)

Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit. https://platform.openai.com/docs/api-reference/files/upload

---

The documentation for this class was generated from the following files:

• Source/OpenAI/Public/Provider/OpenAIProvider.h
• Source/OpenAI/Private/Provider/OpenAIProvider.cpp