http4k-connect-ai-openai/org.http4k.connect.openai.action

Package-level declarations

Types

@JsonSerializable

data class ChatCompletion(val model: ModelName, val messages: List<Message>, val max_tokens: MaxTokens? = null, val temperature: Temperature = Temperature.ONE, val top_p: Double = 1.0, val n: Int = 1, val stop: List<String>? = null, val presence_penalty: Double = 0.0, val frequency_penalty: Double = 0.0, val logit_bias: Map<TokenId, Double>? = null, val user: User? = null, val stream: Boolean = false, val response_format: ResponseFormat? = null, val tools: List<Tool>? = null, val tool_choice: Any? = null, val parallel_tool_calls: Boolean? = null, val service_tier: String? = null, val seed: Int? = null, val stream_options: StreamOptions? = null) : OpenAIAction<Sequence<CompletionResponse>>

Choice

@JsonSerializable

data class Choice(val index: Int, msg: ChoiceDetail?, delta: ChoiceDetail?, val finish_reason: StopReason?)

ChoiceDetail

@JsonSerializable

data class ChoiceDetail(r: Role?, val content: String? = null, val tool_calls: List<ToolCall>? = null)

CompletionResponse

@JsonSerializable

data class CompletionResponse(val id: CompletionId, val created: Timestamp, val model: ModelName, val choices: List<Choice>, val objectType: ObjectType, val usage: Usage? = null, val system_fingerprint: String? = null, val service_tier: String? = null)

ContentType

enum ContentType : Enum<ContentType>

CreateEmbeddings

@JsonSerializable

data class CreateEmbeddings(val model: ModelName, val input: List<String>) : NonNullAutoMarshalledAction<Embeddings> , OpenAIAction<Embeddings>

Detail

enum Detail : Enum<Detail>

Embedding

@JsonSerializable

data class Embedding(val embedding: FloatArray, val index: Int)

Embeddings

@JsonSerializable

data class Embeddings(val data: List<Embedding>, val model: ModelName, val usage: Usage)

Function

@JsonSerializable

data class Function(val name: String)

FunctionCall

@JsonSerializable

data class FunctionCall(val name: String, val arguments: String)

FunctionSpec

@JsonSerializable

data class FunctionSpec(val name: String, val parameters: Any? = null, val description: String? = null)

GeneratedImage

@JsonSerializable

data class GeneratedImage(val created: Timestamp, val data: List<ImageData>)

GenerateImage

@JsonSerializable

data class GenerateImage(val prompt: String, val size: Size = Size.`1024x1024`, val response_format: ImageResponseFormat = url, val n: Int = 1, val quality: Quality = Quality.standard, val style: Style = Style.vivid, val user: User? = null) : NonNullAutoMarshalledAction<GeneratedImage> , OpenAIAction<GeneratedImage>

GetModels

object GetModels : NonNullAutoMarshalledAction<Models> , OpenAIAction<Models>

ImageData

@JsonSerializable

data class ImageData(val url: Uri? = null, val b64_json: Base64Blob? = null)

ImageResponseFormat

enum ImageResponseFormat : Enum<ImageResponseFormat>

ImageUrl

@JsonSerializable

data class ImageUrl(val url: Uri, val detail: Detail = auto)

Message

@JsonSerializable

data class Message(val role: Role?, val content: List<MessageContent>? = null, val name: User? = null, val refusal: String? = null, val tool_calls: List<ToolCall>? = null)

MessageContent

@JsonSerializable

data class MessageContent(val type: ContentType, val text: String? = null, val image_url: ImageUrl? = null)

Model

@JsonSerializable

data class Model(val id: ObjectId, val objectType: ObjectType, val created: Timestamp, val owned_by: OpenAIOrg, val permission: List<Permission>?, val root: ObjectId?, val parent: Any?)

Models

@JsonSerializable

data class Models(val data: List<Model>)

Permission

@JsonSerializable

data class Permission(val id: ObjectId, val objectType: ObjectType, val created: Timestamp, val allow_create_engine: Boolean, val allow_sampling: Boolean, val allow_logprobs: Boolean, val allow_search_indices: Boolean, val allow_view: Boolean, val allow_fine_tuning: Boolean, val organization: OpenAIOrg, val group: Any?, val is_blocking: Boolean)

ResponseFormat

@JsonSerializable

@Polymorphic(labelKey = "type")

sealed class ResponseFormat

Size

enum Size : Enum<Size>

StreamOptions

@JsonSerializable

data class StreamOptions(val include_usage: Boolean? = null)

Tool

@JsonSerializable

data class Tool(val function: FunctionSpec)