BatchTypes.h

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

//                 REQUEST TYPES
 
UENUM(BlueprintType)
enum class EBatchEndpoint : uint8
{
    ChatCompletions = 0,
    Embeddings,
    Completions,
    Responses,
    Moderations,
    ImageGenerations,
    ImageEdits
};
 
UENUM(BlueprintType)
enum class EBatchCompletionWindow : uint8
{
    Window_24h = 0,
};

USTRUCT(BlueprintType)
struct FOutputExpiresAfter
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI")
    FString Anchor{"created_at"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI")
    int32 Seconds{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI")
    bool IsSet{false};
};
 
USTRUCT(BlueprintType)
struct FCreateBatch
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Input_File_Id{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Endpoint{"/v1/chat/completions"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Completion_Window{"24h"};

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

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOutputExpiresAfter Output_Expires_After;
};
 
USTRUCT(BlueprintType)
struct FListBatch
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString After;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Limit;
 
    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("&");
        }
 
        return Query.LeftChop(1);
    }
};

//                 RESPONSE TYPES
 
USTRUCT(BlueprintType)
struct FBatchInputTokensDetails
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Cached_Tokens{};
};
 
USTRUCT(BlueprintType)
struct FBatchOutputTokensDetails
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Reasoning_Tokens{};
};
 
USTRUCT(BlueprintType)
struct FBatchUsage
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Input_Tokens{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FBatchInputTokensDetails Input_Tokens_Details;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Output_Tokens{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FBatchOutputTokensDetails Output_Tokens_Details;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Total_Tokens{};
};
 
USTRUCT(BlueprintType)
struct FOpenAIBatchErrorData
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Code;

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

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Line{};
};
 
USTRUCT(BlueprintType)
struct FOpenAIBatchErrors
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Object;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FOpenAIBatchErrorData> Data;
};
 
USTRUCT(BlueprintType)
struct FOpenAIRequestCounts
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Total{};

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Failed{};
};
 
USTRUCT(BlueprintType)
struct FOpenAIBatch
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Id;

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Endpoint;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FOpenAIBatchErrors Errors;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FOpenAIRequestCounts Request_Counts;

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

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

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FBatchUsage Usage;
};
 
USTRUCT(BlueprintType)
struct FCreateBatchResponse : public FOpenAIBatch
{
    GENERATED_BODY()
};
 
USTRUCT(BlueprintType)
struct FRetrieveBatchResponse : public FOpenAIBatch
{
    GENERATED_BODY()
};
 
USTRUCT(BlueprintType)
struct FCancelBatchResponse : public FOpenAIBatch
{
    GENERATED_BODY()
};
 
USTRUCT(BlueprintType)
struct FListBatchResponse
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Object;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FOpenAIBatch> Data;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString First_Id;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Last_Id;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    bool Has_More{};
};
 
// @todo: https://platform.openai.com/docs/api-reference/batch/request-input
// @todo: https://platform.openai.com/docs/api-reference/batch/request-output