Unreal OpenAI API 1.0.0
OpenAIFuncLib.h
1// OpenAI Sample, Copyright LifeEXE. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
6#include "Kismet/BlueprintFunctionLibrary.h"
7#include "Provider/Types/AllTypesHeader.h"
8#include "OpenAIFuncLib.generated.h"
9
10UCLASS()
11class OPENAI_API UOpenAIFuncLib : public UBlueprintFunctionLibrary
12{
13 GENERATED_BODY()
14
15public:
16 UFUNCTION(BlueprintPure, Category = "OpenAI | Model")
17 static FString OpenAIAllModelToString(EAllModelEnum Model);
18
19 UFUNCTION(BlueprintPure, Category = "OpenAI | Model")
20 static FString OpenAIMainModelToString(EMainModelEnum Model);
21
22 UFUNCTION(BlueprintPure, Category = "OpenAI | Model")
23 static FString OpenAIModelToString(const FOpenAIModel& OpenAIModel);
24
25 UFUNCTION(BlueprintPure, Category = "OpenAI | Moderation")
26 static FString OpenAIModerationModelToString(EModerationsModelEnum Model);
27
28 UFUNCTION(BlueprintPure, Category = "OpenAI | Moderations")
29 static FString OpenAIModerationsToString(const FModerationResults& ModerationResults);
30
31 UFUNCTION(BlueprintPure, Category = "OpenAI | Model | Vision")
32 static bool ModelSupportsVision(const FString& Model);
33
34 UFUNCTION(BlueprintPure, Category = "OpenAI| Audio")
35 static FString OpenAIAudioModelToString(EAudioModel Model);
36
37 UFUNCTION(BlueprintPure, Category = "OpenAI| Audio")
38 static FString OpenAITTSModelToString(ETTSModel Model);
39
40 UFUNCTION(BlueprintPure, Category = "OpenAI| Audio")
41 static FString OpenAIVoiceToString(EVoice Voice);
42
43 UFUNCTION(BlueprintPure, Category = "OpenAI| Audio")
44 static FString OpenAITTSAudioFormatToString(ETTSAudioFormat Format);
45
46 UFUNCTION(BlueprintPure, Category = "OpenAI | Audio")
47 static FString OpenAIAudioTranscriptToString(ETranscriptFormat TranscriptFormat);
48
49 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
50 static FString OpenAIImageModelToString(EImageModelEnum Model);
51
52 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
53 static EImageModelEnum StringToOpenAIImageModel(const FString& Model);
54
55 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
56 static FString OpenAIImageSizeDalle2ToString(EImageSizeDalle2 ImageSize);
57
58 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
59 static EImageSizeDalle2 StringToOpenAIImageSizeDalle2(const FString& ImageSize);
60
61 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
62 static FString OpenAIImageSizeDalle3ToString(EImageSizeDalle3 ImageSize);
63
64 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
65 static EImageSizeDalle3 StringToOpenAIImageSizeDalle3(const FString& ImageSize);
66
67 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
68 static FString OpenAIImageFormatToString(EOpenAIImageFormat ImageFormat);
69
70 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
71 static EOpenAIImageFormat StringToOpenAIImageFormat(const FString& ImageFormat);
72
73 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
74 static FString OpenAIImageQualityToString(EOpenAIImageQuality ImageQuality);
75
76 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
77 static EOpenAIImageQuality StringToOpenAIImageQuality(const FString& ImageQuality);
78
79 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
80 static FString OpenAIImageStyleToString(EOpenAIImageStyle ImageStyle);
81
82 UFUNCTION(BlueprintPure, Category = "OpenAI | Image")
83 static EOpenAIImageStyle StringToOpenAIImageStyle(const FString& ImageStyle);
84
85 UFUNCTION(BlueprintPure, Category = "OpenAI | Chat")
86 static FString OpenAIChatResponseFormatToString(EChatResponseFormat ChatResponseFormat);
87
88 UFUNCTION(BlueprintPure, Category = "OpenAI | Chat")
89 static FString OpenAIMessageContentTypeToString(EMessageContentType MessageContentType);
90
91 UFUNCTION(BlueprintPure, Category = "OpenAI | Chat")
92 static FString OpenAIServiceTierToString(EServiceTier ServiceTier);
93
94 UFUNCTION(BlueprintPure, Category = "OpenAI | Embeddings")
95 static FString OpenAIEmbeddingsEncodingFormatToString(EEmbeddingsEncodingFormat EmbeddingsEncodingFormat);
96
97 UFUNCTION(BlueprintPure, Category = "OpenAI | File")
98 static FString OpenAIUploadFilePurposeToString(EUploadFilePurpose UploadFilePurpose);
99
100 UFUNCTION(BlueprintPure, Category = "OpenAI | Batch")
101 static FString OpenAIBatchEndpointToString(EBatchEndpoint BatchEndpoint);
102
103 UFUNCTION(BlueprintPure, Category = "OpenAI | Batch")
104 static FString OpenAIBatchCompletionWindowToString(EBatchCompletionWindow BatchCompletionWindow);
105
106 UFUNCTION(BlueprintPure, Category = "OpenAI | Upload")
107 static FString OpenAIUploadStatusToString(EUploadStatus UploadStatus);
108
109 UFUNCTION(BlueprintPure, Category = "OpenAI | Upload")
110 static FString OpenAIAssistantToolTypeToString(EAssistantToolType AssistantToolType);
111
112 // common
113 UFUNCTION(BlueprintPure, Category = "OpenAI | Common")
114 static FString OpenAIRoleToString(ERole Role);
115
116 UFUNCTION(BlueprintPure, Category = "OpenAI | Common")
117 static FString OpenAIFinishReasonToString(EOpenAIFinishReason FinishReason);
118
119 UFUNCTION(BlueprintPure, Category = "OpenAI | Common")
120 static EOpenAIFinishReason StringToOpenAIFinishReason(const FString& FinishReason);
121
122 UFUNCTION(BlueprintPure, Category = "OpenAI | Common")
123 static ERole StringToOpenAIRole(const FString& Role);
124
125 UFUNCTION(BlueprintPure, Category = "OpenAI | Common")
126 static FString OpenAIHeaderTypeToString(EOpenAIHttpHeaderType Type);
127
128 UFUNCTION(BlueprintPure, Category = "OpenAI | Common")
129 static FString FindOpenAIHttpHeaderByType(const FOpenAIResponseMetadata& Headers, EOpenAIHttpHeaderType Type);
130
131 // errors
132 UFUNCTION(BlueprintPure, Category = "OpenAI | Error")
133 static EOpenAIResponseError GetErrorCode(const FString& RawError);
134
135 UFUNCTION(BlueprintPure, Category = "OpenAI | Error")
136 static FString GetErrorMessage(const FString& RawError);
137
138 UFUNCTION(BlueprintPure, Category = "OpenAI | Error")
139 static FString ResponseErrorToString(EOpenAIResponseError Code);
140
141 // base64
142 UFUNCTION(BlueprintPure, Category = "OpenAI | Base64")
143 static FString WrapBase64(const FString& Base64String);
144
145 UFUNCTION(BlueprintPure, Category = "OpenAI | Base64")
146 static FString UnWrapBase64(const FString& Base64String);
147
148 UFUNCTION(BlueprintPure, Category = "OpenAI | Base64")
149 static FString FilePathToBase64(const FString& FilePath);
150
151 // API
158 UFUNCTION(BlueprintPure, Category = "OpenAI | API")
159 static FOpenAIAuth LoadAPITokensFromFile(const FString& FilePath);
160
161 UFUNCTION(BlueprintPure, Category = "OpenAI | API")
162 static FOpenAIAuth LoadAPITokensFromFileOnce(const FString& FilePath);
163
164 // misc helpers
165 static FString BoolToString(bool Value);
166 static FString RemoveWhiteSpaces(const FString& Input);
167 static OpenAI::ServiceSecrets LoadServiceSecretsFromFile(const FString& FilePath);
168 static bool LoadSecretByName(const OpenAI::ServiceSecrets& Secrets, const FString& SecretName, FString& SecretValue);
169 static FString MakeURLWithQuery(const FString& URL, const OpenAI::QueryPairs& Args);
170};
UOpenAIFuncLib
Definition: OpenAIFuncLib.h:12
FModerationResults
Definition: ModerationTypes.h:126
FOpenAIAuth
Definition: CommonTypes.h:11
FOpenAIModel
Definition: ModelTypes.h:99
FOpenAIResponseMetadata
Definition: CommonTypes.h:49