FineTuneTypes.h

// OpenAI, Copyright LifeEXE. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Provider/Types/OpenAICommonTypes.h"
#include "Provider/OpenAIOptional.h"
#include "FineTuneTypes.generated.h"

//                 REQUEST TYPES
 
USTRUCT(BlueprintType)
struct FFineTuningJobHyperparamsRequest
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Batch_Size{"auto"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Learning_Rate_Multiplier{"auto"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString N_Epochs{"auto"};
};
 
USTRUCT(BlueprintType)
struct FWandb
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Project;

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

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Entity;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    TArray<FString> Tags;
};
 
USTRUCT(BlueprintType)
struct FIntegration
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Type{"wandb"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FWandb Wandb;
};
 
USTRUCT(BlueprintType)
struct FFineTuningJob
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Model;

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

    // FFineTuningMethod Method;  // @todo: implement

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

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FFineTuningJobHyperparamsRequest Hyperparameters;

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

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

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    TArray<FIntegration> Integrations;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Seed;
};
 
USTRUCT(BlueprintType)
struct FFineTuningQueryParameters
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString After;

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

    TMap<FString, FString> Metadata;
 
    FString ToQuery() const
    {
        FString Query{"?"};
        if (After.IsSet)
        {
            Query.Append("after=").Append(After.Value).Append("&");
        }
 
        if (Limit.IsSet)
        {
            Query.Append("limit=").Append(FString::FromInt(Limit.Value)).Append("&");
        }
 
        for (const auto& [Key, Value] : Metadata)
        {
            Query.Append("metadata[").Append(Key).Append("]=").Append(Value).Append("&");
        }
 
        return Query.LeftChop(1);
    }
};

//                 RESPONSE TYPES
 
USTRUCT(BlueprintType)
struct FFineTuningJobError
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Code;

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Param;
};
 
USTRUCT(BlueprintType)
struct FFineTuningJobHyperparamsResponse
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Batch_Size;

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString N_Epochs;
};
 
USTRUCT(BlueprintType)
struct FFineTuningJobObjectResponse
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString ID;

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FFineTuningJobError Error;

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

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FFineTuningJobHyperparamsResponse Hyperparameters;

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

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

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FString> Result_Files;

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

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

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

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FIntegration> Integrations;

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

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TMap<FString, FString> Metadata;

    // FFineTuningMethod Method;  // @todo: implement
};
 
USTRUCT(BlueprintType)
struct FFineTuningJobEventResponse
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString ID;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Created_At{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Level;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Message;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Object;
};
 
USTRUCT(BlueprintType)
struct FMetrics
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Step{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    double Train_Loss{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    double Train_Mean_Token_Accuracy{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    double Valid_Loss{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    double Valid_Mean_Token_Accuracy{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    double Full_Valid_Loss{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    double Full_Valid_Mean_Token_Accuracy{};
};
 
USTRUCT(BlueprintType)
struct FFineTuningJobCheckpointResponse
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString ID;

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

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

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FMetrics Metrics;

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Object;
};
 
//===================
USTRUCT(BlueprintType)
struct FListFineTuningJobsResponse
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Object;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FFineTuningJobObjectResponse> Data;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString First_Id;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Last_Id;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    bool Has_More{false};
};
 
USTRUCT(BlueprintType)
struct FListFineTuningEventsResponse
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Object;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FFineTuningJobEventResponse> Data;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    bool Has_More{false};
};
 
USTRUCT(BlueprintType)
struct FListFineTuningCheckpointsResponse
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Object;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FFineTuningJobCheckpointResponse> Data;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString First_Id;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Last_id;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    bool Has_More{false};
};