1"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5364],{50612:(e,t,i)=>{i.r(t),i.d(t,{contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var n=i(74848),s=i(28453);const r={},o="event",l={type:"api",id:"event",title:"event",description:"",slug:"/event",frontMatter:{},api:{tags:["v1"],operationId:"event",requestBody:{content:{"application/json":{schema:{type:"object",required:["type","completion_id","choice_index"],properties:{type:{type:"string",description:"Event type, should be `view`, `select` or `dismiss`.",example:"view"},completion_id:{type:"string"},choice_index:{type:"integer",format:"int32",minimum:0},view_id:{type:"string",nullable:!0},elapsed:{type:"integer",format:"int32",nullable:!0,minimum:0}}}}},required:!0},responses:{200:{description:"Success"},400:{description:"Bad Request"}},security:[{token:[]}],description:"event",method:"post",path:"/v1/events",parameters:[],servers:[{url:"https://playground.app.tabbyml.com",description:"Playground server"}],securitySchemes:{token:{type:"http",scheme:"bearer",bearerFormat:"token"}},jsonRequestBodyExample:{type:"view",completion_id:"string",choice_index:0,view_id:"string",elapsed:0},info:{title:"Tabby Server",description:"\n[](https://github.com/TabbyML/tabby)\n[](https://links.tabbyml.com/join-slack)\n\nInstall following IDE / Editor extensions to get started with [Tabby](https://github.com/TabbyML/tabby).\n* [VSCode Extension](https://github.com/TabbyML/tabby/tree/main/clients/vscode) \u2013 Install from the [marketplace](https://marketplace.visualstudio.com/items?itemName=TabbyML.vscode-tabby), or [open-vsx.org](https://open-vsx.org/extension/TabbyML/vscode-tabby)\n* [VIM Extension](https://github.com/TabbyML/tabby/tree/main/clients/vim)\n* [IntelliJ Platform Plugin](https://github.com/TabbyML/tabby/tree/main/clients/intellij) \u2013 Install from the [marketplace](https://plugins.jetbrains.com/plugin/22379-tabby)\n",contact:{name:"TabbyML Team"},license:{name:"Apache 2.0",url:"https://github.com/TabbyML/tabby/blob/main/LICENSE"},version:"0.17.0"},postman:{name:"event",description:{type:"text/plain"},url:{path:["v1","events"],host:["{{baseUrl}}"],query:[],variable:[]},header:[{key:"Content-Type",value:"application/json"}],method:"POST",body:{mode:"raw",raw:'{\n "type": "<string>",\n "completion_id": "<string>",\n "choice_index": "<integer>",\n "view_id": "<string>",\n "elapsed": "<integer>"\n}'},auth:{type:"bearer",bearer:[{type:"any",value:"<Bearer Token>",key:"token"}]}}},source:"@site/static/openapi.json",sourceDirName:".",permalink:"/api/event",previous:{title:"completion",permalink:"/api/completion"},next:{title:"health",permalink:"/api/health"}},c=[];function a(e){const t={code:"code",h1:"h1",p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"event",children:"event"}),"\n",(0,n.jsx)(t.p,{children:"event"}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsxs)("th",{style:{textAlign:"left"},children:[(0,n.jsx)("span",{children:"Request Body "}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{})]})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"type"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,n.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,n.jsxs)(t.p,{children:["Event type, should be ",(0,n.jsx)(t.code,{children:"view"}),", ",(0,n.jsx)(t.code,{children:"select"})," or ",(0,n.jsx)(t.code,{children:"dismiss"}),"."]})})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"completion_id"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"choice_index"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" int32"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,n.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"view_id"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" string"})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsx)("code",{children:"elapsed"}),(0,n.jsx)("span",{style:{opacity:"0.6"},children:" int32"})]})})]})]}),"\n",(0,n.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,n.jsx)("thead",{children:(0,n.jsx)("tr",{children:(0,n.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,n.jsxs)("tbody",{children:[(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"200"})}),(0,n.jsx)("div",{children:(0,n.jsx)(t.p,{children:"Success"})})]}),(0,n.jsx)("div",{})]})}),(0,n.jsx)("tr",{children:(0,n.jsxs)("td",{children:[(0,n.jsxs)("div",{style:{display:"flex"},children:[(0,n.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,n.jsx)("code",{children:"400"})}),(0,n.jsx)("div",{children:(0,n.jsx)(t.p,{children:"Bad Request"})})]}),(0,n.jsx)("div",{})]})})]})]})]})}function d(e){void 0===e&&(e={});const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28453:(e,t,i)=>{i.d(t,{R:()=>o,x:()=>l});var n=i(96540);const s={},r=n.createContext(s);function o(e){const t=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.