Unreal OpenAI API 1.0.0
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
UOpenAIProvider Class Reference
Inheritance diagram for UOpenAIProvider:
UOpenAIProviderFake

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 CreateVoice (const FCreateVoice &CreateVoice, const FOpenAIAuth &Auth)
void CreateAudioTranslation (const FAudioTranslation &AudioTranslation, const FOpenAIAuth &Auth)
void ListFiles (const FListFilesParams &ListFilesParams, 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 PauseFineTuningJob (const FString &FineTuneID, const FOpenAIAuth &Auth)
void ResumeFineTuningJob (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 CreateVideo (const FCreateVideo &CreateVideo, const FOpenAIAuth &Auth)
void RetrieveVideo (const FString &VideoId, const FOpenAIAuth &Auth)
void ListVideos (const FListVideos &ListVideos, const FOpenAIAuth &Auth)
void DeleteVideo (const FString &VideoId, const FOpenAIAuth &Auth)
void RemixVideo (const FString &VideoId, const FRemixVideo &RemixVideo, const FOpenAIAuth &Auth)
void DownloadVideoContent (const FString &VideoId, const FDownloadVideoContent &DownloadVideoContent, const FOpenAIAuth &Auth)
void CreateEval (const FCreateEval &CreateEval, const FOpenAIAuth &Auth)
void ListEvals (const FEvalQueryParams &QueryParams, const FOpenAIAuth &Auth)
void RetrieveEval (const FString &EvalId, const FOpenAIAuth &Auth)
void UpdateEval (const FString &EvalId, const FUpdateEval &UpdateEval, const FOpenAIAuth &Auth)
void DeleteEval (const FString &EvalId, const FOpenAIAuth &Auth)
void CreateVectorStore (const FCreateVectorStore &CreateVectorStore, const FOpenAIAuth &Auth)
void ListVectorStores (const FVectorStoreQueryParams &QueryParams, const FOpenAIAuth &Auth)
void RetrieveVectorStore (const FString &VectorStoreId, const FOpenAIAuth &Auth)
void UpdateVectorStore (const FString &VectorStoreId, const FUpdateVectorStore &UpdateVectorStore, const FOpenAIAuth &Auth)
void DeleteVectorStore (const FString &VectorStoreId, const FOpenAIAuth &Auth)
void CreateVectorStoreFile (const FString &VectorStoreId, const FString &FileId, const FOpenAIAuth &Auth)
void ListVectorStoreFiles (const FString &VectorStoreId, const FVectorStoreFileQueryParams &QueryParams, const FOpenAIAuth &Auth)
void RetrieveVectorStoreFile (const FString &VectorStoreId, const FString &FileId, const FOpenAIAuth &Auth)
void DeleteVectorStoreFile (const FString &VectorStoreId, const FString &FileId, const FOpenAIAuth &Auth)
void CreateVectorStoreFileBatch (const FString &VectorStoreId, const FCreateVectorStoreFileBatch &CreateBatch, const FOpenAIAuth &Auth)
void RetrieveVectorStoreFileBatch (const FString &VectorStoreId, const FString &BatchId, const FOpenAIAuth &Auth)
void CancelVectorStoreFileBatch (const FString &VectorStoreId, const FString &BatchId, const FOpenAIAuth &Auth)
void SearchVectorStore (const FString &VectorStoreId, const FVectorStoreSearch &Search, const FOpenAIAuth &Auth)
void CreateChatKitSession (const FCreateChatKitSession &CreateSession, const FOpenAIAuth &Auth)
void CancelChatKitSession (const FString &SessionId, const FOpenAIAuth &Auth)
void ListChatKitThreads (const FListChatKitThreads &ListThreads, const FOpenAIAuth &Auth)
void RetrieveChatKitThread (const FString &ThreadId, const FOpenAIAuth &Auth)
void DeleteChatKitThread (const FString &ThreadId, const FOpenAIAuth &Auth)
void ListChatKitThreadItems (const FString &ThreadId, const FListChatKitThreadItems &ListItems, const FOpenAIAuth &Auth)
void CreateSkill (const FCreateSkill &CreateSkill, const FOpenAIAuth &Auth)
void ListSkills (const FListSkillsParams &ListParams, const FOpenAIAuth &Auth)
void RetrieveSkill (const FString &SkillId, const FOpenAIAuth &Auth)
void UpdateSkill (const FString &SkillId, const FUpdateSkill &UpdateSkill, const FOpenAIAuth &Auth)
void DeleteSkill (const FString &SkillId, const FOpenAIAuth &Auth)
void RetrieveSkillContent (const FString &SkillId, const FOpenAIAuth &Auth)
void CreateSkillVersion (const FString &SkillId, const FCreateSkillVersion &CreateVersion, const FOpenAIAuth &Auth)
void ListSkillVersions (const FString &SkillId, const FListSkillVersionsParams &ListParams, const FOpenAIAuth &Auth)
void RetrieveSkillVersion (const FString &SkillId, const FString &Version, const FOpenAIAuth &Auth)
void DeleteSkillVersion (const FString &SkillId, const FString &Version, const FOpenAIAuth &Auth)
void RetrieveSkillVersionContent (const FString &SkillId, const FString &Version, const FOpenAIAuth &Auth)
void CreateRealtimeClientSecret (const FCreateRealtimeClientSecret &CreateSecret, const FOpenAIAuth &Auth)
void RealtimeAcceptCall (const FString &CallId, const FRealtimeAcceptCall &AcceptCall, const FOpenAIAuth &Auth)
void RealtimeHangupCall (const FString &CallId, const FOpenAIAuth &Auth)
void RealtimeReferCall (const FString &CallId, const FRealtimeReferCall &ReferCall, const FOpenAIAuth &Auth)
void RealtimeRejectCall (const FString &CallId, const FRealtimeRejectCall &RejectCall, 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
FHttpRequestRef MakeRequest (const FFineTuningJob &FineTuningJob, const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
FHttpRequestRef MakeRequest (const FCreateEval &CreateEval, const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
FHttpRequestRef MakeRequest (const FUpdateEval &UpdateEval, const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
FHttpRequestRef MakeRequest (const FCreateVectorStore &CreateVectorStore, const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
FHttpRequestRef MakeRequest (const FUpdateVectorStore &UpdateVectorStore, const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
FHttpRequestRef MakeRequest (const FCreateVectorStoreFileBatch &CreateBatch, const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
FHttpRequestRef MakeRequest (const FVectorStoreSearch &Search, const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
FHttpRequestRef MakeRequest (const FCreateSkill &CreateSkill, const FString &URL, const FString &Method, const FOpenAIAuth &Auth) const
FHttpRequestRef MakeRequest (const FCreateSkillVersion &CreateVersion, 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

◆ CancelChatKitSession()

void UOpenAIProvider::CancelChatKitSession ( const FString & SessionId,
const FOpenAIAuth & Auth )

Cancel an active ChatKit session.

◆ 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

◆ CancelVectorStoreFileBatch()

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

Cancel a vector store file batch. This can only be done for batches that are in_progress. https://platform.openai.com/docs/api-reference/vector-stores-file-batches/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

◆ CreateChatKitSession()

void UOpenAIProvider::CreateChatKitSession ( const FCreateChatKitSession & CreateSession,
const FOpenAIAuth & Auth )

Create a ChatKit session.

◆ 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

◆ CreateEval()

void UOpenAIProvider::CreateEval ( const FCreateEval & CreateEval,
const FOpenAIAuth & Auth )

Create the structure of an evaluation that can be used to test a model's performance. https://platform.openai.com/docs/api-reference/evals/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

◆ CreateRealtimeClientSecret()

void UOpenAIProvider::CreateRealtimeClientSecret ( const FCreateRealtimeClientSecret & CreateSecret,
const FOpenAIAuth & Auth )

Create a Realtime client secret.

◆ CreateSkill()

void UOpenAIProvider::CreateSkill ( const FCreateSkill & CreateSkill,
const FOpenAIAuth & Auth )

Create a new skill.

◆ CreateSkillVersion()

void UOpenAIProvider::CreateSkillVersion ( const FString & SkillId,
const FCreateSkillVersion & CreateVersion,
const FOpenAIAuth & Auth )

Create a new immutable skill version.

◆ 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

◆ CreateVectorStore()

void UOpenAIProvider::CreateVectorStore ( const FCreateVectorStore & CreateVectorStore,
const FOpenAIAuth & Auth )

Create a vector store. https://platform.openai.com/docs/api-reference/vector-stores/create

◆ CreateVectorStoreFile()

void UOpenAIProvider::CreateVectorStoreFile ( const FString & VectorStoreId,
const FString & FileId,
const FOpenAIAuth & Auth )

Create a vector store file by attaching a File to a vector store. https://platform.openai.com/docs/api-reference/vector-stores-files/create

◆ CreateVectorStoreFileBatch()

void UOpenAIProvider::CreateVectorStoreFileBatch ( const FString & VectorStoreId,
const FCreateVectorStoreFileBatch & CreateBatch,
const FOpenAIAuth & Auth )

Create a vector store file batch. https://platform.openai.com/docs/api-reference/vector-stores-file-batches/create

◆ CreateVideo()

void UOpenAIProvider::CreateVideo ( const FCreateVideo & CreateVideo,
const FOpenAIAuth & Auth )

Creates a video generation job. https://platform.openai.com/docs/api-reference/videos/create

◆ CreateVoice()

void UOpenAIProvider::CreateVoice ( const FCreateVoice & CreateVoice,
const FOpenAIAuth & Auth )

Creates a custom voice. https://platform.openai.com/docs/api-reference/audio/createVoice

◆ DeleteAssistant()

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

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

◆ DeleteChatKitThread()

void UOpenAIProvider::DeleteChatKitThread ( const FString & ThreadId,
const FOpenAIAuth & Auth )

Delete a ChatKit thread.

◆ DeleteEval()

void UOpenAIProvider::DeleteEval ( const FString & EvalId,
const FOpenAIAuth & Auth )

Delete an evaluation. https://platform.openai.com/docs/api-reference/evals/delete

◆ 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

◆ DeleteSkill()

void UOpenAIProvider::DeleteSkill ( const FString & SkillId,
const FOpenAIAuth & Auth )

Delete a skill by its ID.

◆ DeleteSkillVersion()

void UOpenAIProvider::DeleteSkillVersion ( const FString & SkillId,
const FString & Version,
const FOpenAIAuth & Auth )

Delete a skill version.

◆ DeleteVectorStore()

void UOpenAIProvider::DeleteVectorStore ( const FString & VectorStoreId,
const FOpenAIAuth & Auth )

Delete a vector store. https://platform.openai.com/docs/api-reference/vector-stores/delete

◆ DeleteVectorStoreFile()

void UOpenAIProvider::DeleteVectorStoreFile ( const FString & VectorStoreId,
const FString & FileId,
const FOpenAIAuth & Auth )

Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint. https://platform.openai.com/docs/api-reference/vector-stores-files/delete

◆ DeleteVideo()

void UOpenAIProvider::DeleteVideo ( const FString & VideoId,
const FOpenAIAuth & Auth )

Delete a video generation job. https://platform.openai.com/docs/api-reference/videos/delete

◆ DownloadVideoContent()

void UOpenAIProvider::DownloadVideoContent ( const FString & VideoId,
const FDownloadVideoContent & DownloadVideoContent,
const FOpenAIAuth & Auth )

Download video content (video, thumbnail, or spritesheet). https://platform.openai.com/docs/api-reference/videos/download-content

◆ 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

◆ ListChatKitThreadItems()

void UOpenAIProvider::ListChatKitThreadItems ( const FString & ThreadId,
const FListChatKitThreadItems & ListItems,
const FOpenAIAuth & Auth )

List items that belong to a ChatKit thread.

◆ ListChatKitThreads()

void UOpenAIProvider::ListChatKitThreads ( const FListChatKitThreads & ListThreads,
const FOpenAIAuth & Auth )

List ChatKit threads.

◆ ListEvals()

void UOpenAIProvider::ListEvals ( const FEvalQueryParams & QueryParams,
const FOpenAIAuth & Auth )

List evaluations for a project. https://platform.openai.com/docs/api-reference/evals/list

◆ ListFiles()

void UOpenAIProvider::ListFiles ( const FListFilesParams & ListFilesParams,
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

◆ ListSkills()

void UOpenAIProvider::ListSkills ( const FListSkillsParams & ListParams,
const FOpenAIAuth & Auth )

List all skills for the current project.

◆ ListSkillVersions()

void UOpenAIProvider::ListSkillVersions ( const FString & SkillId,
const FListSkillVersionsParams & ListParams,
const FOpenAIAuth & Auth )

List skill versions for a skill.

◆ ListVectorStoreFiles()

void UOpenAIProvider::ListVectorStoreFiles ( const FString & VectorStoreId,
const FVectorStoreFileQueryParams & QueryParams,
const FOpenAIAuth & Auth )

Returns a list of vector store files. https://platform.openai.com/docs/api-reference/vector-stores-files/list

◆ ListVectorStores()

void UOpenAIProvider::ListVectorStores ( const FVectorStoreQueryParams & QueryParams,
const FOpenAIAuth & Auth )

Returns a list of vector stores. https://platform.openai.com/docs/api-reference/vector-stores/list

◆ ListVideos()

void UOpenAIProvider::ListVideos ( const FListVideos & ListVideos,
const FOpenAIAuth & Auth )

List recently generated videos. https://platform.openai.com/docs/api-reference/videos/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

◆ RealtimeAcceptCall()

void UOpenAIProvider::RealtimeAcceptCall ( const FString & CallId,
const FRealtimeAcceptCall & AcceptCall,
const FOpenAIAuth & Auth )

Accept an incoming SIP call.

◆ RealtimeHangupCall()

void UOpenAIProvider::RealtimeHangupCall ( const FString & CallId,
const FOpenAIAuth & Auth )

End an active Realtime API call.

◆ RealtimeReferCall()

void UOpenAIProvider::RealtimeReferCall ( const FString & CallId,
const FRealtimeReferCall & ReferCall,
const FOpenAIAuth & Auth )

Transfer an active SIP call.

◆ RealtimeRejectCall()

void UOpenAIProvider::RealtimeRejectCall ( const FString & CallId,
const FRealtimeRejectCall & RejectCall,
const FOpenAIAuth & Auth )

Decline an incoming SIP call.

◆ RemixVideo()

void UOpenAIProvider::RemixVideo ( const FString & VideoId,
const FRemixVideo & RemixVideo,
const FOpenAIAuth & Auth )

Create a remix of a completed video using a refreshed prompt. https://platform.openai.com/docs/api-reference/videos/remix

◆ 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

◆ RetrieveChatKitThread()

void UOpenAIProvider::RetrieveChatKitThread ( const FString & ThreadId,
const FOpenAIAuth & Auth )

Retrieve a ChatKit thread.

◆ RetrieveEval()

void UOpenAIProvider::RetrieveEval ( const FString & EvalId,
const FOpenAIAuth & Auth )

Retrieves an evaluation. https://platform.openai.com/docs/api-reference/evals/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

◆ RetrieveSkill()

void UOpenAIProvider::RetrieveSkill ( const FString & SkillId,
const FOpenAIAuth & Auth )

Get a skill by its ID.

◆ RetrieveSkillContent()

void UOpenAIProvider::RetrieveSkillContent ( const FString & SkillId,
const FOpenAIAuth & Auth )

Download a skill zip bundle by its ID.

◆ RetrieveSkillVersion()

void UOpenAIProvider::RetrieveSkillVersion ( const FString & SkillId,
const FString & Version,
const FOpenAIAuth & Auth )

Get a specific skill version.

◆ RetrieveSkillVersionContent()

void UOpenAIProvider::RetrieveSkillVersionContent ( const FString & SkillId,
const FString & Version,
const FOpenAIAuth & Auth )

Download a skill version zip bundle.

◆ RetrieveVectorStore()

void UOpenAIProvider::RetrieveVectorStore ( const FString & VectorStoreId,
const FOpenAIAuth & Auth )

Retrieves a vector store. https://platform.openai.com/docs/api-reference/vector-stores/retrieve

◆ RetrieveVectorStoreFile()

void UOpenAIProvider::RetrieveVectorStoreFile ( const FString & VectorStoreId,
const FString & FileId,
const FOpenAIAuth & Auth )

Retrieves a vector store file. https://platform.openai.com/docs/api-reference/vector-stores-files/retrieve

◆ RetrieveVectorStoreFileBatch()

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

Retrieves a vector store file batch. https://platform.openai.com/docs/api-reference/vector-stores-file-batches/retrieve

◆ RetrieveVideo()

void UOpenAIProvider::RetrieveVideo ( const FString & VideoId,
const FOpenAIAuth & Auth )

Retrieves a video generation job. https://platform.openai.com/docs/api-reference/videos/retrieve

◆ SearchVectorStore()

void UOpenAIProvider::SearchVectorStore ( const FString & VectorStoreId,
const FVectorStoreSearch & Search,
const FOpenAIAuth & Auth )

Search a vector store for relevant chunks based on a query and file attributes filter. https://platform.openai.com/docs/api-reference/vector-stores/search

◆ SetLogEnabled()

void UOpenAIProvider::SetLogEnabled ( bool LogEnabled)
inline

Print response to console

◆ UpdateEval()

void UOpenAIProvider::UpdateEval ( const FString & EvalId,
const FUpdateEval & UpdateEval,
const FOpenAIAuth & Auth )

Update an evaluation. https://platform.openai.com/docs/api-reference/evals/update

◆ UpdateSkill()

void UOpenAIProvider::UpdateSkill ( const FString & SkillId,
const FUpdateSkill & UpdateSkill,
const FOpenAIAuth & Auth )

Update the default version pointer for a skill.

◆ UpdateVectorStore()

void UOpenAIProvider::UpdateVectorStore ( const FString & VectorStoreId,
const FUpdateVectorStore & UpdateVectorStore,
const FOpenAIAuth & Auth )

Modifies a vector store. https://platform.openai.com/docs/api-reference/vector-stores/update

◆ 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: