ChatCommonTypes.h

// OpenAI, Copyright LifeEXE. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Provider/Types/OpenAICommonTypes.h"
#include "Provider/Types/ToolsTypes.h"
#include "Provider/OpenAIOptional.h"
#include "ChatCommonTypes.generated.h"
 
UENUM(BlueprintType)
enum class EMessageContentType : uint8
{
    Text,
    Image_URL
};
 
UENUM(BlueprintType)
enum class EChatResponseFormat : uint8
{
    Text = 0,
    JSON_Object
};
 
UENUM(BlueprintType)
enum class EServiceTier : uint8
{
    Auto = 0,
    Default
};
 
USTRUCT(BlueprintType)
struct FImageURL
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString URL;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Detail{"auto"};
};
 
USTRUCT(BlueprintType)
struct FMessageContent
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Text;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FImageURL Image_URL;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Type{"text"};
};
 
USTRUCT(BlueprintType)
struct FMessage
{
    GENERATED_BODY()
 
    // ========================== content ===============================
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Content;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    TArray<FMessageContent> ContentArray;
 
    // ========================== common ===============================

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Role;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Name;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FOptionalString Refusal;
 
    // ========================== tools ===============================

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    TArray<FToolCalls> Tool_Calls;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Tool_Call_ID;
};

//                 REQUEST TYPES
 
USTRUCT(BlueprintType)
struct FChatCompletionResponseFormat
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Type{"text"};
};
 
USTRUCT(BlueprintType)
struct FStreamOptions
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalBool Include_Obfuscation;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalBool Include_Usage;
};
 
USTRUCT(BlueprintType)
struct FChatCompletion
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    TArray<FMessage> Messages;  //@todo: check

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Model;

    // FChatCompletionAudioParam Audio;  // @todo: implement optional struct pattern

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    float Frequency_Penalty{0.0f};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Max_Tokens;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    TMap<FString, FString> Metadata;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    TArray<FString> Modalities;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    TMap<FString, int32> Logit_Bias;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    bool Logprobs{false};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Top_Logprobs;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Max_Completion_Tokens;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    int32 N{1};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    float Presence_Penalty{0.0f};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FChatCompletionResponseFormat Response_Format;  //@todo: upgrade

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Seed;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Service_Tier;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    TArray<FString> Stop;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    bool Stream{false};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FStreamOptions Stream_Options;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    float Temperature{1.0f};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    float Top_P{1.0f};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    TArray<FTools> Tools;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FToolChoice Tool_Choice;  // @todo: none option

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalBool Parallel_Tool_Calls;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString User;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Prompt_Cache_Key;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Prompt_Cache_Retention;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Reasoning_Effort;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Safety_Identifier;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalBool Store;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Verbosity;

    // FWebSearchOptions Web_Search_Options;  // @todo: implement

    // FChatCompletionPrediction Prediction;  // @todo: implement
};

//                 RESPONSE TYPES
 
USTRUCT(BlueprintType)
struct FUsage
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Completion_Tokens{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Prompt_Tokens{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Total_Tokens{};
};

USTRUCT(BlueprintType)
struct FLogProb
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Token;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    float Logprob{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<uint8> Bytes;
};
 
USTRUCT(BlueprintType)
struct FLogProbExtent : public FLogProb
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FLogProb> Top_Logprobs;
};
 
USTRUCT(BlueprintType)
struct FLogProbs
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FLogProbExtent> Content;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FLogProbExtent> Refusal;
};
 
USTRUCT(BlueprintType)
struct FChatCompletionResponseBase
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString ID;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Created{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Model;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Service_Tier;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString System_Fingerprint;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Object;
};