"use strict";(self.webpackChunkelementary_public_docs=self.webpackChunkelementary_public_docs||[]).push([[30525],{15680:(e,t,n)=>{n.d(t,{xA:()=>p,yg:()=>y});var a=n(96540);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function g(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?l(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function o(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},l=Object.keys(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var i=a.createContext({}),d=function(e){var t=a.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):g(g({},t),e)),n},p=function(e){var t=d(e.components);return a.createElement(i.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,i=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),s=d(n),u=r,y=s["".concat(i,".").concat(u)]||s[u]||m[u]||l;return n?a.createElement(y,g(g({ref:t},p),{},{components:n})):a.createElement(y,g({ref:t},p))}));function y(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,g=new Array(l);g[0]=u;var o={};for(var i in t)hasOwnProperty.call(t,i)&&(o[i]=t[i]);o.originalType=e,o[s]="string"==typeof e?e:r,g[1]=o;for(var d=2;d<l;d++)g[d]=n[d];return a.createElement.apply(null,g)}return a.createElement.apply(null,n)}u.displayName="MDXCreateElement"},71872:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>g,default:()=>m,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var a=n(58168),r=(n(96540),n(15680));const l={sidebar_position:1,title:"\u6587\u672c\u5411\u91cf\u5316"},g="\u6587\u672c\u5411\u91cf\u5316",o={unversionedId:"model-as-a-service/nova/chat/Embeddings/Embedding",id:"model-as-a-service/nova/chat/Embeddings/Embedding",title:"\u6587\u672c\u5411\u91cf\u5316",description:"\u63a5\u53e3\u63cf\u8ff0\uff08Description\uff09",source:"@site/docs/model-as-a-service/nova/chat/Embeddings/Embedding.md",sourceDirName:"model-as-a-service/nova/chat/Embeddings",slug:"/model-as-a-service/nova/chat/Embeddings/Embedding",permalink:"/help/docs/model-as-a-service/nova/chat/Embeddings/Embedding",draft:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/model-as-a-service/nova/chat/Embeddings/Embedding.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1,title:"\u6587\u672c\u5411\u91cf\u5316"},sidebar:"tutorialSidebar",previous:{title:"\u62df\u4eba\u5bf9\u8bdd\u751f\u6210",permalink:"/help/docs/model-as-a-service/nova/chat/CharacterChat/ChatCompletions"},next:{title:"\u521b\u5efa\u77e5\u8bc6\u5e93",permalink:"/help/docs/model-as-a-service/nova/chat/KnowledgeBases/CreateKnowledgeBase"}},i={},d=[{value:"<strong>\u63a5\u53e3\u63cf\u8ff0\uff08Description\uff09</strong>",id:"\u63a5\u53e3\u63cf\u8ff0description",level:3},{value:"<strong>\u8bf7\u6c42\u5730\u5740\uff08Request URL\uff09</strong>",id:"\u8bf7\u6c42\u5730\u5740request-url",level:3},{value:"<strong>\u8bf7\u6c42\u5934\uff08Request Header\uff09</strong>",id:"\u8bf7\u6c42\u5934request-header",level:3},{value:"<strong>\u8bf7\u6c42\u4f53\uff08Request Body\uff09</strong>",id:"\u8bf7\u6c42\u4f53request-body",level:3},{value:"<strong>\u8bf7\u6c42\u793a\u4f8b\uff08Request Example\uff09</strong>",id:"\u8bf7\u6c42\u793a\u4f8brequest-example",level:3},{value:"<strong>\u54cd\u5e94\uff08Response\uff09</strong>",id:"\u54cd\u5e94response",level:3},{value:"<strong>\u54cd\u5e94\u793a\u4f8b\uff08Response Example\uff09</strong>",id:"\u54cd\u5e94\u793a\u4f8bresponse-example",level:3},{value:"<strong>\u9519\u8bef\u4fe1\u606f</strong>",id:"\u9519\u8bef\u4fe1\u606f",level:3}],p={toc:d},s="wrapper";function m(e){let{components:t,...n}=e;return(0,r.yg)(s,(0,a.A)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.yg)("h1",{id:"\u6587\u672c\u5411\u91cf\u5316"},"\u6587\u672c\u5411\u91cf\u5316"),(0,r.yg)("h3",{id:"\u63a5\u53e3\u63cf\u8ff0description"},(0,r.yg)("strong",{parentName:"h3"},"\u63a5\u53e3\u63cf\u8ff0\uff08Description\uff09")),(0,r.yg)("p",null,"\u57fa\u4e8e\u7ed9\u5b9a\u6587\u672c\uff0c\u63d0\u53d6\u5d4c\u5165\u5f0f\u5411\u91cf\uff0c\u5c06\u6587\u672c\u8f6c\u6362\u4e3a\u5411\u91cf\u5316\u8868\u793a\u3002"),(0,r.yg)("blockquote",null,(0,r.yg)("p",{parentName:"blockquote"},"\u76ee\u524d\u6a21\u578b\u5bf9\u4e2d\u6587\u7684Embedding\u6548\u679c\u8f83\u597d\u3002")),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u8bf7\u6c42\u5730\u5740request-url"},(0,r.yg)("strong",{parentName:"h3"},"\u8bf7\u6c42\u5730\u5740\uff08Request URL\uff09")),(0,r.yg)("pre",null,(0,r.yg)("code",{parentName:"pre"},"[POST] https://api.sensenova.cn/v1/llm/embeddings\n")),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u8bf7\u6c42\u5934request-header"},(0,r.yg)("strong",{parentName:"h3"},"\u8bf7\u6c42\u5934\uff08Request Header\uff09")),(0,r.yg)("p",null,"\u65e0\u7279\u6b8aHeader\uff0c\u8bf7\u53c2\u8003",(0,r.yg)("a",{parentName:"p",href:"/help/docs/model-as-a-service/nova/overview/Authorization"},"\u63a5\u53e3\u9274\u6743")),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u8bf7\u6c42\u4f53request-body"},(0,r.yg)("strong",{parentName:"h3"},"\u8bf7\u6c42\u4f53\uff08Request Body\uff09")),(0,r.yg)("table",null,(0,r.yg)("thead",{parentName:"table"},(0,r.yg)("tr",{parentName:"thead"},(0,r.yg)("th",{parentName:"tr",align:null},"\u540d\u79f0"),(0,r.yg)("th",{parentName:"tr",align:null},"\u7c7b\u578b"),(0,r.yg)("th",{parentName:"tr",align:null},"\u5fc5\u987b"),(0,r.yg)("th",{parentName:"tr",align:null},"\u9ed8\u8ba4\u503c"),(0,r.yg)("th",{parentName:"tr",align:null},"\u53ef\u9009\u503c"),(0,r.yg)("th",{parentName:"tr",align:null},"\u63cf\u8ff0"))),(0,r.yg)("tbody",{parentName:"table"},(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"model"),(0,r.yg)("td",{parentName:"tr",align:null},"string"),(0,r.yg)("td",{parentName:"tr",align:null},"\u662f"),(0,r.yg)("td",{parentName:"tr",align:null},"-"),(0,r.yg)("td",{parentName:"tr",align:null},"-"),(0,r.yg)("td",{parentName:"tr",align:null},"Embedding\u6a21\u578bID\uff0c\u53c2\u8003",(0,r.yg)("a",{parentName:"td",href:"/help/docs/model-as-a-service/nova/model/embedding"},"\u6a21\u578b\u6e05\u5355"))),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"input"),(0,r.yg)("td",{parentName:"tr",align:null},"string[]"),(0,r.yg)("td",{parentName:"tr",align:null},"\u662f"),(0,r.yg)("td",{parentName:"tr",align:null},"-"),(0,r.yg)("td",{parentName:"tr",align:null},"-"),(0,r.yg)("td",{parentName:"tr",align:null},(0,r.yg)("inlineCode",{parentName:"td"},"input"),"\u4e2d\u6700\u591a\u652f\u630132\u6761\uff0c\u6bcf\u6761\u957f\u5ea6\u4e0d\u80fd\u8d85\u8fc7512\u4e2atoken")))),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u8bf7\u6c42\u793a\u4f8brequest-example"},(0,r.yg)("strong",{parentName:"h3"},"\u8bf7\u6c42\u793a\u4f8b\uff08Request Example\uff09")),(0,r.yg)("pre",null,(0,r.yg)("code",{parentName:"pre",className:"language-bash"},'curl --request POST "https://api.sensenova.cn/v1/llm/embeddings" \\\n  -H "Content-Type: application/json" \\\n  -H "Authorization: Bearer $API_TOKEN" \\\n  -d \'{\n        "model": "string",\n        "input": [\n          "string"\n        ]\n  }\'\n')),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u54cd\u5e94response"},(0,r.yg)("strong",{parentName:"h3"},"\u54cd\u5e94\uff08Response\uff09")),(0,r.yg)("table",null,(0,r.yg)("thead",{parentName:"table"},(0,r.yg)("tr",{parentName:"thead"},(0,r.yg)("th",{parentName:"tr",align:null},"\u540d\u79f0"),(0,r.yg)("th",{parentName:"tr",align:null},"\u7c7b\u578b"),(0,r.yg)("th",{parentName:"tr",align:null},"\u63cf\u8ff0"))),(0,r.yg)("tbody",{parentName:"table"},(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"embeddings"),(0,r.yg)("td",{parentName:"tr",align:null},"object[]"),(0,r.yg)("td",{parentName:"tr",align:null},"\u5411\u91cf\u5316\u7ed3\u679c")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"usage"),(0,r.yg)("td",{parentName:"tr",align:null},"object"),(0,r.yg)("td",{parentName:"tr",align:null},"token\u7528\u91cf")))),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},"embeddings")," \u90e8\u5206\u53c2\u6570\u5982\u4e0b\uff1a")),(0,r.yg)("table",null,(0,r.yg)("thead",{parentName:"table"},(0,r.yg)("tr",{parentName:"thead"},(0,r.yg)("th",{parentName:"tr",align:null},"\u540d\u79f0"),(0,r.yg)("th",{parentName:"tr",align:null},"\u7c7b\u578b"),(0,r.yg)("th",{parentName:"tr",align:null},"\u63cf\u8ff0"))),(0,r.yg)("tbody",{parentName:"table"},(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"index"),(0,r.yg)("td",{parentName:"tr",align:null},"int"),(0,r.yg)("td",{parentName:"tr",align:null},"\u5217\u8868\u5e8f\u53f7")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"embedding"),(0,r.yg)("td",{parentName:"tr",align:null},"float[]"),(0,r.yg)("td",{parentName:"tr",align:null},"\u672c\u6761\u5411\u91cf\u7ed3\u679c")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"status_code"),(0,r.yg)("td",{parentName:"tr",align:null},"int"),(0,r.yg)("td",{parentName:"tr",align:null},"\u72b6\u6001\u7801\uff0c\u53c2\u8003",(0,r.yg)("a",{parentName:"td",href:"/help/docs/model-as-a-service/nova/overview/ErrorCode"},"\u9519\u8bef\u7801"))),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"status_message"),(0,r.yg)("td",{parentName:"tr",align:null},"string"),(0,r.yg)("td",{parentName:"tr",align:null},"\u72b6\u6001\u4fe1\u606f")))),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("inlineCode",{parentName:"li"},"usage")," \u90e8\u5206\u53c2\u6570\u5982\u4e0b\uff1a")),(0,r.yg)("table",null,(0,r.yg)("thead",{parentName:"table"},(0,r.yg)("tr",{parentName:"thead"},(0,r.yg)("th",{parentName:"tr",align:null},"\u540d\u79f0"),(0,r.yg)("th",{parentName:"tr",align:null},"\u7c7b\u578b"),(0,r.yg)("th",{parentName:"tr",align:null},"\u63cf\u8ff0"))),(0,r.yg)("tbody",{parentName:"table"},(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"prompt_tokens"),(0,r.yg)("td",{parentName:"tr",align:null},"int"),(0,r.yg)("td",{parentName:"tr",align:null},"\u8f93\u5165token\u6570\uff08\u5982\u679c\u6570\u7ec4\u91cc\u7684\u67d0\u4e00\u6761embedding\u51fa\u9519\uff0c\u4e0d\u8ba1\u5165token\uff09")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},"total_tokens"),(0,r.yg)("td",{parentName:"tr",align:null},"int"),(0,r.yg)("td",{parentName:"tr",align:null},"\u603btoken\u6570")))),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u54cd\u5e94\u793a\u4f8bresponse-example"},(0,r.yg)("strong",{parentName:"h3"},"\u54cd\u5e94\u793a\u4f8b\uff08Response Example\uff09")),(0,r.yg)("pre",null,(0,r.yg)("code",{parentName:"pre",className:"language-json"},'{\n  "embeddings":[\n    {\n      "index": int,\n      "embedding":[\n        float\n      ],\n      "status_code": int,\n      "status_message": "string"\n    }\n  ],\n  "usage":{\n    "prompt_tokens": int,\n    "total_tokens": int\n  }\n}\n')),(0,r.yg)("br",null),(0,r.yg)("h3",{id:"\u9519\u8bef\u4fe1\u606f"},(0,r.yg)("strong",{parentName:"h3"},"\u9519\u8bef\u4fe1\u606f")),(0,r.yg)("p",null,"\u53c2\u8003",(0,r.yg)("a",{parentName:"p",href:"/help/docs/model-as-a-service/nova/overview/ErrorCode"},"\u9519\u8bef\u7801")))}m.isMDXComponent=!0}}]);