# SparkChain 星火大模型 Linux SDK集成文档

#include "../include/sparkchain.h"

class SPARKCHAIN_API SparkChainConfig { 
    public:    
    	static SparkChainConfig* builder();    
    	virtual ~SparkChainConfig();    
    	//配置appid    
    	virtual SparkChainConfig* appID(const char* appid)         = 0;    
    	//配置apiKey    
    	virtual SparkChainConfig* apiKey(const char* apiKey)       = 0;    
    	//配置apiSecret    
    	virtual SparkChainConfig* apiSecret(const char* apiSecret) = 0;    
    	//配置用户自定义标识    
    	virtual SparkChainConfig* uid(const char* uid)             = 0;    
    	//配置SDK工作路径    
    	virtual SparkChainConfig* workDir(const char* workDir)     = 0;    
    	//配置日志等级    
    	virtual SparkChainConfig* logLevel(int logLevel )          = 0;    
    	//配置日志存储路径    
    	virtual SparkChainConfig* logPath(const char* logPath)     = 0; 
};

SparkChainConfig* config = SparkChainConfig::builder(); 
config->appID("$appId")      
    ->apiKey("$apiKey")      
    ->apiSecret("$apiSecret");//从平台获取的授权appid，apikey,apisecrety 
int ret = SparkChain::init(config);

class SPARKCHAIN_API LLMConfig { 
    public:    
    	static LLMConfig* builder();    
    	virtual ~LLMConfig();    
    	//需要使用的领域    
    	virtual LLMConfig* domain(const char* domain)     = 0;    
    	//内容审核的场景策略    
    	virtual LLMConfig* auditing(const char* auditing) = 0;    
    	//配置关联会话chat_id标识，需要保障用户下唯一    
    	virtual LLMConfig* chatID(const char* chatID)     = 0;    
    	//配置核采样阈值，改变结果的随机程度    
    	virtual LLMConfig* temperature(float temperature) = 0;    
    	//配置从k个候选中随机选择⼀个（⾮等概率)    
    	virtual LLMConfig* topK(int topK)                 = 0;    
    	//回答的tokens的最大长度    
    	virtual LLMConfig* maxToken(int maxToken)         = 0;    
    	//配置chat服务器域名地址    
    	virtual LLMConfig* url(const char* url)           = 0; 
    	//该参数仅4.0 Ultra版本支持，返回搜索结果信源
    	virtual LLMConfig* showRefLabel(bool show)        = 0;
};

Memory* window_memory = Memory::WindowMemory(5);//windowMemory 
Memory* token_memory = Memory::TokenMemory(8192);//tokenMemory 
/****** *文本交互 *******/ 
LLMConfig *chat_llmConfig = LLMConfig::builder(); 
chat_llmConfig->maxToken(2048); 
... 
chat_llmConfig->topK(4);//config配置可缺省，demo仅供展示如何使用,开发者根据实际情况选择。 
LLM *chat_llm = LLMFactory::textGeneration(chat_llmConfig,window_memory);

LLMSyncOutput* run(const char* question, int ttl = 60);

//同步调用 
LLMSyncOutput* result = chat_llm->run("给我讲个笑话吧。"); 
//解析获取的结果，示例展示所有结果获取，开发者可根据自身需要，选择获取。 
const char* content  = result->getContent();//获取返回结果 
int contentLen       = result->getContentLen();//获取返回结果长度 
SparkChain::LLMResult::ContentType type = result->getContentType();//获取返回结果类型,TEXT:返回结果为文本,IMAGE:返回结果为图片  
int errCode          = result->getErrCode();//获取结果状态,0:调用成功，非0:调用失败 
const char* errMsg   = result->getErrMsg();//获取失败时的错误信息 
const char* role     = result->getRole();//获取角色信息 
const char* sid      = result->getSid();//获取本次交互的sid 
int completionTokens = result->getCompletionTokens();//获取回答的Token大小 
int promptTokens     = result->getPromptTokens();//包含历史问题的总Tokens大小 
int totalTokens      = result->getTotalTokens();//promptTokens和completionTokens的和，也是本次交互计费的Tokens大小

class SparkCallbacks : public LLMCallbacks {    
    void onLLMResult(LLMResult* result, void* usrContext) {          
    
    }    
    void onLLMEvent(LLMEvent* event, void* usrContext) {           
    
    }    
    void onLLMError(LLMError* error, void* usrContext) {           
    
    } 
};

class SparkCallbacks : public LLMCallbacks {    
    void onLLMResult(LLMResult* result, void* usrContext) {        
        //解析获取的交互结果，示例展示所有结果获取，开发者可根据自身需要，选择获取。        
        const char* content  = result->getContent();//获取返回结果        
        int contentLen       = result->getContentLen();//获取返回结果长度        
        SparkChain::LLMResult::ContentType type = result->getContentType();//获取返回结果类型,TEXT:返回结果为文本,IMAGE:返回结果为图片
        int status           = result->getStatus();//返回结果状态，0：结果返回第一帧，1：结果返回中间帧，2：结果返回最终帧        
        const char* role     = result->getRole();//获取角色信息        
        const char* sid      = result->getSid();//获取本次会话的sid        
        int completionTokens = result->getCompletionTokens();//获取回答的Token大小        
        int promptTokens     = result->getPromptTokens();//包含历史问题的总Tokens大小        
        int totalTokens      = result->getTotalTokens();//promptTokens和completionTokens的和，也是本次交互计费的Tokens大小    
    }    
    void onLLMEvent(LLMEvent* event, void* usrContext) {        
        //解析获取的事件结果，示例展示所有结果获取，开发者可根据自身需要，选择获取。        
        int eventId          = event->getEventID();//获取事件id        
        const char* eventMsg = event->getEventMsg();//获取事件信息        
        const char* sid      = event->getSid();//获取交互sid    
    }    
    void onLLMError(LLMError* error, void* usrContext) {        
        //解析获取的错误结果，示例展示所有结果获取，开发者可根据自身需要，选择获取。        
        int errCode        = error->getErrCode();//获取错误码        
        const char* errMsg = error->getErrMsg();//获取错误信息        
        const char* sid    = error->getSid();//获取交互sid    
    } 
}; 
SparkCallbacks* cbs = new SparkCallbacks(); chat_llm->registerLLMCallbacks(cbs);

int arun(const char* question, void* usrTag = nullptr);

int ret = chat_llm->arun("给我讲个笑话吧。"); 
//带有用户自定义标识交互 
//char* usrContext = "myContext"; 
//int ret = chat_llm->arun("给我讲个笑话吧。",usrContext);

chat_llm->stop();

SparkChain::unInit();

string function = R"(
        [
            {
                "name": "天气查询",
                "description": "天气插件可以提供天气相关信息。你可以提供指定的地点信息、指定的时间点或者时间段信息，来精准检索到天气信息。",
                "parameters": {
                    "type": "object",
                    "properties": {
                        "location": {
                            "type": "string",
                            "description": "地点，比如北京。"
                        },
                        "date": {
                            "type": "string",
                            "description": "日期。"
                        }
                    },
                    "required": [
                        "location"
                    ]
                }
            }
        ]
    )";
    
    // 配置大模型参数
    LLMConfig *llmConfig = LLMConfig::builder();
    llmConfig->domain("4.0Ultra");
    LLM *functionCall_llm = LLMFactory::textGeneration(llmConfig);
    SparkCallbacks *cbs = new SparkCallbacks();
    functionCall_llm->registerLLMCallbacks(cbs);//注册监听回调
    SparkChain::LLMTools tools("functions",function);
    char* input = "合肥今天的天气怎么样？";
    printf(GREEN "用户输入: %s\n" RESET, input);
    finish = false;
    int ret = functionCall_llm->arun(input,tools);

class SPARKCHAIN_API LLM {
	LLMSyncOutput* runWithJson(const char* json, int ttl = 60);
    int arunWithJson(const char* body, void* usrTag);
}

LLMConfig *llmConfig = LLMConfig::builder();
llmConfig->domain("4.0Ultra");  
LLM *json_llm = LLMFactory::textGeneration(llmConfig);
char* rawJson = "{\"header\": {\"app_id\": \"30dfb58a\",\"uid\": \"12345\"},\"parameter\": {\"chat\": {\"domain\": \"4.0Ultra\",\"temperature\": 0.5,\"max_tokens\": 1024}},\"payload\": {\"message\": {\"text\": [{\"role\": \"user\", \"content\": \"今天天气怎么样?\"}]}}}";
    
SparkCallbacks *cbs = new SparkCallbacks();
json_llm->registerLLMCallbacks(cbs);//注册监听回调
int ret = json_llm->arunWithJson(rawJson,nullptr);