# SparkChain 大模型识别 Linux SDK集成文档

#include "../include/sparkchain.h"//必须导入 
#include "../include/sc_asr.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 ASR {    
    public:     	
    	ASR();    	
    	ASR(string language, string domain, string accent);    	
    	~ASR(); 
}

ASR asr = new ASR("mul_cn","slm","mandarin");
//ASR asr = new ASR();//缺省参数调用方式

asr.language("mul_cn");
asr.accent("mandarin");
...
asr.domain("slm");
asr.vinfo(true);

class SPARKCHAIN_API ASRCallbacks { 
    public:    
    	virtual void onResult(ASRResult * result, void * usrTag) = 0;    
    	virtual void onError(ASRError * error,void * usrTag) = 0; 
};

class ASRCallbacksImpl : public ASRCallbacks {    
    void onResult(ASRResult * result, void * usrTag) override {        
        string result = result->bestMatchText();//解析识别结果        
        int status    = result->status();//解析结果返回状态        
        string sid    = result->sid();//解析sid        
        //以下信息需要开发者根据自身需求，如无必要，可不需要解析执行。        
        vector<Vad *> vads = result->vads();//解析vad结构体        
        for (Vad * v : vads) {            
            int begin = v->begin();//解析vad前端点            
            int end   = v->end();//解析vad后端点                    
        }        
        vector<Transcription *> transcriptions = result->transcriptions();//解析具体结果信息        
        for (auto item : transcriptions) {            
            vector<Segment *> segs = item->segments();//解析中文分词结构体            
            for (auto seg : segs) {                
                string word = seg->text();//解析词语            
            }        
        }    
    }    
    void onError(ASRError * error,void * usrTag) override {        
        int errCode   = error->code();//错误码        
        string errMsg = error->errMsg();//错误信息        
        string sid    = error->sid();//本次交互的sid    
    } 
}; 
ASRCallbacksImpl *mASRCallbacks = new ASRCallbacksImpl(); asr.registerCallbacks(mASRCallbacks);

class SPARKCHAIN_API ASR {    
    public:     	
    	int start(void * usrTag = nullptr);    	
    	int start(const AudioAttributes & attributes,void * usrTag = nullptr); 
} 
class SPARKCHAIN_API AudioAttributes {
    public:
    	AudioAttributes(const AudioAttributes & attributes);
    
    	void setSampleRate(int sampleRate);

    	void setEncoding(const string & encoding);

    	void setChannels(int channels);

    	void setBitDepth(int bitdepth);

    	void setFrameSize(int framesize);
    	
    	
}

asr.start();
//带有数据信息结构体的构建方式示例如下：
//AudioAttributes atr = new AudioAttributes();
//atr.setSampleRate(16000);
//atr.setEncoding("raw");
//atr.setChannels(1);
//asr.start(atr, null);

class SPARKCHAIN_API ASR {    
    public:     	
    	int write(const char * data, size_t len); 
}

通过是否传入speex_size（speex音频帧长，仅在speex音频时使用）参数来区分 
1、当传入speex_size参数时，会当成标准开源格式进行处理 
2、当未传入speex_size参数时，会当成讯飞定制格式进行处理

//示例仅展示从本地读取文件，具体获取音频逻辑需要开发者自己实现 
char * data = new char[1280]; 
...//省略获取音频的过程 
asr.write(data);

class SPARKCHAIN_API ASR {    
    public:     	
    	int stop(bool immediate = false); 
}

asr.stop();

SparkChain::unInit();