2024云邊一體化人工智能算力資源開(kāi)放與適配平臺(tái)模型服務(wù)標(biāo)準(zhǔn)

云邊一體化人工智能算力資源開(kāi)放與適配云邊一體化人工智能算力資源開(kāi)放與適配平臺(tái)模型服務(wù)標(biāo)準(zhǔn)Contents前言 31. 范圍 42. 定義和縮略語(yǔ) 42.1定義 42.2縮略語(yǔ) 43. 在線推理服務(wù)標(biāo)準(zhǔn) 43.1參數(shù)定義 43.1.1接口描述 53.1.2請(qǐng)求說(shuō)明 53.1.3返回說(shuō)明 53.1.4Contents前言 31. 范圍 42. 定義和縮略語(yǔ) 42.1定義 42.2縮略語(yǔ) 43. 在線推理服務(wù)標(biāo)準(zhǔn) 43.1參數(shù)定義 43.1.1接口描述 53.1.2請(qǐng)求說(shuō)明 53.1.3返回說(shuō)明 53.1.4錯(cuò)誤碼 63.1.5安全簽名規(guī)則 63.2性能部分 74SDK標(biāo)準(zhǔn) 74.1簡(jiǎn)介 74.2請(qǐng)求說(shuō)明 74.3集成指南 74.4接口說(shuō)明 84.5常見(jiàn)問(wèn)題及錯(cuò)誤碼描述 9參考文獻(xiàn) 9─云邊一體化項(xiàng)目數(shù)據(jù)接入標(biāo)準(zhǔn)─云邊一體化項(xiàng)目兼容主流框架標(biāo)準(zhǔn)─云邊一體化項(xiàng)目模型格式轉(zhuǎn)換標(biāo)準(zhǔn)─云邊一體化項(xiàng)目模型服務(wù)標(biāo)準(zhǔn)─云邊一體化項(xiàng)目數(shù)據(jù)接入標(biāo)準(zhǔn)─云邊一體化項(xiàng)目兼容主流框架標(biāo)準(zhǔn)─云邊一體化項(xiàng)目模型格式轉(zhuǎn)換標(biāo)準(zhǔn)─云邊一體化項(xiàng)目模型服務(wù)標(biāo)準(zhǔn)1.范圍本標(biāo)準(zhǔn)規(guī)定了通過(guò)云邊一體化平臺(tái)發(fā)布的模型服務(wù)的規(guī)范標(biāo)準(zhǔn)，包含在線推理服務(wù)標(biāo)準(zhǔn)和SDK本標(biāo)準(zhǔn)適用于模型開(kāi)發(fā)人員及運(yùn)維人員，所有通過(guò)平臺(tái)發(fā)布的模型服務(wù)，應(yīng)遵守統(tǒng)一的規(guī)范標(biāo)準(zhǔn)。2.定義和縮略語(yǔ)下列術(shù)語(yǔ)、定義和縮略語(yǔ)適用于本文件。2.1secretKey：密鑰。timestamp：13位時(shí)間戳，自1970年1月1日0時(shí)起的毫秒數(shù)，為了防止用戶時(shí)鐘與服務(wù)器時(shí)5間要求，則認(rèn)為請(qǐng)求超時(shí)，拒絕該請(qǐng)求；如果符合上述要求，則執(zhí)行下一步操作。sign:簽名。2.21.范圍本標(biāo)準(zhǔn)規(guī)定了通過(guò)云邊一體化平臺(tái)發(fā)布的模型服務(wù)的規(guī)范標(biāo)準(zhǔn)，包含在線推理服務(wù)標(biāo)準(zhǔn)和SDK本標(biāo)準(zhǔn)適用于模型開(kāi)發(fā)人員及運(yùn)維人員，所有通過(guò)平臺(tái)發(fā)布的模型服務(wù)，應(yīng)遵守統(tǒng)一的規(guī)范標(biāo)準(zhǔn)。2.定義和縮略語(yǔ)下列術(shù)語(yǔ)、定義和縮略語(yǔ)適用于本文件。2.1secretKey：密鑰。timestamp：13位時(shí)間戳，自1970年1月1日0時(shí)起的毫秒數(shù)，為了防止用戶時(shí)鐘與服務(wù)器時(shí)5間要求，則認(rèn)為請(qǐng)求超時(shí)，拒絕該請(qǐng)求；如果符合上述要求，則執(zhí)行下一步操作。sign:簽名。2.2APIApplicationProgrammingInterface應(yīng)用程序編程接口JSONJavaScriptObjectNotationJavaScript對(duì)象表示法RESTRepresentationalStateTransfer表述型狀態(tài)轉(zhuǎn)移URLUniformResourceLocator統(tǒng)一資源定位器SDKSoftwareDevelopmentKit軟件開(kāi)發(fā)工具包QPSQueries-per-second每秒查詢率3.在線推理服務(wù)標(biāo)準(zhǔn)Restful規(guī)范，并根據(jù)模型類(lèi)型，生成對(duì)應(yīng)的參數(shù)定義和性能指標(biāo)。3.1URL地址、安全簽名規(guī)則、請(qǐng)求和返回格式等信息。3.1.1接口描述3.1.2請(qǐng)求說(shuō)明3.1.3返回說(shuō)明返回參數(shù)公共返回參數(shù)必填項(xiàng)。為公共請(qǐng)求參數(shù)：Code：string型，參見(jiàn)下方錯(cuò)誤碼-系統(tǒng)級(jí)錯(cuò)誤碼Charge：boolean型，false：不扣費(fèi)，true：扣費(fèi)RemainTimes：long型，剩余調(diào)用次數(shù)RemainSeconds：long型，剩余調(diào)用時(shí)間（s）Msg：string3.1.1接口描述3.1.2請(qǐng)求說(shuō)明3.1.3返回說(shuō)明返回參數(shù)公共返回參數(shù)必填項(xiàng)。為公共請(qǐng)求參數(shù)：Code：string型，參見(jiàn)下方錯(cuò)誤碼-系統(tǒng)級(jí)錯(cuò)誤碼Charge：boolean型，false：不扣費(fèi)，true：扣費(fèi)RemainTimes：long型，剩余調(diào)用次數(shù)RemainSeconds：long型，剩余調(diào)用時(shí)間（s）Msg：string型，參見(jiàn)下方錯(cuò)誤碼-系統(tǒng)級(jí)錯(cuò)誤碼Result：object型，查詢結(jié)果接口地址必填項(xiàng)。https://{platform}/{domain}/{api_name}，其中platform變量為實(shí)際部署平臺(tái)，domain變量由平臺(tái)自行確定，api_name為接口名稱(chēng)。請(qǐng)求方式必填項(xiàng)。Post。請(qǐng)求參數(shù)Query請(qǐng)求參數(shù)必填項(xiàng)。為公共請(qǐng)求參數(shù)，包括：Appkey：string型，必填項(xiàng)，您的appkey，可在買(mǎi)家中心控制臺(tái)中獲取Timestamp：long型，必填項(xiàng)，請(qǐng)求的時(shí)間戳，精確到毫秒，timestamp5型，必填項(xiàng)，簽名，根據(jù)規(guī)則MD5(sectetkey+timestamp)Header請(qǐng)求參數(shù)可選項(xiàng)。業(yè)務(wù)請(qǐng)求參數(shù)，需清楚地說(shuō)明參數(shù)名稱(chēng)、對(duì)應(yīng)的類(lèi)型、是否為必填項(xiàng)、參數(shù)描述并附上實(shí)例。Body請(qǐng)求參數(shù)必填項(xiàng)。業(yè)務(wù)請(qǐng)求參數(shù)，需清楚地說(shuō)明參數(shù)名稱(chēng)、對(duì)應(yīng)的類(lèi)型、是否為必填項(xiàng)、參數(shù)描述并附上實(shí)例。功能描述必填項(xiàng)。需清楚地描述該服務(wù)對(duì)應(yīng)的功能，其中，分類(lèi)問(wèn)題需指出種類(lèi)信息。接口使用必填項(xiàng)。需區(qū)分免費(fèi)和付費(fèi)服務(wù)的調(diào)用限制。數(shù)據(jù)要求必填項(xiàng)。圖片要求可包括：圖片格式、圖片像素尺寸、圖片Base64大小。視頻要求可包括：視頻格式、視頻文件大小。語(yǔ)音要求可包括：音頻格式、音頻采樣率、聲道數(shù)、音頻文件時(shí)長(zhǎng)、音頻文件大小。3.1.4錯(cuò)誤碼系統(tǒng)級(jí)錯(cuò)誤碼：業(yè)務(wù)錯(cuò)誤碼：自定義即可，需清楚地業(yè)務(wù)錯(cuò)誤碼（status）msg和相關(guān)說(shuō)明。3.1.5安全簽名規(guī)則1secretkeytimestamp參數(shù)值進(jìn)行拼裝2mavenpom.xml中增加以下內(nèi)容<dependency>返回碼（code）說(shuō)明（message）10000查詢成功10001錯(cuò)誤的請(qǐng)求appkey10003不存在相應(yīng)的數(shù)據(jù)信息10004URL上appkey參數(shù)不能為空10010接口需要付費(fèi)，請(qǐng)充值10020系統(tǒng)繁忙，請(qǐng)稍后再試10030調(diào)用網(wǎng)關(guān)失敗，請(qǐng)與NeuHub聯(lián)系10040超過(guò)每天限量，請(qǐng)明天繼續(xù)10041URL上timestamp參數(shù)不能為空10042URL上sign3.1.4錯(cuò)誤碼系統(tǒng)級(jí)錯(cuò)誤碼：業(yè)務(wù)錯(cuò)誤碼：自定義即可，需清楚地業(yè)務(wù)錯(cuò)誤碼（status）msg和相關(guān)說(shuō)明。3.1.5安全簽名規(guī)則1secretkeytimestamp參數(shù)值進(jìn)行拼裝2mavenpom.xml中增加以下內(nèi)容<dependency>返回碼（code）說(shuō)明（message）10000查詢成功10001錯(cuò)誤的請(qǐng)求appkey10003不存在相應(yīng)的數(shù)據(jù)信息10004URL上appkey參數(shù)不能為空10010接口需要付費(fèi)，請(qǐng)充值10020系統(tǒng)繁忙，請(qǐng)稍后再試10030調(diào)用網(wǎng)關(guān)失敗，請(qǐng)與NeuHub聯(lián)系10040超過(guò)每天限量，請(qǐng)明天繼續(xù)10041URL上timestamp參數(shù)不能為空10042URL上sign參數(shù)不能為空10043超過(guò)QPS限額，請(qǐng)降低調(diào)用頻率或與NeuHub聯(lián)系10044集群QPS超限額，請(qǐng)與NeuHub聯(lián)系10045timestamp參數(shù)無(wú)效，請(qǐng)檢查timestamp距離當(dāng)前時(shí)間是否超過(guò)5分鐘10046timestamp參數(shù)格式錯(cuò)誤10047請(qǐng)求簽名sign無(wú)效，請(qǐng)檢查簽名信息10048無(wú)接口權(quán)限，請(qǐng)下單購(gòu)買(mǎi)10049超過(guò)每天最大調(diào)用量10050用戶已被禁用10060發(fā)布方設(shè)置調(diào)用權(quán)限，請(qǐng)聯(lián)系發(fā)布方10090文件大小超限，請(qǐng)上傳小于5M的文件11010發(fā)布方接口調(diào)用異常，請(qǐng)稍后再試11030發(fā)布方接口返回格式有誤業(yè)務(wù)返回參數(shù)必填項(xiàng)。需清楚地說(shuō)明參數(shù)名稱(chēng)、對(duì)應(yīng)的類(lèi)型、是否為必填項(xiàng)、參數(shù)描述并附上實(shí)例。如果存在類(lèi)型為數(shù)組的參數(shù)，需描述單個(gè)元素的結(jié)構(gòu)返回示例需添加至少一個(gè)返回示例<groupId>com.google.guava</groupId><artifactId>guava</artifactId><version>27.1-jre</version></dependency>3MD5signimportmon.hash.Hashing;importjava.nio.charset.Charset;StringsecretKey="2e148773a0338a8f2200ba90d445f084";longtimestamp=System.currentTimeMillis();Stringsign=Hashing.md5().hashString(secretKey+timestamp,Charset.forName("UTF-8")).toString();3.2 性能部分QPS，即每秒的響應(yīng)請(qǐng)求數(shù)、響應(yīng)時(shí)長(zhǎng)，即系統(tǒng)對(duì)請(qǐng)求作出響應(yīng)的時(shí)間、服務(wù)所提供算法的置信度等指標(biāo)。4SDKSDK，應(yīng)提供對(duì)應(yīng)支持系統(tǒng)和硬件版本、網(wǎng)絡(luò)要求、授權(quán)方式等信息，并提供調(diào)用方式介紹或者Demo項(xiàng)目。4.1簡(jiǎn)介4.2請(qǐng)求說(shuō)明4.3<groupId>com.google.guava</groupId><artifactId>guava</artifactId><version>27.1-jre</version></dependency>3MD5signimportmon.hash.Hashing;importjava.nio.charset.Charset;StringsecretKey="2e148773a0338a8f2200ba90d445f084";longtimestamp=System.currentTimeMillis();Stringsign=Hashing.md5().hashString(secretKey+timestamp,Charset.forName("UTF-8")).toString();3.2 性能部分QPS，即每秒的響應(yīng)請(qǐng)求數(shù)、響應(yīng)時(shí)長(zhǎng)，即系統(tǒng)對(duì)請(qǐng)求作出響應(yīng)的時(shí)間、服務(wù)所提供算法的置信度等指標(biāo)。4SDKSDK，應(yīng)提供對(duì)應(yīng)支持系統(tǒng)和硬件版本、網(wǎng)絡(luò)要求、授權(quán)方式等信息，并提供調(diào)用方式介紹或者Demo項(xiàng)目。4.1簡(jiǎn)介4.2請(qǐng)求說(shuō)明4.3集成指南SDK，包括開(kāi)發(fā)前的準(zhǔn)備工作和如何添加靜態(tài)庫(kù)等。下載地址必填項(xiàng)。需說(shuō)明版本號(hào)和對(duì)應(yīng)的下載地址。資源占用描述可選項(xiàng)。需說(shuō)明SDK包含的文件格式和占用的內(nèi)存大小。功能描述必填項(xiàng)。需清楚地描述該SDK支持的功能。鑒權(quán)說(shuō)明可選項(xiàng)。需區(qū)分免費(fèi)和付費(fèi)SDK的調(diào)用限制。支持的設(shè)備可選項(xiàng)?？芍赋霭ㄏ到y(tǒng)、機(jī)型、架構(gòu)、外設(shè)、網(wǎng)絡(luò)等相關(guān)設(shè)備要求。4.4 接口說(shuō)明需詳細(xì)描述每個(gè)接口的函數(shù)定義、功能、參數(shù)說(shuō)明并添加相應(yīng)的用例。如：setOpts()函數(shù)定義：setOpts(Stringkey,Stringval)功能：TTS系統(tǒng)參數(shù)值。參數(shù)說(shuō)明：keyval：參數(shù)值用例：4.4 接口說(shuō)明需詳細(xì)描述每個(gè)接口的函數(shù)定義、功能、參數(shù)說(shuō)明并添加相應(yīng)的用例。如：setOpts()函數(shù)定義：setOpts(Stringkey,Stringval)功能：TTS系統(tǒng)參數(shù)值。參數(shù)說(shuō)明：keyval：參數(shù)值用例：TTSParamttsParam=newTTSParam();ttsParam.setOpts("serverURL/jdai/tts//接口地址（API接口地址不同，詳見(jiàn)購(gòu)買(mǎi)的API接口文檔）ttsParam.setOpts("appKey","XXXXXX");ttsParam.setOpts("appSecret","XXXXXXX");ttsParam.setOpts("CustomerType","0");//固定值，Neuhub平臺(tái)ttsParam.setOpts("tte1"http://1:UTF-8UTF-8格式)ttsParam.setOpts("aue","1");//0：wav1：pcm2：opus3：mp3ttsParam.setOpts("tim0"http://01（APIttsParam.setOpts("tim0"http://01（APIAPI接口文檔）ttsParam.setOpts("vol","2.0");//音量[0.1,10.0]ttsParam.setOpts("sp1.0");//[0.52.0]ttsParam.setOpts("sr24000//wavpcm4k24kopus8k12k16k和24k的采樣率ttsParam.set