EmbeddingTypes.h

// OpenAI, Copyright LifeEXE. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Provider/OpenAIOptional.h"
#include "EmbeddingTypes.generated.h"
 
UENUM(BlueprintType)
enum class EEmbeddingsEncodingFormat : uint8
{
    Float,
    Base64
};
 
//                 REQUEST TYPES
 
USTRUCT(BlueprintType)
struct FEmbeddings
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    TArray<FString> Input;
 
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Model;
 
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Encoding_Format{"float"};
 
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Dimensions;
 
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString User;
};
 
//                 RESPONSE TYPES
 
USTRUCT(BlueprintType)
struct FEmbeddingsUsage
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Prompt_Tokens{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Total_Tokens{};
};
 
USTRUCT(BlueprintType)
struct FEmbeddingsData
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Index{};
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<float> Embedding;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Object;
};
 
USTRUCT(BlueprintType)
struct FEmbeddingsResponse
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Object;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FEmbeddingsData> Data;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Model;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FEmbeddingsUsage Usage;
};