@orq-ai/node 3.13.0-rc.8 → 3.14.0-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +19 -9
- package/README.md +199 -131
- package/bin/mcp-server.js +11573 -5844
- package/bin/mcp-server.js.map +88 -74
- package/docs/sdks/agents/README.md +100 -80
- package/docs/sdks/evals/README.md +2 -0
- package/docs/sdks/knowledge/README.md +12 -0
- package/docs/sdks/orq/README.md +0 -81
- package/docs/sdks/tools/README.md +488 -0
- package/examples/contactsCreate.example.ts +42 -0
- package/examples/package-lock.json +1 -1
- package/funcs/{agentsReviewAction.d.ts → toolsCreate.d.ts} +4 -4
- package/funcs/toolsCreate.d.ts.map +1 -0
- package/funcs/{postV2AgentsInternal.js → toolsCreate.js} +14 -10
- package/funcs/toolsCreate.js.map +1 -0
- package/funcs/{postV2AgentsInternal.d.ts → toolsDelete.d.ts} +8 -2
- package/funcs/toolsDelete.d.ts.map +1 -0
- package/funcs/toolsDelete.js +120 -0
- package/funcs/toolsDelete.js.map +1 -0
- package/funcs/toolsDuplicate.d.ts +18 -0
- package/funcs/toolsDuplicate.d.ts.map +1 -0
- package/funcs/toolsDuplicate.js +123 -0
- package/funcs/toolsDuplicate.js.map +1 -0
- package/funcs/toolsList.d.ts +18 -0
- package/funcs/toolsList.d.ts.map +1 -0
- package/funcs/toolsList.js +123 -0
- package/funcs/toolsList.js.map +1 -0
- package/funcs/toolsRetrieve.d.ts +17 -0
- package/funcs/toolsRetrieve.d.ts.map +1 -0
- package/funcs/toolsRetrieve.js +119 -0
- package/funcs/toolsRetrieve.js.map +1 -0
- package/funcs/toolsUpdate.d.ts +18 -0
- package/funcs/toolsUpdate.d.ts.map +1 -0
- package/funcs/{agentsReviewAction.js → toolsUpdate.js} +16 -20
- package/funcs/toolsUpdate.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/url.js +1 -1
- package/lib/url.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +13 -5
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/{postV2AgentsInternal.d.ts → toolsCreate.d.ts} +3 -3
- package/mcp-server/tools/toolsCreate.d.ts.map +1 -0
- package/mcp-server/tools/{agentsReviewAction.js → toolsCreate.js} +9 -9
- package/mcp-server/tools/toolsCreate.js.map +1 -0
- package/mcp-server/tools/toolsDelete.d.ts +8 -0
- package/mcp-server/tools/toolsDelete.d.ts.map +1 -0
- package/mcp-server/tools/{postV2AgentsInternal.js → toolsDelete.js} +10 -8
- package/mcp-server/tools/toolsDelete.js.map +1 -0
- package/mcp-server/tools/toolsDuplicate.d.ts +8 -0
- package/mcp-server/tools/toolsDuplicate.d.ts.map +1 -0
- package/mcp-server/tools/toolsDuplicate.js +64 -0
- package/mcp-server/tools/toolsDuplicate.js.map +1 -0
- package/mcp-server/tools/toolsList.d.ts +8 -0
- package/mcp-server/tools/toolsList.d.ts.map +1 -0
- package/mcp-server/tools/toolsList.js +64 -0
- package/mcp-server/tools/toolsList.js.map +1 -0
- package/mcp-server/tools/toolsRetrieve.d.ts +8 -0
- package/mcp-server/tools/toolsRetrieve.d.ts.map +1 -0
- package/mcp-server/tools/toolsRetrieve.js +64 -0
- package/mcp-server/tools/toolsRetrieve.js.map +1 -0
- package/mcp-server/tools/toolsUpdate.d.ts +8 -0
- package/mcp-server/tools/toolsUpdate.d.ts.map +1 -0
- package/mcp-server/tools/toolsUpdate.js +64 -0
- package/mcp-server/tools/toolsUpdate.js.map +1 -0
- package/models/components/deployments.d.ts +12 -6
- package/models/components/deployments.d.ts.map +1 -1
- package/models/components/deployments.js +4 -2
- package/models/components/deployments.js.map +1 -1
- package/models/errors/duplicatetool.d.ts +48 -0
- package/models/errors/duplicatetool.d.ts.map +1 -0
- package/models/errors/duplicatetool.js +88 -0
- package/models/errors/duplicatetool.js.map +1 -0
- package/models/errors/index.d.ts +3 -0
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +3 -0
- package/models/errors/index.js.map +1 -1
- package/models/errors/updatetool.d.ts +48 -0
- package/models/errors/updatetool.d.ts.map +1 -0
- package/models/errors/updatetool.js +88 -0
- package/models/errors/updatetool.js.map +1 -0
- package/models/operations/createbudget.js +2 -2
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.d.ts +12 -6
- package/models/operations/createdatasetitem.d.ts.map +1 -1
- package/models/operations/createdatasetitem.js +6 -4
- package/models/operations/createdatasetitem.js.map +1 -1
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.d.ts +111 -0
- package/models/operations/createeval.d.ts.map +1 -1
- package/models/operations/createeval.js +134 -40
- package/models/operations/createeval.js.map +1 -1
- package/models/operations/createknowledge.d.ts +10 -0
- package/models/operations/createknowledge.d.ts.map +1 -1
- package/models/operations/createknowledge.js +8 -0
- package/models/operations/createknowledge.js.map +1 -1
- package/models/operations/creatememory.d.ts +13 -4
- package/models/operations/creatememory.d.ts.map +1 -1
- package/models/operations/creatememory.js +4 -4
- package/models/operations/creatememory.js.map +1 -1
- package/models/operations/creatememorydocument.d.ts +9 -6
- package/models/operations/creatememorydocument.d.ts.map +1 -1
- package/models/operations/creatememorydocument.js +4 -4
- package/models/operations/creatememorydocument.js.map +1 -1
- package/models/operations/creatememorystore.d.ts +58 -58
- package/models/operations/creatememorystore.d.ts.map +1 -1
- package/models/operations/creatememorystore.js +130 -136
- package/models/operations/creatememorystore.js.map +1 -1
- package/models/operations/createprompt.d.ts +385 -145
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +433 -200
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/createtool.d.ts +2391 -0
- package/models/operations/createtool.d.ts.map +1 -0
- package/models/operations/createtool.js +2063 -0
- package/models/operations/createtool.js.map +1 -0
- package/models/operations/deletetool.d.ts +29 -0
- package/models/operations/deletetool.d.ts.map +1 -0
- package/models/operations/{postv2agentsinternal.js → deletetool.js} +21 -31
- package/models/operations/deletetool.js.map +1 -0
- package/models/operations/deploymentcreatemetric.d.ts +12 -6
- package/models/operations/deploymentcreatemetric.d.ts.map +1 -1
- package/models/operations/deploymentcreatemetric.js +4 -2
- package/models/operations/deploymentcreatemetric.js.map +1 -1
- package/models/operations/deploymentgetconfig.d.ts +219 -93
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +243 -126
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/deployments.d.ts +192 -72
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +215 -100
- package/models/operations/deployments.js.map +1 -1
- package/models/operations/deploymentstream.d.ts +12 -6
- package/models/operations/deploymentstream.d.ts.map +1 -1
- package/models/operations/deploymentstream.js +4 -2
- package/models/operations/deploymentstream.js.map +1 -1
- package/models/operations/duplicatetool.d.ts +1279 -0
- package/models/operations/duplicatetool.d.ts.map +1 -0
- package/models/operations/duplicatetool.js +1147 -0
- package/models/operations/duplicatetool.js.map +1 -0
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/getagent.d.ts +88 -84
- package/models/operations/getagent.d.ts.map +1 -1
- package/models/operations/getagent.js +114 -111
- package/models/operations/getagent.js.map +1 -1
- package/models/operations/getallmemories.d.ts +5 -2
- package/models/operations/getallmemories.d.ts.map +1 -1
- package/models/operations/getallmemories.js +2 -2
- package/models/operations/getallmemories.js.map +1 -1
- package/models/operations/getallmemorydocuments.d.ts +5 -2
- package/models/operations/getallmemorydocuments.d.ts.map +1 -1
- package/models/operations/getallmemorydocuments.js +2 -2
- package/models/operations/getallmemorydocuments.js.map +1 -1
- package/models/operations/getallprompts.d.ts +192 -72
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +215 -99
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getalltools.d.ts +1340 -0
- package/models/operations/getalltools.d.ts.map +1 -0
- package/models/operations/getalltools.js +1229 -0
- package/models/operations/getalltools.js.map +1 -0
- package/models/operations/getbudget.js +2 -2
- package/models/operations/getevals.js +28 -28
- package/models/operations/getoneknowledge.d.ts +5 -0
- package/models/operations/getoneknowledge.d.ts.map +1 -1
- package/models/operations/getoneknowledge.js +4 -0
- package/models/operations/getoneknowledge.js.map +1 -1
- package/models/operations/getoneprompt.d.ts +192 -72
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +214 -99
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/getpromptversion.d.ts +192 -72
- package/models/operations/getpromptversion.d.ts.map +1 -1
- package/models/operations/getpromptversion.js +214 -100
- package/models/operations/getpromptversion.js.map +1 -1
- package/models/operations/index.d.ts +6 -2
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +6 -2
- package/models/operations/index.js.map +1 -1
- package/models/operations/listagents.d.ts +73 -69
- package/models/operations/listagents.d.ts.map +1 -1
- package/models/operations/listagents.js +99 -95
- package/models/operations/listagents.js.map +1 -1
- package/models/operations/listbudgets.js +2 -2
- package/models/operations/listchunks.d.ts +13 -13
- package/models/operations/listchunks.d.ts.map +1 -1
- package/models/operations/listchunks.js +16 -16
- package/models/operations/listchunks.js.map +1 -1
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.d.ts +6 -3
- package/models/operations/listdatasetdatapoints.d.ts.map +1 -1
- package/models/operations/listdatasetdatapoints.js +4 -3
- package/models/operations/listdatasetdatapoints.js.map +1 -1
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.d.ts +13 -13
- package/models/operations/listdatasources.d.ts.map +1 -1
- package/models/operations/listdatasources.js +19 -18
- package/models/operations/listdatasources.js.map +1 -1
- package/models/operations/listknowledgebases.d.ts +5 -0
- package/models/operations/listknowledgebases.d.ts.map +1 -1
- package/models/operations/listknowledgebases.js +4 -0
- package/models/operations/listknowledgebases.js.map +1 -1
- package/models/operations/listpromptversions.d.ts +192 -72
- package/models/operations/listpromptversions.d.ts.map +1 -1
- package/models/operations/listpromptversions.js +214 -99
- package/models/operations/listpromptversions.js.map +1 -1
- package/models/operations/parse.d.ts +10 -208
- package/models/operations/parse.d.ts.map +1 -1
- package/models/operations/parse.js +15 -180
- package/models/operations/parse.js.map +1 -1
- package/models/operations/retrieveaction.d.ts +8 -8
- package/models/operations/retrieveaction.d.ts.map +1 -1
- package/models/operations/retrieveaction.js +14 -13
- package/models/operations/retrieveaction.js.map +1 -1
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.d.ts +6 -3
- package/models/operations/retrievedatapoint.d.ts.map +1 -1
- package/models/operations/retrievedatapoint.js +4 -3
- package/models/operations/retrievedatapoint.js.map +1 -1
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/retrievememory.d.ts +5 -2
- package/models/operations/retrievememory.d.ts.map +1 -1
- package/models/operations/retrievememory.js +2 -2
- package/models/operations/retrievememory.js.map +1 -1
- package/models/operations/retrievememorydocument.d.ts +5 -2
- package/models/operations/retrievememorydocument.d.ts.map +1 -1
- package/models/operations/retrievememorydocument.js +2 -2
- package/models/operations/retrievememorydocument.js.map +1 -1
- package/models/operations/retrievetool.d.ts +1276 -0
- package/models/operations/retrievetool.d.ts.map +1 -0
- package/models/operations/retrievetool.js +1154 -0
- package/models/operations/retrievetool.js.map +1 -0
- package/models/operations/runagent.d.ts +958 -585
- package/models/operations/runagent.d.ts.map +1 -1
- package/models/operations/runagent.js +1066 -786
- package/models/operations/runagent.js.map +1 -1
- package/models/operations/searchknowledge.d.ts +17 -246
- package/models/operations/searchknowledge.d.ts.map +1 -1
- package/models/operations/searchknowledge.js +16 -167
- package/models/operations/searchknowledge.js.map +1 -1
- package/models/operations/streamrunagent.d.ts +1027 -654
- package/models/operations/streamrunagent.d.ts.map +1 -1
- package/models/operations/streamrunagent.js +1193 -892
- package/models/operations/streamrunagent.js.map +1 -1
- package/models/operations/updatebudget.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updatedatapoint.d.ts +12 -6
- package/models/operations/updatedatapoint.d.ts.map +1 -1
- package/models/operations/updatedatapoint.js +6 -4
- package/models/operations/updatedatapoint.js.map +1 -1
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.d.ts +111 -0
- package/models/operations/updateeval.d.ts.map +1 -1
- package/models/operations/updateeval.js +139 -40
- package/models/operations/updateeval.js.map +1 -1
- package/models/operations/updateknowledge.d.ts +10 -0
- package/models/operations/updateknowledge.d.ts.map +1 -1
- package/models/operations/updateknowledge.js +8 -0
- package/models/operations/updateknowledge.js.map +1 -1
- package/models/operations/updatememory.d.ts +13 -4
- package/models/operations/updatememory.d.ts.map +1 -1
- package/models/operations/updatememory.js +4 -4
- package/models/operations/updatememory.js.map +1 -1
- package/models/operations/updatememorydocument.d.ts +9 -6
- package/models/operations/updatememorydocument.d.ts.map +1 -1
- package/models/operations/updatememorydocument.js +4 -4
- package/models/operations/updatememorydocument.js.map +1 -1
- package/models/operations/updatememorystore.d.ts +58 -58
- package/models/operations/updatememorystore.d.ts.map +1 -1
- package/models/operations/updatememorystore.js +136 -128
- package/models/operations/updatememorystore.js.map +1 -1
- package/models/operations/updateprompt.d.ts +384 -144
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +423 -193
- package/models/operations/updateprompt.js.map +1 -1
- package/models/operations/updatetool.d.ts +2396 -0
- package/models/operations/updatetool.d.ts.map +1 -0
- package/models/operations/updatetool.js +2108 -0
- package/models/operations/updatetool.js.map +1 -0
- package/package.json +1 -1
- package/sdk/agents.d.ts +0 -7
- package/sdk/agents.d.ts.map +1 -1
- package/sdk/agents.js +0 -10
- package/sdk/agents.js.map +1 -1
- package/sdk/sdk.d.ts +4 -3
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +3 -4
- package/sdk/sdk.js.map +1 -1
- package/sdk/tools.d.ts +47 -0
- package/sdk/tools.d.ts.map +1 -0
- package/sdk/tools.js +72 -0
- package/sdk/tools.js.map +1 -0
- package/src/funcs/{postV2AgentsInternal.ts → toolsCreate.ts} +17 -13
- package/src/funcs/toolsDelete.ts +167 -0
- package/src/funcs/toolsDuplicate.ts +175 -0
- package/src/funcs/toolsList.ts +176 -0
- package/src/funcs/toolsRetrieve.ts +166 -0
- package/src/funcs/{agentsReviewAction.ts → toolsUpdate.ts} +25 -26
- package/src/lib/config.ts +3 -3
- package/src/lib/url.ts +1 -1
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +13 -5
- package/src/mcp-server/tools/{agentsReviewAction.ts → toolsCreate.ts} +7 -7
- package/src/mcp-server/tools/{postV2AgentsInternal.ts → toolsDelete.ts} +8 -6
- package/src/mcp-server/tools/toolsDuplicate.ts +37 -0
- package/src/mcp-server/tools/toolsList.ts +37 -0
- package/src/mcp-server/tools/toolsRetrieve.ts +37 -0
- package/src/mcp-server/tools/toolsUpdate.ts +37 -0
- package/src/models/components/deployments.ts +8 -6
- package/src/models/errors/duplicatetool.ts +91 -0
- package/src/models/errors/index.ts +3 -0
- package/src/models/errors/updatetool.ts +91 -0
- package/src/models/operations/createbudget.ts +2 -2
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +10 -8
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +166 -28
- package/src/models/operations/createknowledge.ts +18 -0
- package/src/models/operations/creatememory.ts +17 -8
- package/src/models/operations/creatememorydocument.ts +13 -10
- package/src/models/operations/creatememorystore.ts +138 -136
- package/src/models/operations/createprompt.ts +667 -344
- package/src/models/operations/createtool.ts +4001 -0
- package/src/models/operations/deletetool.ts +75 -0
- package/src/models/operations/deploymentcreatemetric.ts +8 -6
- package/src/models/operations/deploymentgetconfig.ts +390 -230
- package/src/models/operations/deployments.ts +330 -160
- package/src/models/operations/deploymentstream.ts +8 -6
- package/src/models/operations/duplicatetool.ts +2311 -0
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/getagent.ts +253 -176
- package/src/models/operations/getallmemories.ts +7 -4
- package/src/models/operations/getallmemorydocuments.ts +7 -4
- package/src/models/operations/getallprompts.ts +334 -168
- package/src/models/operations/getalltools.ts +2278 -0
- package/src/models/operations/getbudget.ts +2 -2
- package/src/models/operations/getevals.ts +28 -28
- package/src/models/operations/getoneknowledge.ts +9 -0
- package/src/models/operations/getoneprompt.ts +330 -167
- package/src/models/operations/getpromptversion.ts +338 -168
- package/src/models/operations/index.ts +6 -2
- package/src/models/operations/listagents.ts +213 -159
- package/src/models/operations/listbudgets.ts +2 -2
- package/src/models/operations/listchunks.ts +21 -21
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +6 -5
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +22 -29
- package/src/models/operations/listknowledgebases.ts +9 -0
- package/src/models/operations/listpromptversions.ts +355 -183
- package/src/models/operations/parse.ts +20 -335
- package/src/models/operations/retrieveaction.ts +14 -16
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +6 -5
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/retrievememory.ts +7 -4
- package/src/models/operations/retrievememorydocument.ts +7 -4
- package/src/models/operations/retrievetool.ts +2303 -0
- package/src/models/operations/runagent.ts +2216 -1266
- package/src/models/operations/searchknowledge.ts +29 -259
- package/src/models/operations/streamrunagent.ts +2477 -1373
- package/src/models/operations/updatebudget.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +10 -8
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +180 -28
- package/src/models/operations/updateknowledge.ts +18 -0
- package/src/models/operations/updatememory.ts +17 -8
- package/src/models/operations/updatememorydocument.ts +13 -10
- package/src/models/operations/updatememorystore.ts +136 -168
- package/src/models/operations/updateprompt.ts +670 -335
- package/src/models/operations/updatetool.ts +4205 -0
- package/src/sdk/agents.ts +0 -18
- package/src/sdk/sdk.ts +5 -13
- package/src/sdk/tools.ts +117 -0
- package/examples/postV2AgentsInternal.example.ts +0 -30
- package/funcs/agentsReviewAction.d.ts.map +0 -1
- package/funcs/agentsReviewAction.js.map +0 -1
- package/funcs/postV2AgentsInternal.d.ts.map +0 -1
- package/funcs/postV2AgentsInternal.js.map +0 -1
- package/mcp-server/tools/agentsReviewAction.d.ts +0 -8
- package/mcp-server/tools/agentsReviewAction.d.ts.map +0 -1
- package/mcp-server/tools/agentsReviewAction.js.map +0 -1
- package/mcp-server/tools/postV2AgentsInternal.d.ts.map +0 -1
- package/mcp-server/tools/postV2AgentsInternal.js.map +0 -1
- package/models/operations/postv2agentsinternal.d.ts +0 -45
- package/models/operations/postv2agentsinternal.d.ts.map +0 -1
- package/models/operations/postv2agentsinternal.js.map +0 -1
- package/models/operations/reviewaction.d.ts +0 -124
- package/models/operations/reviewaction.d.ts.map +0 -1
- package/models/operations/reviewaction.js +0 -178
- package/models/operations/reviewaction.js.map +0 -1
- package/src/models/operations/postv2agentsinternal.ts +0 -103
- package/src/models/operations/reviewaction.ts +0 -258
package/FUNCTIONS.md
CHANGED
|
@@ -20,7 +20,7 @@ specific category of applications.
|
|
|
20
20
|
|
|
21
21
|
```typescript
|
|
22
22
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
23
|
-
import {
|
|
23
|
+
import { contactsCreate } from "@orq-ai/node/funcs/contactsCreate.js";
|
|
24
24
|
|
|
25
25
|
// Use `OrqCore` for best tree-shaking performance.
|
|
26
26
|
// You can create one instance of it to use across an application.
|
|
@@ -29,18 +29,28 @@ const orq = new OrqCore({
|
|
|
29
29
|
});
|
|
30
30
|
|
|
31
31
|
async function run() {
|
|
32
|
-
const res = await
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
32
|
+
const res = await contactsCreate(orq, {
|
|
33
|
+
externalId: "user_12345",
|
|
34
|
+
displayName: "Jane Smith",
|
|
35
|
+
email: "jane.smith@example.com",
|
|
36
|
+
avatarUrl: "https://example.com/avatars/jane-smith.jpg",
|
|
37
|
+
tags: [
|
|
38
|
+
"premium",
|
|
39
|
+
"beta-user",
|
|
40
|
+
"enterprise",
|
|
41
|
+
],
|
|
42
|
+
metadata: {
|
|
43
|
+
"department": "Engineering",
|
|
44
|
+
"role": "Senior Developer",
|
|
45
|
+
"subscription_tier": "premium",
|
|
46
|
+
"last_login": "2024-01-15T10:30:00Z",
|
|
47
|
+
},
|
|
38
48
|
});
|
|
39
49
|
if (res.ok) {
|
|
40
50
|
const { value: result } = res;
|
|
41
|
-
|
|
51
|
+
console.log(result);
|
|
42
52
|
} else {
|
|
43
|
-
console.log("
|
|
53
|
+
console.log("contactsCreate failed:", res.error);
|
|
44
54
|
}
|
|
45
55
|
}
|
|
46
56
|
|
package/README.md
CHANGED
|
@@ -66,10 +66,7 @@ bun add @orq-ai/node
|
|
|
66
66
|
### Yarn
|
|
67
67
|
|
|
68
68
|
```bash
|
|
69
|
-
yarn add @orq-ai/node
|
|
70
|
-
|
|
71
|
-
# Note that Yarn does not install peer dependencies automatically. You will need
|
|
72
|
-
# to install zod as shown above.
|
|
69
|
+
yarn add @orq-ai/node
|
|
73
70
|
```
|
|
74
71
|
|
|
75
72
|
|
|
@@ -181,13 +178,25 @@ const orq = new Orq({
|
|
|
181
178
|
});
|
|
182
179
|
|
|
183
180
|
async function run() {
|
|
184
|
-
await orq.
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
181
|
+
const result = await orq.contacts.create({
|
|
182
|
+
externalId: "user_12345",
|
|
183
|
+
displayName: "Jane Smith",
|
|
184
|
+
email: "jane.smith@example.com",
|
|
185
|
+
avatarUrl: "https://example.com/avatars/jane-smith.jpg",
|
|
186
|
+
tags: [
|
|
187
|
+
"premium",
|
|
188
|
+
"beta-user",
|
|
189
|
+
"enterprise",
|
|
190
|
+
],
|
|
191
|
+
metadata: {
|
|
192
|
+
"department": "Engineering",
|
|
193
|
+
"role": "Senior Developer",
|
|
194
|
+
"subscription_tier": "premium",
|
|
195
|
+
"last_login": "2024-01-15T10:30:00Z",
|
|
196
|
+
},
|
|
190
197
|
});
|
|
198
|
+
|
|
199
|
+
console.log(result);
|
|
191
200
|
}
|
|
192
201
|
|
|
193
202
|
run();
|
|
@@ -215,13 +224,25 @@ const orq = new Orq({
|
|
|
215
224
|
});
|
|
216
225
|
|
|
217
226
|
async function run() {
|
|
218
|
-
await orq.
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
227
|
+
const result = await orq.contacts.create({
|
|
228
|
+
externalId: "user_12345",
|
|
229
|
+
displayName: "Jane Smith",
|
|
230
|
+
email: "jane.smith@example.com",
|
|
231
|
+
avatarUrl: "https://example.com/avatars/jane-smith.jpg",
|
|
232
|
+
tags: [
|
|
233
|
+
"premium",
|
|
234
|
+
"beta-user",
|
|
235
|
+
"enterprise",
|
|
236
|
+
],
|
|
237
|
+
metadata: {
|
|
238
|
+
"department": "Engineering",
|
|
239
|
+
"role": "Senior Developer",
|
|
240
|
+
"subscription_tier": "premium",
|
|
241
|
+
"last_login": "2024-01-15T10:30:00Z",
|
|
242
|
+
},
|
|
224
243
|
});
|
|
244
|
+
|
|
245
|
+
console.log(result);
|
|
225
246
|
}
|
|
226
247
|
|
|
227
248
|
run();
|
|
@@ -244,7 +265,6 @@ run();
|
|
|
244
265
|
* [streamRun](docs/sdks/agents/README.md#streamrun) - Run and stream agent execution
|
|
245
266
|
* [listActions](docs/sdks/agents/README.md#listactions) - List all actions
|
|
246
267
|
* [retrieveAction](docs/sdks/agents/README.md#retrieveaction) - Retrieve an action executed by an agent task.
|
|
247
|
-
* [reviewAction](docs/sdks/agents/README.md#reviewaction) - Review a tool execution
|
|
248
268
|
|
|
249
269
|
### [budgets](docs/sdks/budgets/README.md)
|
|
250
270
|
|
|
@@ -388,9 +408,6 @@ run();
|
|
|
388
408
|
|
|
389
409
|
* [list](docs/sdks/models/README.md#list) - List models
|
|
390
410
|
|
|
391
|
-
### [Orq SDK](docs/sdks/orq/README.md)
|
|
392
|
-
|
|
393
|
-
* [postV2AgentsInternal](docs/sdks/orq/README.md#postv2agentsinternal)
|
|
394
411
|
|
|
395
412
|
### [prompts](docs/sdks/prompts/README.md)
|
|
396
413
|
|
|
@@ -406,6 +423,15 @@ run();
|
|
|
406
423
|
|
|
407
424
|
* [retrieve](docs/sdks/remoteconfigs/README.md#retrieve) - Retrieve a remote config
|
|
408
425
|
|
|
426
|
+
### [tools](docs/sdks/tools/README.md)
|
|
427
|
+
|
|
428
|
+
* [list](docs/sdks/tools/README.md#list) - List tools
|
|
429
|
+
* [create](docs/sdks/tools/README.md#create) - Create tool
|
|
430
|
+
* [update](docs/sdks/tools/README.md#update) - Update tool
|
|
431
|
+
* [delete](docs/sdks/tools/README.md#delete) - Delete tool
|
|
432
|
+
* [retrieve](docs/sdks/tools/README.md#retrieve) - Retrieve tool
|
|
433
|
+
* [duplicate](docs/sdks/tools/README.md#duplicate) - Duplicate tool
|
|
434
|
+
|
|
409
435
|
</details>
|
|
410
436
|
<!-- End Available Resources and Operations [operations] -->
|
|
411
437
|
|
|
@@ -429,7 +455,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
429
455
|
- [`agentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Get an agent
|
|
430
456
|
- [`agentsRetrieveAction`](docs/sdks/agents/README.md#retrieveaction) - Retrieve an action executed by an agent task.
|
|
431
457
|
- [`agentsRetrieveTask`](docs/sdks/agents/README.md#retrievetask) - Retrieve a specific agent task
|
|
432
|
-
- [`agentsReviewAction`](docs/sdks/agents/README.md#reviewaction) - Review a tool execution
|
|
433
458
|
- [`agentsRun`](docs/sdks/agents/README.md#run) - Run an agent
|
|
434
459
|
- [`agentsStreamRun`](docs/sdks/agents/README.md#streamrun) - Run and stream agent execution
|
|
435
460
|
- [`budgetsCreate`](docs/sdks/budgets/README.md#create) - Create budget configuration
|
|
@@ -538,7 +563,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
538
563
|
- [`memoryStoresUpdateDocument`](docs/sdks/memorystores/README.md#updatedocument) - Update a specific memory document
|
|
539
564
|
- [`memoryStoresUpdateMemory`](docs/sdks/memorystores/README.md#updatememory) - Update a specific memory
|
|
540
565
|
- [`modelsList`](docs/sdks/models/README.md#list) - List models
|
|
541
|
-
- [`postV2AgentsInternal`](docs/sdks/orq/README.md#postv2agentsinternal)
|
|
542
566
|
- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a prompt
|
|
543
567
|
- [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete a prompt
|
|
544
568
|
- [`promptsGetVersion`](docs/sdks/prompts/README.md#getversion) - Retrieve a prompt version
|
|
@@ -547,6 +571,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
547
571
|
- [`promptsRetrieve`](docs/sdks/prompts/README.md#retrieve) - Retrieve a prompt
|
|
548
572
|
- [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update a prompt
|
|
549
573
|
- [`remoteconfigsRetrieve`](docs/sdks/remoteconfigs/README.md#retrieve) - Retrieve a remote config
|
|
574
|
+
- [`toolsCreate`](docs/sdks/tools/README.md#create) - Create tool
|
|
575
|
+
- [`toolsDelete`](docs/sdks/tools/README.md#delete) - Delete tool
|
|
576
|
+
- [`toolsDuplicate`](docs/sdks/tools/README.md#duplicate) - Duplicate tool
|
|
577
|
+
- [`toolsList`](docs/sdks/tools/README.md#list) - List tools
|
|
578
|
+
- [`toolsRetrieve`](docs/sdks/tools/README.md#retrieve) - Retrieve tool
|
|
579
|
+
- [`toolsUpdate`](docs/sdks/tools/README.md#update) - Update tool
|
|
550
580
|
|
|
551
581
|
</details>
|
|
552
582
|
<!-- End Standalone functions [standalone-funcs] -->
|
|
@@ -636,12 +666,22 @@ const orq = new Orq({
|
|
|
636
666
|
});
|
|
637
667
|
|
|
638
668
|
async function run() {
|
|
639
|
-
await orq.
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
669
|
+
const result = await orq.contacts.create({
|
|
670
|
+
externalId: "user_12345",
|
|
671
|
+
displayName: "Jane Smith",
|
|
672
|
+
email: "jane.smith@example.com",
|
|
673
|
+
avatarUrl: "https://example.com/avatars/jane-smith.jpg",
|
|
674
|
+
tags: [
|
|
675
|
+
"premium",
|
|
676
|
+
"beta-user",
|
|
677
|
+
"enterprise",
|
|
678
|
+
],
|
|
679
|
+
metadata: {
|
|
680
|
+
"department": "Engineering",
|
|
681
|
+
"role": "Senior Developer",
|
|
682
|
+
"subscription_tier": "premium",
|
|
683
|
+
"last_login": "2024-01-15T10:30:00Z",
|
|
684
|
+
},
|
|
645
685
|
}, {
|
|
646
686
|
retries: {
|
|
647
687
|
strategy: "backoff",
|
|
@@ -654,6 +694,8 @@ async function run() {
|
|
|
654
694
|
retryConnectionErrors: false,
|
|
655
695
|
},
|
|
656
696
|
});
|
|
697
|
+
|
|
698
|
+
console.log(result);
|
|
657
699
|
}
|
|
658
700
|
|
|
659
701
|
run();
|
|
@@ -679,13 +721,25 @@ const orq = new Orq({
|
|
|
679
721
|
});
|
|
680
722
|
|
|
681
723
|
async function run() {
|
|
682
|
-
await orq.
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
724
|
+
const result = await orq.contacts.create({
|
|
725
|
+
externalId: "user_12345",
|
|
726
|
+
displayName: "Jane Smith",
|
|
727
|
+
email: "jane.smith@example.com",
|
|
728
|
+
avatarUrl: "https://example.com/avatars/jane-smith.jpg",
|
|
729
|
+
tags: [
|
|
730
|
+
"premium",
|
|
731
|
+
"beta-user",
|
|
732
|
+
"enterprise",
|
|
733
|
+
],
|
|
734
|
+
metadata: {
|
|
735
|
+
"department": "Engineering",
|
|
736
|
+
"role": "Senior Developer",
|
|
737
|
+
"subscription_tier": "premium",
|
|
738
|
+
"last_login": "2024-01-15T10:30:00Z",
|
|
739
|
+
},
|
|
688
740
|
});
|
|
741
|
+
|
|
742
|
+
console.log(result);
|
|
689
743
|
}
|
|
690
744
|
|
|
691
745
|
run();
|
|
@@ -747,7 +801,7 @@ run();
|
|
|
747
801
|
**Primary error:**
|
|
748
802
|
* [`OrqError`](./src/models/errors/orqerror.ts): The base class for HTTP error responses.
|
|
749
803
|
|
|
750
|
-
<details><summary>Less common errors (
|
|
804
|
+
<details><summary>Less common errors (97)</summary>
|
|
751
805
|
|
|
752
806
|
<br />
|
|
753
807
|
|
|
@@ -760,95 +814,97 @@ run();
|
|
|
760
814
|
|
|
761
815
|
|
|
762
816
|
**Inherit from [`OrqError`](./src/models/errors/orqerror.ts)**:
|
|
763
|
-
* [`HonoApiError`](./src/models/errors/honoapierror.ts): Applicable to
|
|
764
|
-
* [`RetrieveContactResponseBody`](./src/models/errors/retrievecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of
|
|
765
|
-
* [`UpdateContactResponseBody`](./src/models/errors/updatecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of
|
|
766
|
-
* [`DeleteContactResponseBody`](./src/models/errors/deletecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of
|
|
767
|
-
* [`GetAgentResponseBody`](./src/models/errors/getagentresponsebody.ts): Agent not found. Status code `404`. Applicable to 1 of
|
|
768
|
-
* [`GetAgentTaskResponseBody`](./src/models/errors/getagenttaskresponsebody.ts): Agent task not found. Status code `404`. Applicable to 1 of
|
|
769
|
-
* [`StreamRunAgentResponseBody`](./src/models/errors/streamrunagentresponsebody.ts): Model not found. Status code `404`. Applicable to 1 of
|
|
770
|
-
* [`UpdatePromptResponseBody`](./src/models/errors/updatepromptresponsebody.ts): Prompt not found. Status code `404`. Applicable to 1 of
|
|
771
|
-
* [`GetPromptVersionResponseBody`](./src/models/errors/getpromptversionresponsebody.ts): Not Found - The prompt or prompt version does not exist. Status code `404`. Applicable to 1 of
|
|
772
|
-
* [`GetEvalsResponseBody`](./src/models/errors/getevalsresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of
|
|
773
|
-
* [`CreateEvalResponseBody`](./src/models/errors/createevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of
|
|
774
|
-
* [`UpdateEvalResponseBody`](./src/models/errors/updateevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of
|
|
775
|
-
* [`DeleteEvalResponseBody`](./src/models/errors/deleteevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of
|
|
776
|
-
* [`EvalsBertScoreResponseBody`](./src/models/errors/evalsbertscoreresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
777
|
-
* [`EvalsBleuScoreResponseBody`](./src/models/errors/evalsbleuscoreresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
778
|
-
* [`EvalsContainsAllResponseBody`](./src/models/errors/evalscontainsallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
779
|
-
* [`EvalsContainsAnyResponseBody`](./src/models/errors/evalscontainsanyresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
780
|
-
* [`EvalsContainsEmailResponseBody`](./src/models/errors/evalscontainsemailresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
781
|
-
* [`EvalsContainsNoneResponseBody`](./src/models/errors/evalscontainsnoneresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
782
|
-
* [`EvalsContainsUrlResponseBody`](./src/models/errors/evalscontainsurlresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
783
|
-
* [`EvalsContainsValidLinkResponseBody`](./src/models/errors/evalscontainsvalidlinkresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
784
|
-
* [`EvalsContainsResponseBody`](./src/models/errors/evalscontainsresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
785
|
-
* [`EvalsEndsWithResponseBody`](./src/models/errors/evalsendswithresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
786
|
-
* [`EvalsExactMatchResponseBody`](./src/models/errors/evalsexactmatchresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
787
|
-
* [`EvalsLengthBetweenResponseBody`](./src/models/errors/evalslengthbetweenresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
788
|
-
* [`EvalsLengthGreaterThanResponseBody`](./src/models/errors/evalslengthgreaterthanresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
789
|
-
* [`EvalsLengthLessThanResponseBody`](./src/models/errors/evalslengthlessthanresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
790
|
-
* [`EvalsValidJsonResponseBody`](./src/models/errors/evalsvalidjsonresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
791
|
-
* [`EvalsAgeAppropriateResponseBody`](./src/models/errors/evalsageappropriateresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
792
|
-
* [`EvalsBotDetectionResponseBody`](./src/models/errors/evalsbotdetectionresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
793
|
-
* [`EvalsFactCheckingKnowledgeBaseResponseBody`](./src/models/errors/evalsfactcheckingknowledgebaseresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
794
|
-
* [`EvalsGrammarResponseBody`](./src/models/errors/evalsgrammarresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
795
|
-
* [`EvalsLocalizationResponseBody`](./src/models/errors/evalslocalizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
796
|
-
* [`EvalsPiiResponseBody`](./src/models/errors/evalspiiresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
797
|
-
* [`EvalsSentimentClassificationResponseBody`](./src/models/errors/evalssentimentclassificationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
798
|
-
* [`EvalsSummarizationResponseBody`](./src/models/errors/evalssummarizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
799
|
-
* [`EvalsToneOfVoiceResponseBody`](./src/models/errors/evalstoneofvoiceresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
800
|
-
* [`EvalsTranslationResponseBody`](./src/models/errors/evalstranslationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
801
|
-
* [`EvalsRagasCoherenceResponseBody`](./src/models/errors/evalsragascoherenceresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
802
|
-
* [`EvalsRagasConcisenessResponseBody`](./src/models/errors/evalsragasconcisenessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
803
|
-
* [`EvalsRagasContextPrecisionResponseBody`](./src/models/errors/evalsragascontextprecisionresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
804
|
-
* [`EvalsRagasContextRecallResponseBody`](./src/models/errors/evalsragascontextrecallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
805
|
-
* [`EvalsRagasContextEntitiesRecallResponseBody`](./src/models/errors/evalsragascontextentitiesrecallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
806
|
-
* [`EvalsRagasCorrectnessResponseBody`](./src/models/errors/evalsragascorrectnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
807
|
-
* [`EvalsRagasFaithfulnessResponseBody`](./src/models/errors/evalsragasfaithfulnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
808
|
-
* [`EvalsRagasHarmfulnessResponseBody`](./src/models/errors/evalsragasharmfulnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
809
|
-
* [`EvalsRagasMaliciousnessResponseBody`](./src/models/errors/evalsragasmaliciousnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
810
|
-
* [`EvalsRagasNoiseSensitivityResponseBody`](./src/models/errors/evalsragasnoisesensitivityresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
811
|
-
* [`EvalsRagasResponseRelevancyResponseBody`](./src/models/errors/evalsragasresponserelevancyresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
812
|
-
* [`EvalsRagasSummarizationResponseBody`](./src/models/errors/evalsragassummarizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
813
|
-
* [`InvokeEvalResponseBody`](./src/models/errors/invokeevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of
|
|
814
|
-
* [`
|
|
815
|
-
* [`
|
|
816
|
-
* [`
|
|
817
|
-
* [`
|
|
818
|
-
* [`
|
|
819
|
-
* [`
|
|
820
|
-
* [`
|
|
821
|
-
* [`
|
|
822
|
-
* [`
|
|
823
|
-
* [`
|
|
824
|
-
* [`
|
|
825
|
-
* [`
|
|
826
|
-
* [`
|
|
827
|
-
* [`
|
|
828
|
-
* [`
|
|
829
|
-
* [`
|
|
830
|
-
* [`
|
|
831
|
-
* [`
|
|
832
|
-
* [`
|
|
833
|
-
* [`
|
|
834
|
-
* [`
|
|
835
|
-
* [`
|
|
836
|
-
* [`
|
|
837
|
-
* [`
|
|
838
|
-
* [`
|
|
839
|
-
* [`
|
|
840
|
-
* [`
|
|
841
|
-
* [`
|
|
842
|
-
* [`
|
|
843
|
-
* [`
|
|
844
|
-
* [`
|
|
845
|
-
* [`
|
|
846
|
-
* [`
|
|
847
|
-
* [`
|
|
848
|
-
* [`
|
|
849
|
-
* [`
|
|
850
|
-
* [`
|
|
851
|
-
* [`
|
|
817
|
+
* [`HonoApiError`](./src/models/errors/honoapierror.ts): Applicable to 10 of 127 methods.*
|
|
818
|
+
* [`RetrieveContactResponseBody`](./src/models/errors/retrievecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
819
|
+
* [`UpdateContactResponseBody`](./src/models/errors/updatecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
820
|
+
* [`DeleteContactResponseBody`](./src/models/errors/deletecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
821
|
+
* [`GetAgentResponseBody`](./src/models/errors/getagentresponsebody.ts): Agent not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
822
|
+
* [`GetAgentTaskResponseBody`](./src/models/errors/getagenttaskresponsebody.ts): Agent task not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
823
|
+
* [`StreamRunAgentResponseBody`](./src/models/errors/streamrunagentresponsebody.ts): Model not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
824
|
+
* [`UpdatePromptResponseBody`](./src/models/errors/updatepromptresponsebody.ts): Prompt not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
825
|
+
* [`GetPromptVersionResponseBody`](./src/models/errors/getpromptversionresponsebody.ts): Not Found - The prompt or prompt version does not exist. Status code `404`. Applicable to 1 of 127 methods.*
|
|
826
|
+
* [`GetEvalsResponseBody`](./src/models/errors/getevalsresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 127 methods.*
|
|
827
|
+
* [`CreateEvalResponseBody`](./src/models/errors/createevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 127 methods.*
|
|
828
|
+
* [`UpdateEvalResponseBody`](./src/models/errors/updateevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 127 methods.*
|
|
829
|
+
* [`DeleteEvalResponseBody`](./src/models/errors/deleteevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 127 methods.*
|
|
830
|
+
* [`EvalsBertScoreResponseBody`](./src/models/errors/evalsbertscoreresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
831
|
+
* [`EvalsBleuScoreResponseBody`](./src/models/errors/evalsbleuscoreresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
832
|
+
* [`EvalsContainsAllResponseBody`](./src/models/errors/evalscontainsallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
833
|
+
* [`EvalsContainsAnyResponseBody`](./src/models/errors/evalscontainsanyresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
834
|
+
* [`EvalsContainsEmailResponseBody`](./src/models/errors/evalscontainsemailresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
835
|
+
* [`EvalsContainsNoneResponseBody`](./src/models/errors/evalscontainsnoneresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
836
|
+
* [`EvalsContainsUrlResponseBody`](./src/models/errors/evalscontainsurlresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
837
|
+
* [`EvalsContainsValidLinkResponseBody`](./src/models/errors/evalscontainsvalidlinkresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
838
|
+
* [`EvalsContainsResponseBody`](./src/models/errors/evalscontainsresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
839
|
+
* [`EvalsEndsWithResponseBody`](./src/models/errors/evalsendswithresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
840
|
+
* [`EvalsExactMatchResponseBody`](./src/models/errors/evalsexactmatchresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
841
|
+
* [`EvalsLengthBetweenResponseBody`](./src/models/errors/evalslengthbetweenresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
842
|
+
* [`EvalsLengthGreaterThanResponseBody`](./src/models/errors/evalslengthgreaterthanresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
843
|
+
* [`EvalsLengthLessThanResponseBody`](./src/models/errors/evalslengthlessthanresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
844
|
+
* [`EvalsValidJsonResponseBody`](./src/models/errors/evalsvalidjsonresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
845
|
+
* [`EvalsAgeAppropriateResponseBody`](./src/models/errors/evalsageappropriateresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
846
|
+
* [`EvalsBotDetectionResponseBody`](./src/models/errors/evalsbotdetectionresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
847
|
+
* [`EvalsFactCheckingKnowledgeBaseResponseBody`](./src/models/errors/evalsfactcheckingknowledgebaseresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
848
|
+
* [`EvalsGrammarResponseBody`](./src/models/errors/evalsgrammarresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
849
|
+
* [`EvalsLocalizationResponseBody`](./src/models/errors/evalslocalizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
850
|
+
* [`EvalsPiiResponseBody`](./src/models/errors/evalspiiresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
851
|
+
* [`EvalsSentimentClassificationResponseBody`](./src/models/errors/evalssentimentclassificationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
852
|
+
* [`EvalsSummarizationResponseBody`](./src/models/errors/evalssummarizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
853
|
+
* [`EvalsToneOfVoiceResponseBody`](./src/models/errors/evalstoneofvoiceresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
854
|
+
* [`EvalsTranslationResponseBody`](./src/models/errors/evalstranslationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
855
|
+
* [`EvalsRagasCoherenceResponseBody`](./src/models/errors/evalsragascoherenceresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
856
|
+
* [`EvalsRagasConcisenessResponseBody`](./src/models/errors/evalsragasconcisenessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
857
|
+
* [`EvalsRagasContextPrecisionResponseBody`](./src/models/errors/evalsragascontextprecisionresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
858
|
+
* [`EvalsRagasContextRecallResponseBody`](./src/models/errors/evalsragascontextrecallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
859
|
+
* [`EvalsRagasContextEntitiesRecallResponseBody`](./src/models/errors/evalsragascontextentitiesrecallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
860
|
+
* [`EvalsRagasCorrectnessResponseBody`](./src/models/errors/evalsragascorrectnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
861
|
+
* [`EvalsRagasFaithfulnessResponseBody`](./src/models/errors/evalsragasfaithfulnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
862
|
+
* [`EvalsRagasHarmfulnessResponseBody`](./src/models/errors/evalsragasharmfulnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
863
|
+
* [`EvalsRagasMaliciousnessResponseBody`](./src/models/errors/evalsragasmaliciousnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
864
|
+
* [`EvalsRagasNoiseSensitivityResponseBody`](./src/models/errors/evalsragasnoisesensitivityresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
865
|
+
* [`EvalsRagasResponseRelevancyResponseBody`](./src/models/errors/evalsragasresponserelevancyresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
866
|
+
* [`EvalsRagasSummarizationResponseBody`](./src/models/errors/evalsragassummarizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
867
|
+
* [`InvokeEvalResponseBody`](./src/models/errors/invokeevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 127 methods.*
|
|
868
|
+
* [`UpdateToolResponseBody`](./src/models/errors/updatetoolresponsebody.ts): Tool not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
869
|
+
* [`DuplicateToolResponseBody`](./src/models/errors/duplicatetoolresponsebody.ts): Tool not found. Status code `404`. Applicable to 1 of 127 methods.*
|
|
870
|
+
* [`EvalsBertScoreEvalsResponseBody`](./src/models/errors/evalsbertscoreevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
871
|
+
* [`EvalsBleuScoreEvalsResponseBody`](./src/models/errors/evalsbleuscoreevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
872
|
+
* [`EvalsContainsAllEvalsResponseBody`](./src/models/errors/evalscontainsallevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
873
|
+
* [`EvalsContainsAnyEvalsResponseBody`](./src/models/errors/evalscontainsanyevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
874
|
+
* [`EvalsContainsEmailEvalsResponseBody`](./src/models/errors/evalscontainsemailevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
875
|
+
* [`EvalsContainsNoneEvalsResponseBody`](./src/models/errors/evalscontainsnoneevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
876
|
+
* [`EvalsContainsUrlEvalsResponseBody`](./src/models/errors/evalscontainsurlevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
877
|
+
* [`EvalsContainsValidLinkEvalsResponseBody`](./src/models/errors/evalscontainsvalidlinkevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
878
|
+
* [`EvalsContainsEvalsResponseBody`](./src/models/errors/evalscontainsevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
879
|
+
* [`EvalsEndsWithEvalsResponseBody`](./src/models/errors/evalsendswithevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
880
|
+
* [`EvalsExactMatchEvalsResponseBody`](./src/models/errors/evalsexactmatchevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
881
|
+
* [`EvalsLengthBetweenEvalsResponseBody`](./src/models/errors/evalslengthbetweenevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
882
|
+
* [`EvalsLengthGreaterThanEvalsResponseBody`](./src/models/errors/evalslengthgreaterthanevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
883
|
+
* [`EvalsLengthLessThanEvalsResponseBody`](./src/models/errors/evalslengthlessthanevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
884
|
+
* [`EvalsValidJsonEvalsResponseBody`](./src/models/errors/evalsvalidjsonevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
885
|
+
* [`EvalsAgeAppropriateEvalsResponseBody`](./src/models/errors/evalsageappropriateevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
886
|
+
* [`EvalsBotDetectionEvalsResponseBody`](./src/models/errors/evalsbotdetectionevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
887
|
+
* [`EvalsFactCheckingKnowledgeBaseEvalsResponseBody`](./src/models/errors/evalsfactcheckingknowledgebaseevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
888
|
+
* [`EvalsGrammarEvalsResponseBody`](./src/models/errors/evalsgrammarevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
889
|
+
* [`EvalsLocalizationEvalsResponseBody`](./src/models/errors/evalslocalizationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
890
|
+
* [`EvalsPiiEvalsResponseBody`](./src/models/errors/evalspiievalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
891
|
+
* [`EvalsSentimentClassificationEvalsResponseBody`](./src/models/errors/evalssentimentclassificationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
892
|
+
* [`EvalsSummarizationEvalsResponseBody`](./src/models/errors/evalssummarizationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
893
|
+
* [`EvalsToneOfVoiceEvalsResponseBody`](./src/models/errors/evalstoneofvoiceevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
894
|
+
* [`EvalsTranslationEvalsResponseBody`](./src/models/errors/evalstranslationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
895
|
+
* [`EvalsRagasCoherenceEvalsResponseBody`](./src/models/errors/evalsragascoherenceevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
896
|
+
* [`EvalsRagasConcisenessEvalsResponseBody`](./src/models/errors/evalsragasconcisenessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
897
|
+
* [`EvalsRagasContextPrecisionEvalsResponseBody`](./src/models/errors/evalsragascontextprecisionevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
898
|
+
* [`EvalsRagasContextRecallEvalsResponseBody`](./src/models/errors/evalsragascontextrecallevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
899
|
+
* [`EvalsRagasContextEntitiesRecallEvalsResponseBody`](./src/models/errors/evalsragascontextentitiesrecallevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
900
|
+
* [`EvalsRagasCorrectnessEvalsResponseBody`](./src/models/errors/evalsragascorrectnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
901
|
+
* [`EvalsRagasFaithfulnessEvalsResponseBody`](./src/models/errors/evalsragasfaithfulnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
902
|
+
* [`EvalsRagasHarmfulnessEvalsResponseBody`](./src/models/errors/evalsragasharmfulnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
903
|
+
* [`EvalsRagasMaliciousnessEvalsResponseBody`](./src/models/errors/evalsragasmaliciousnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
904
|
+
* [`EvalsRagasNoiseSensitivityEvalsResponseBody`](./src/models/errors/evalsragasnoisesensitivityevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
905
|
+
* [`EvalsRagasResponseRelevancyEvalsResponseBody`](./src/models/errors/evalsragasresponserelevancyevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
906
|
+
* [`EvalsRagasSummarizationEvalsResponseBody`](./src/models/errors/evalsragassummarizationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 127 methods.*
|
|
907
|
+
* [`InvokeEvalEvalsResponseBody`](./src/models/errors/invokeevalevalsresponsebody.ts): Error running the evaluator. Status code `500`. Applicable to 1 of 127 methods.*
|
|
852
908
|
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
|
853
909
|
|
|
854
910
|
</details>
|
|
@@ -871,13 +927,25 @@ const orq = new Orq({
|
|
|
871
927
|
});
|
|
872
928
|
|
|
873
929
|
async function run() {
|
|
874
|
-
await orq.
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
930
|
+
const result = await orq.contacts.create({
|
|
931
|
+
externalId: "user_12345",
|
|
932
|
+
displayName: "Jane Smith",
|
|
933
|
+
email: "jane.smith@example.com",
|
|
934
|
+
avatarUrl: "https://example.com/avatars/jane-smith.jpg",
|
|
935
|
+
tags: [
|
|
936
|
+
"premium",
|
|
937
|
+
"beta-user",
|
|
938
|
+
"enterprise",
|
|
939
|
+
],
|
|
940
|
+
metadata: {
|
|
941
|
+
"department": "Engineering",
|
|
942
|
+
"role": "Senior Developer",
|
|
943
|
+
"subscription_tier": "premium",
|
|
944
|
+
"last_login": "2024-01-15T10:30:00Z",
|
|
945
|
+
},
|
|
880
946
|
});
|
|
947
|
+
|
|
948
|
+
console.log(result);
|
|
881
949
|
}
|
|
882
950
|
|
|
883
951
|
run();
|
|
@@ -930,7 +998,7 @@ httpClient.addHook("requestError", (error, request) => {
|
|
|
930
998
|
console.groupEnd();
|
|
931
999
|
});
|
|
932
1000
|
|
|
933
|
-
const sdk = new Orq({ httpClient });
|
|
1001
|
+
const sdk = new Orq({ httpClient: httpClient });
|
|
934
1002
|
```
|
|
935
1003
|
<!-- End Custom HTTP Client [http-client] -->
|
|
936
1004
|
|