Package core.model

• Package core.model
  • struct AsyncChatChunk
    • func toString
  • class AsyncChatResponse
    • let chunks
    • prop dialog
    • func iter
    • let model
    • func next
    • func toString
    • prop usage
  • interface ChatModel
    • func asyncCreate
    • func create
  • class ChatRequest
    • let dialog
    • func init
    • func init
    • func init
    • let stop
    • let temperature
    • func toString
  • struct ChatResponse
    • let dialog
    • func init
    • let model
    • func toString
    • let usage
  • class ChatUsage
    • let completionTokens
    • func init
    • let promptTokens
    • let timeCost
    • func toString
    • let totalTokens
  • interface EmbeddingModel
    • func create
  • struct EmbeddingRequest
    • let dimensions
    • func init
    • let prompt
  • struct EmbeddingResponse
    • let data
    • func init
    • func toString
  • interface ImageModel
    • func create
  • struct ImageRequest
  • struct ImageResponse
  • interface Model
    • prop name
    • prop service
  • class ModelException
    • func init

struct AsyncChatChunk

func toString

override public func toString(): String

• 描述: 将AsyncChatChunk对象转换为字符串表示

class AsyncChatResponse

let chunks

public let chunks: Iterator<AsyncChatChunk>

• 描述: 异步聊天块的迭代器

prop dialog

public prop dialog: Dialog

• 描述: 获取同步的聊天对话框

func iter

public func iter(withReason!: Bool = true): Iterator<String>

• 描述: 获取聊天内容的迭代器
• 参数:
  • withReason: Bool, 是否包含原因

let model

public let model: String

• 描述: 聊天模型名称

func next

override public func next(): Option<AsyncChatChunk>

• 描述: 获取下一个聊天块

func toString

public func toString(): String

• 描述: 将AsyncChatResponse对象转换为字符串表示

prop usage

public prop usage: Option<ChatUsage>

• 描述: 获取聊天使用情况

interface ChatModel

func asyncCreate

func asyncCreate(request: ChatRequest): AsyncChatResponse

• 描述: 聊天模型的异步API
• 参数:
  • request: ChatRequest, 聊天请求参数

func create

func create(request: ChatRequest): ChatResponse

• 描述: 聊天模型的同步API
• 参数:
  • request: ChatRequest, 聊天请求参数

class ChatRequest

let dialog

let dialog: Dialog

• 描述: 对话内容

func init

public init(message: String)

• 描述: 初始化ChatRequest，使用单条消息
• 参数:
  • message: String, 用户消息

func init

public init(messages: Array<ChatMessage>, temperature!: Option<Float64> = None, stop!: Option<Array<String>> = None)

• 描述: 初始化ChatRequest，使用消息数组
• 参数:
  • messages: Array<ChatMessage>, 消息数组
  • temperature: Option<Float64>, 温度参数，可选
  • stop: Option<Array<String>>, 停止条件，可选

func init

public init(dialog: Dialog, temperature!: Option<Float64> = None, stop!: Option<Array<String>> = None)

• 描述: 初始化ChatRequest，使用Dialog对象
• 参数:
  • dialog: Dialog, 对话对象
  • temperature: Option<Float64>, 温度参数，可选
  • stop: Option<Array<String>>, 停止条件，可选

let stop

let stop: Option<Array<String>>

• 描述: 停止条件

let temperature

let temperature: Option<Float64>

• 描述: 温度参数

func toString

public func toString(): String

• 描述: 将ChatRequest对象转换为字符串表示

struct ChatResponse

let dialog

let dialog: Dialog

• 描述: 对话内容

func init

public init(dialog: Dialog, model: String, usage!: Option<ChatUsage> = None)

• 描述: 初始化ChatResponse
• 参数:
  • dialog: Dialog, 对话内容
  • model: String, 模型名称
  • usage: Option<ChatUsage>, 使用情况统计

let model

let model: String

• 描述: 模型名称

func toString

public func toString(): String

• 描述: 将ChatResponse转换为字符串表示

let usage

let usage: Option<ChatUsage>

• 描述: 使用情况统计

class ChatUsage

let completionTokens

public let completionTokens: Int64

• 描述: 表示完成令牌的数量

func init

public init(promptTokens!: Int64, completionTokens!: Int64, totalTokens!: Int64, timeCost!: Option<Duration>)

• 描述: 初始化ChatUsage类的实例
• 参数:
  • promptTokens: Int64, 提示令牌的数量
  • completionTokens: Int64, 完成令牌的数量
  • totalTokens: Int64, 总令牌的数量
  • timeCost: Option<Duration>, 时间消耗的可选值

let promptTokens

public let promptTokens: Int64

• 描述: 表示提示令牌的数量

let timeCost

public let timeCost: Option<Duration>

• 描述: 表示时间消耗的可选值

func toString

public func toString(): String

• 描述: 将ChatUsage实例转换为字符串表示

let totalTokens

public let totalTokens: Int64

• 描述: 表示总令牌的数量

interface EmbeddingModel

func create

func create(request: EmbeddingRequest): EmbeddingResponse

• 描述: 根据请求创建嵌入向量
• 参数:
  • request: EmbeddingRequest, 嵌入请求，包含需要生成嵌入向量的文本

struct EmbeddingRequest

let dimensions

let dimensions: Option<Int64>

• 描述: 可选的嵌入维度大小

func init

init(prompt: String, dimensions!: Option<Int> = None)

• 描述: 初始化EmbeddingRequest结构体
• 参数:
  • prompt: String, 输入的提示文本
  • dimensions: Option<Int>, 可选的嵌入维度大小，默认为None

let prompt

let prompt: String

• 描述: 输入的提示文本

struct EmbeddingResponse

let data

let data: Array<Float64>

• 描述: 存储嵌入向量的数组

func init

init(data: Array<Float64>)

• 描述: 初始化EmbeddingResponse实例
• 参数:
  • data: Array<Float64>, 嵌入向量数组

func toString

func toString(): String

• 描述: 将EmbeddingResponse转换为字符串表示

interface ImageModel

func create

func create(request: ImageRequest): ImageResponse

• 描述: 根据图像请求创建图像响应
• 参数:
  • request: ImageRequest, 包含图像生成所需参数的请求对象

struct ImageRequest

struct ImageResponse

interface Model

prop name

prop name: String

• 描述: 模型名称，例如gpt-4o

prop service

prop service: String

• 描述: 服务名称，例如openai

class ModelException

func init

init(msg: String)

• 描述: 初始化ModelException异常
• 参数:
  • msg: String, 异常消息