import { ChatCompletion, ChatCompletionChunk, ChatCompletionCreateParams, CreateEmbeddingResponse, EmbeddingCreateParams, ImageGenerateParams, ImagesResponse } from "openai/resources";
import { ChatCompletionStream } from "../utils/stream";

export interface OpenAILikeInterface {


   /**
    * 初始化聊天完成接口。
    * 
    * 本函数用于发起一个聊天完成的请求，根据请求的结果，可能会返回一个流式响应对象或一个单一的完成对象。
    * 这种设计允许灵活处理大量数据的实时传输或单次查询。
    * 
    * @param params 聊天完成的参数对象，包含所有必要的请求信息。
    * @returns 返回一个Promise，该Promise解析为一个聊天完成流对象或一个聊天完成对象。
    */
   chatComplete(params: ChatCompletionCreateParams): Promise<ChatCompletionStream<ChatCompletionChunk> | ChatCompletion>

   /**
   * 创建嵌入向量。
   * 
   * 该函数用于通过提供的参数创建嵌入向量。嵌入向量是一种将高维数据转换为低维向量表示的方法，
   * 常用于自然语言处理和其他领域。此函数的目的是为了异步生成这种嵌入向量，并返回相关的响应数据。
   * 
   * @param params - 创建嵌入向量所需的参数对象。这个对象包含了所有必要的配置信息，
   *                 如输入数据的格式、嵌入的维度、使用的模型等。
   * @returns 返回一个Promise对象，该对象解析为创建嵌入向量的响应数据。这包括了操作的状态码、
   *          消息以及其他可能的相关信息。
   */
   embeddings(params: EmbeddingCreateParams): Promise<CreateEmbeddingResponse>

   /**
   * 可选的异步方法：根据参数生成图片。
   * 
   * 此方法的目的是根据提供的参数动态生成图片。它是一个可选的方法，意味着它可能在某些情况下不存在。
   * 主要用于在运行时根据需要生成特定的图片，可能用于生成缩略图、水印图或其他根据参数变化的图片。
   * 
   * @param params - 图片生成的参数对象，包含所有必要的配置信息，如源图片路径、目标尺寸、格式等。
   * @returns 返回一个Promise，解析为包含生成的图片信息的响应对象。
   */
   imageGenerate?(params: ImageGenerateParams & {
      [key: string]: any
   }): Promise<ImagesResponse>

}