https://openassistant-doc.vercel.app/assets/js/de7cf6f0.b27af76c.js

1"use strict";(self.webpackChunk_openassistant_website=self.webpackChunk_openassistant_website||[]).push([[498],{28453:(e,s,o)=>{o.d(s,{R:()=>c,x:()=>i});var n=o(96540);const t={},d=n.createContext(t);function c(e){const s=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(d.Provider,{value:s},e.children)}},68260:(e,s,o)=>{o.r(s),o.d(s,{assets:()=>r,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"osm/functions/registerTools","title":"Function: registerTools()","description":"registerTools(): object","source":"@site/docs/osm/functions/registerTools.md","sourceDirName":"osm/functions","slug":"/osm/functions/registerTools","permalink":"/docs/osm/functions/registerTools","draft":false,"unlisted":false,"editUrl":"https://github.com/geodaopenjs/openassistant/tree/main/website/docs/docs/osm/functions/registerTools.md","tags":[],"version":"current","frontMatter":{}}');var t=o(74848),d=o(28453);const c={},i="Function: registerTools()",r={},l=[{value:"Returns",id:"returns",level:2},{value:"geocoding",id:"geocoding",level:3},{value:"getUsCountyGeojson",id:"getuscountygeojson",level:3},{value:"getUsStateGeojson",id:"getusstategeojson",level:3},{value:"getUsZipcodeGeojson",id:"getuszipcodegeojson",level:3},{value:"isochrone",id:"isochrone",level:3},{value:"queryUSZipcodes",id:"queryuszipcodes",level:3},{value:"roads",id:"roads",level:3},{value:"routing",id:"routing",level:3}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"function-registertools",children:"Function: registerTools()"})}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"registerTools"}),"(): ",(0,t.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsxs)(s.p,{children:["Defined in: ",(0,t.jsx)(s.a,{href:"https://github.com/geodaopenjs/openassistant/blob/0a6a7e7306d75a25dc968b3117f04cb7bd613bec/packages/tools/osm/src/register-tools.ts#L49",children:"packages/tools/osm/src/register-tools.ts:49"})]}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"object"})}),"\n",(0,t.jsx)(s.h3,{id:"geocoding",children:"geocoding"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"geocoding"}),": ",(0,t.jsx)(s.code,{children:"ExtendedTool"}),"<",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GeocodingFunctionArgs",children:(0,t.jsx)(s.code,{children:"GeocodingFunctionArgs"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GeocodingLlmResult",children:(0,t.jsx)(s.code,{children:"GeocodingLlmResult"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GeocodingAdditionalData",children:(0,t.jsx)(s.code,{children:"GeocodingAdditionalData"})}),", ",(0,t.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"getuscountygeojson",children:"getUsCountyGeojson"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"getUsCountyGeojson"}),": ",(0,t.jsx)(s.code,{children:"ExtendedTool"}),"<",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GetUsCountyGeojsonFunctionArgs",children:(0,t.jsx)(s.code,{children:"GetUsCountyGeojsonFunctionArgs"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GetUsCountyGeojsonLlmResult",children:(0,t.jsx)(s.code,{children:"GetUsCountyGeojsonLlmResult"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GetUsCountyGeojsonAdditionalData",children:(0,t.jsx)(s.code,{children:"GetUsCountyGeojsonAdditionalData"})}),", ",(0,t.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"getusstategeojson",children:"getUsStateGeojson"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"getUsStateGeojson"}),": ",(0,t.jsx)(s.code,{children:"ExtendedTool"}),"<",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GetUsStateGeojsonFunctionArgs",children:(0,t.jsx)(s.code,{children:"GetUsStateGeojsonFunctionArgs"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GetUsStateGeojsonLlmResult",children:(0,t.jsx)(s.code,{children:"GetUsStateGeojsonLlmResult"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GetUsStateGeojsonAdditionalData",children:(0,t.jsx)(s.code,{children:"GetUsStateGeojsonAdditionalData"})}),", ",(0,t.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"getuszipcodegeojson",children:"getUsZipcodeGeojson"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"getUsZipcodeGeojson"}),": ",(0,t.jsx)(s.code,{children:"ExtendedTool"}),"<",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GetUsZipcodeGeojsonFunctionArgs",children:(0,t.jsx)(s.code,{children:"GetUsZipcodeGeojsonFunctionArgs"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GetUsZipcodeGeojsonLlmResult",children:(0,t.jsx)(s.code,{children:"GetUsZipcodeGeojsonLlmResult"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/GetUsZipcodeGeojsonAdditionalData",children:(0,t.jsx)(s.code,{children:"GetUsZipcodeGeojsonAdditionalData"})}),", ",(0,t.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"isochrone",children:"isochrone"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"isochrone"}),": ",(0,t.jsx)(s.code,{children:"ExtendedTool"}),"<",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/IsochroneFunctionArgs",children:(0,t.jsx)(s.code,{children:"IsochroneFunctionArgs"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/IsochroneLlmResult",children:(0,t.jsx)(s.code,{children:"IsochroneLlmResult"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/IsochroneAdditionalData",children:(0,t.jsx)(s.code,{children:"IsochroneAdditionalData"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/MapboxToolContext",children:(0,t.jsx)(s.code,{children:"MapboxToolContext"})}),">"]}),"\n"]}

1),"\n",(0,t.jsx)(s.h3,{id:"queryuszipcodes",children:"queryUSZipcodes"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"queryUSZipcodes"}),": ",(0,t.jsx)(s.code,{children:"ExtendedTool"}),"<",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/QueryZipcodeFunctionArgs",children:(0,t.jsx)(s.code,{children:"QueryZipcodeFunctionArgs"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/QueryZipcodeLlmResult",children:(0,t.jsx)(s.code,{children:"QueryZipcodeLlmResult"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/QueryZipcodeAdditionalData",children:(0,t.jsx)(s.code,{children:"QueryZipcodeAdditionalData"})}),", ",(0,t.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"roads",children:"roads"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"roads"}),": ",(0,t.jsx)(s.code,{children:"ExtendedTool"}),"<",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/RoadsFunctionArgs",children:(0,t.jsx)(s.code,{children:"RoadsFunctionArgs"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/RoadsLlmResult",children:(0,t.jsx)(s.code,{children:"RoadsLlmResult"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/RoadsAdditionalData",children:(0,t.jsx)(s.code,{children:"RoadsAdditionalData"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/OsmToolContext",children:(0,t.jsx)(s.code,{children:"OsmToolContext"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.h3,{id:"routing",children:"routing"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"routing"}),": ",(0,t.jsx)(s.code,{children:"ExtendedTool"}),"<",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/RoutingFunctionArgs",children:(0,t.jsx)(s.code,{children:"RoutingFunctionArgs"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/RoutingLlmResult",children:(0,t.jsx)(s.code,{children:"RoutingLlmResult"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/RoutingAdditionalData",children:(0,t.jsx)(s.code,{children:"RoutingAdditionalData"})}),", ",(0,t.jsx)(s.a,{href:"/docs/osm/type-aliases/MapboxToolContext",children:(0,t.jsx)(s.code,{children:"MapboxToolContext"})}),">"]}),"\n"]})]})}function h(e={}){const{wrapper:s}={...(0,d.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}}}]);