@orq-ai/node 4.0.2 → 4.1.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/bin/mcp-server.js +214 -217
- package/bin/mcp-server.js.map +39 -39
- package/docs/sdks/agents/README.md +8 -4
- package/docs/sdks/budgets/README.md +4 -2
- package/docs/sdks/tools/README.md +2 -2
- package/examples/package-lock.json +4 -7
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/lib/config.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/mcp-server.js.map +1 -1
- package/mcp-server/server.js +1 -1
- package/mcp-server/server.js.map +1 -1
- 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.js +8 -8
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.js +28 -28
- package/models/operations/createtool.js +12 -12
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/getalltools.js +12 -12
- package/models/operations/getbudget.js +2 -2
- package/models/operations/getevals.js +28 -28
- package/models/operations/listbudgets.js +2 -2
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.js +8 -8
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.js +8 -8
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/retrievetool.js +12 -12
- package/models/operations/runagent.js +2 -2
- package/models/operations/streamrunagent.js +2 -2
- package/models/operations/updatebudget.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updatedatapoint.js +8 -8
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.js +28 -28
- package/models/operations/updatetool.js +14 -14
- package/package.json +4 -3
- package/src/lib/config.ts +2 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- 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 +8 -8
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +28 -28
- package/src/models/operations/createtool.ts +12 -12
- 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/getalltools.ts +12 -12
- package/src/models/operations/getbudget.ts +2 -2
- package/src/models/operations/getevals.ts +28 -28
- package/src/models/operations/listbudgets.ts +2 -2
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +8 -8
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +8 -8
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/retrievetool.ts +12 -12
- package/src/models/operations/runagent.ts +2 -2
- package/src/models/operations/streamrunagent.ts +2 -2
- package/src/models/operations/updatebudget.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +8 -8
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +28 -28
- package/src/models/operations/updatetool.ts +14 -14
- package/packages/orq-rc/FUNCTIONS.md +0 -103
- package/packages/orq-rc/README.md +0 -910
- package/packages/orq-rc/RUNTIMES.md +0 -48
- package/packages/orq-rc/docs/sdks/agents/README.md +0 -1363
- package/packages/orq-rc/docs/sdks/budgets/README.md +0 -401
- package/packages/orq-rc/docs/sdks/chunking/README.md +0 -97
- package/packages/orq-rc/docs/sdks/contacts/README.md +0 -450
- package/packages/orq-rc/docs/sdks/datasets/README.md +0 -836
- package/packages/orq-rc/docs/sdks/deployments/README.md +0 -312
- package/packages/orq-rc/docs/sdks/evals/README.md +0 -339
- package/packages/orq-rc/docs/sdks/feedback/README.md +0 -89
- package/packages/orq-rc/docs/sdks/files/README.md +0 -301
- package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1487
- package/packages/orq-rc/docs/sdks/memorystores/README.md +0 -1171
- package/packages/orq-rc/docs/sdks/metrics/README.md +0 -83
- package/packages/orq-rc/docs/sdks/models/README.md +0 -76
- package/packages/orq-rc/docs/sdks/prompts/README.md +0 -591
- package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -77
- package/packages/orq-rc/docs/sdks/responses/README.md +0 -139
- package/packages/orq-rc/docs/sdks/tools/README.md +0 -420
- package/packages/orq-rc/examples/README.md +0 -31
- package/packages/orq-rc/examples/contactsCreate.example.ts +0 -42
- package/packages/orq-rc/examples/package-lock.json +0 -619
- package/packages/orq-rc/examples/package.json +0 -18
- package/packages/orq-rc/jsr.json +0 -28
- package/packages/orq-rc/package-lock.json +0 -3047
- package/packages/orq-rc/package.json +0 -40
- package/packages/orq-rc/src/core.ts +0 -13
- package/packages/orq-rc/src/funcs/agentsCreate.ts +0 -172
- package/packages/orq-rc/src/funcs/agentsDelete.ts +0 -176
- package/packages/orq-rc/src/funcs/agentsInvoke.ts +0 -167
- package/packages/orq-rc/src/funcs/agentsList.ts +0 -167
- package/packages/orq-rc/src/funcs/agentsListActions.ts +0 -169
- package/packages/orq-rc/src/funcs/agentsListTasks.ts +0 -183
- package/packages/orq-rc/src/funcs/agentsResponsesCreate.ts +0 -168
- package/packages/orq-rc/src/funcs/agentsRetrieve.ts +0 -175
- package/packages/orq-rc/src/funcs/agentsRetrieveAction.ts +0 -173
- package/packages/orq-rc/src/funcs/agentsRetrieveTask.ts +0 -179
- package/packages/orq-rc/src/funcs/agentsRun.ts +0 -163
- package/packages/orq-rc/src/funcs/agentsStream.ts +0 -191
- package/packages/orq-rc/src/funcs/agentsStreamRun.ts +0 -189
- package/packages/orq-rc/src/funcs/agentsUpdate.ts +0 -176
- package/packages/orq-rc/src/funcs/budgetsCreate.ts +0 -160
- package/packages/orq-rc/src/funcs/budgetsDelete.ts +0 -167
- package/packages/orq-rc/src/funcs/budgetsGet.ts +0 -166
- package/packages/orq-rc/src/funcs/budgetsList.ts +0 -170
- package/packages/orq-rc/src/funcs/budgetsUpdate.ts +0 -167
- package/packages/orq-rc/src/funcs/chunkingParse.ts +0 -160
- package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -165
- package/packages/orq-rc/src/funcs/contactsDelete.ts +0 -176
- package/packages/orq-rc/src/funcs/contactsList.ts +0 -169
- package/packages/orq-rc/src/funcs/contactsRetrieve.ts +0 -175
- package/packages/orq-rc/src/funcs/contactsUpdate.ts +0 -176
- package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -167
- package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -165
- package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -171
- package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -167
- package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -182
- package/packages/orq-rc/src/funcs/datasetsList.ts +0 -167
- package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -174
- package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -175
- package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -181
- package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -176
- package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -179
- package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -168
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -176
- package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -176
- package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -168
- package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -183
- package/packages/orq-rc/src/funcs/evalsAll.ts +0 -173
- package/packages/orq-rc/src/funcs/evalsCreate.ts +0 -169
- package/packages/orq-rc/src/funcs/evalsDelete.ts +0 -173
- package/packages/orq-rc/src/funcs/evalsUpdate.ts +0 -173
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -160
- package/packages/orq-rc/src/funcs/filesCreate.ts +0 -187
- package/packages/orq-rc/src/funcs/filesDelete.ts +0 -164
- package/packages/orq-rc/src/funcs/filesGet.ts +0 -166
- package/packages/orq-rc/src/funcs/filesList.ts +0 -167
- package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -158
- package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -171
- package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -166
- package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -167
- package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -174
- package/packages/orq-rc/src/funcs/knowledgeDeleteChunks.ts +0 -170
- package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -173
- package/packages/orq-rc/src/funcs/knowledgeGetChunksCount.ts +0 -170
- package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -169
- package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -178
- package/packages/orq-rc/src/funcs/knowledgeListChunksPaginated.ts +0 -171
- package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -174
- package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -166
- package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -173
- package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -169
- package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -167
- package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -164
- package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -174
- package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -170
- package/packages/orq-rc/src/funcs/memoryStoresCreate.ts +0 -162
- package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts +0 -175
- package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts +0 -170
- package/packages/orq-rc/src/funcs/memoryStoresDelete.ts +0 -168
- package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts +0 -184
- package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts +0 -179
- package/packages/orq-rc/src/funcs/memoryStoresList.ts +0 -178
- package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts +0 -181
- package/packages/orq-rc/src/funcs/memoryStoresListMemories.ts +0 -176
- package/packages/orq-rc/src/funcs/memoryStoresRetrieve.ts +0 -177
- package/packages/orq-rc/src/funcs/memoryStoresRetrieveDocument.ts +0 -178
- package/packages/orq-rc/src/funcs/memoryStoresRetrieveMemory.ts +0 -173
- package/packages/orq-rc/src/funcs/memoryStoresUpdate.ts +0 -168
- package/packages/orq-rc/src/funcs/memoryStoresUpdateDocument.ts +0 -179
- package/packages/orq-rc/src/funcs/memoryStoresUpdateMemory.ts +0 -174
- package/packages/orq-rc/src/funcs/modelsList.ts +0 -142
- package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -160
- package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -164
- package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -181
- package/packages/orq-rc/src/funcs/promptsList.ts +0 -167
- package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -173
- package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -166
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -173
- package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -161
- package/packages/orq-rc/src/funcs/toolsCreate.ts +0 -172
- package/packages/orq-rc/src/funcs/toolsDelete.ts +0 -167
- package/packages/orq-rc/src/funcs/toolsList.ts +0 -176
- package/packages/orq-rc/src/funcs/toolsRetrieve.ts +0 -166
- package/packages/orq-rc/src/funcs/toolsUpdate.ts +0 -176
- package/packages/orq-rc/src/hooks/global.ts +0 -44
- package/packages/orq-rc/src/hooks/hooks.ts +0 -132
- package/packages/orq-rc/src/hooks/index.ts +0 -6
- package/packages/orq-rc/src/hooks/registration.ts +0 -15
- package/packages/orq-rc/src/hooks/types.ts +0 -112
- package/packages/orq-rc/src/index.ts +0 -9
- package/packages/orq-rc/src/lib/base64.ts +0 -37
- package/packages/orq-rc/src/lib/config.ts +0 -74
- package/packages/orq-rc/src/lib/dlv.ts +0 -53
- package/packages/orq-rc/src/lib/encodings.ts +0 -483
- package/packages/orq-rc/src/lib/env.ts +0 -89
- package/packages/orq-rc/src/lib/event-streams.ts +0 -135
- package/packages/orq-rc/src/lib/files.ts +0 -82
- package/packages/orq-rc/src/lib/http.ts +0 -323
- package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
- package/packages/orq-rc/src/lib/logger.ts +0 -9
- package/packages/orq-rc/src/lib/matchers.ts +0 -345
- package/packages/orq-rc/src/lib/primitives.ts +0 -150
- package/packages/orq-rc/src/lib/retries.ts +0 -218
- package/packages/orq-rc/src/lib/schemas.ts +0 -91
- package/packages/orq-rc/src/lib/sdks.ts +0 -407
- package/packages/orq-rc/src/lib/security.ts +0 -264
- package/packages/orq-rc/src/lib/url.ts +0 -33
- package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -111
- package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -136
- package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
- package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
- package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
- package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
- package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
- package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
- package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
- package/packages/orq-rc/src/mcp-server/server.ts +0 -259
- package/packages/orq-rc/src/mcp-server/shared.ts +0 -74
- package/packages/orq-rc/src/mcp-server/tools/agentsCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsDelete.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/agentsInvoke.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsListActions.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/agentsListTasks.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsResponsesCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsRetrieve.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveAction.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveTask.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsRun.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsStream.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsStreamRun.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsUpdate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/budgetsCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/budgetsDelete.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/budgetsGet.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/budgetsList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/budgetsUpdate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +0 -33
- package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
- package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunks.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeGetChunksCount.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunksPaginated.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateDocument.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateMemory.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresDelete.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteDocument.ts +0 -40
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteMemory.ts +0 -40
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresListDocuments.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresListMemories.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieve.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveDocument.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveMemory.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateDocument.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateMemory.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
- package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
- package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
- package/packages/orq-rc/src/mcp-server/tools/toolsCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/toolsDelete.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/toolsList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/toolsRetrieve.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/toolsUpdate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
- package/packages/orq-rc/src/models/components/index.ts +0 -6
- package/packages/orq-rc/src/models/components/invokedeploymentrequest.ts +0 -6261
- package/packages/orq-rc/src/models/components/security.ts +0 -56
- package/packages/orq-rc/src/models/errors/apierror.ts +0 -40
- package/packages/orq-rc/src/models/errors/createagent.ts +0 -67
- package/packages/orq-rc/src/models/errors/createeval.ts +0 -67
- package/packages/orq-rc/src/models/errors/deleteagent.ts +0 -67
- package/packages/orq-rc/src/models/errors/deletecontact.ts +0 -78
- package/packages/orq-rc/src/models/errors/deleteeval.ts +0 -67
- package/packages/orq-rc/src/models/errors/getagent.ts +0 -67
- package/packages/orq-rc/src/models/errors/getevals.ts +0 -67
- package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -67
- package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -77
- package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
- package/packages/orq-rc/src/models/errors/index.ts +0 -27
- package/packages/orq-rc/src/models/errors/listagenttasks.ts +0 -67
- package/packages/orq-rc/src/models/errors/orqerror.ts +0 -35
- package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +0 -50
- package/packages/orq-rc/src/models/errors/retrievecontact.ts +0 -78
- package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -109
- package/packages/orq-rc/src/models/errors/streamagent.ts +0 -67
- package/packages/orq-rc/src/models/errors/streamrunagent.ts +0 -67
- package/packages/orq-rc/src/models/errors/updateagent.ts +0 -67
- package/packages/orq-rc/src/models/errors/updatecontact.ts +0 -70
- package/packages/orq-rc/src/models/errors/updateeval.ts +0 -67
- package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -67
- package/packages/orq-rc/src/models/errors/updatetool.ts +0 -78
- package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -63
- package/packages/orq-rc/src/models/operations/createagent.ts +0 -8057
- package/packages/orq-rc/src/models/operations/createagentresponse.ts +0 -1339
- package/packages/orq-rc/src/models/operations/createbudget.ts +0 -582
- package/packages/orq-rc/src/models/operations/createchunk.ts +0 -341
- package/packages/orq-rc/src/models/operations/createcontact.ts +0 -237
- package/packages/orq-rc/src/models/operations/createdataset.ts +0 -257
- package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -5379
- package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -694
- package/packages/orq-rc/src/models/operations/createeval.ts +0 -6857
- package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -226
- package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -1489
- package/packages/orq-rc/src/models/operations/creatememory.ts +0 -229
- package/packages/orq-rc/src/models/operations/creatememorydocument.ts +0 -242
- package/packages/orq-rc/src/models/operations/creatememorystore.ts +0 -310
- package/packages/orq-rc/src/models/operations/createprompt.ts +0 -6179
- package/packages/orq-rc/src/models/operations/createtool.ts +0 -3956
- package/packages/orq-rc/src/models/operations/deleteagent.ts +0 -63
- package/packages/orq-rc/src/models/operations/deletebudget.ts +0 -54
- package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -81
- package/packages/orq-rc/src/models/operations/deletechunks.ts +0 -198
- package/packages/orq-rc/src/models/operations/deletecontact.ts +0 -54
- package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -72
- package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -63
- package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -72
- package/packages/orq-rc/src/models/operations/deleteeval.ts +0 -51
- package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -63
- package/packages/orq-rc/src/models/operations/deletememory.ts +0 -72
- package/packages/orq-rc/src/models/operations/deletememorydocument.ts +0 -83
- package/packages/orq-rc/src/models/operations/deletememorystore.ts +0 -63
- package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -54
- package/packages/orq-rc/src/models/operations/deletetool.ts +0 -60
- package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -5091
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -8055
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -980
- package/packages/orq-rc/src/models/operations/deployments.ts +0 -2054
- package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -8269
- package/packages/orq-rc/src/models/operations/filedelete.ts +0 -63
- package/packages/orq-rc/src/models/operations/fileget.ts +0 -181
- package/packages/orq-rc/src/models/operations/filelist.ts +0 -268
- package/packages/orq-rc/src/models/operations/fileupload.ts +0 -258
- package/packages/orq-rc/src/models/operations/getagent.ts +0 -3480
- package/packages/orq-rc/src/models/operations/getagenttask.ts +0 -2389
- package/packages/orq-rc/src/models/operations/getallmemories.ts +0 -261
- package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +0 -280
- package/packages/orq-rc/src/models/operations/getallmemorystores.ts +0 -325
- package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2033
- package/packages/orq-rc/src/models/operations/getalltools.ts +0 -2292
- package/packages/orq-rc/src/models/operations/getbudget.ts +0 -357
- package/packages/orq-rc/src/models/operations/getchunkscount.ts +0 -185
- package/packages/orq-rc/src/models/operations/getevals.ts +0 -5543
- package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -258
- package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -1070
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -1924
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -1942
- package/packages/orq-rc/src/models/operations/index.ts +0 -102
- package/packages/orq-rc/src/models/operations/invokeagent.ts +0 -1930
- package/packages/orq-rc/src/models/operations/listactions.ts +0 -427
- package/packages/orq-rc/src/models/operations/listagents.ts +0 -3626
- package/packages/orq-rc/src/models/operations/listagenttasks.ts +0 -2614
- package/packages/orq-rc/src/models/operations/listbudgets.ts +0 -494
- package/packages/orq-rc/src/models/operations/listchunks.ts +0 -395
- package/packages/orq-rc/src/models/operations/listchunkspaginated.ts +0 -408
- package/packages/orq-rc/src/models/operations/listcontacts.ts +0 -413
- package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -3169
- package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -334
- package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -363
- package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -1068
- package/packages/orq-rc/src/models/operations/listmodels.ts +0 -207
- package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2041
- package/packages/orq-rc/src/models/operations/parse.ts +0 -1013
- package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -146
- package/packages/orq-rc/src/models/operations/retrieveaction.ts +0 -354
- package/packages/orq-rc/src/models/operations/retrievecontact.ts +0 -180
- package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -2985
- package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -246
- package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -231
- package/packages/orq-rc/src/models/operations/retrievememory.ts +0 -171
- package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +0 -189
- package/packages/orq-rc/src/models/operations/retrievememorystore.ts +0 -234
- package/packages/orq-rc/src/models/operations/retrievetool.ts +0 -2347
- package/packages/orq-rc/src/models/operations/runagent.ts +0 -7617
- package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -2775
- package/packages/orq-rc/src/models/operations/streamagent.ts +0 -9732
- package/packages/orq-rc/src/models/operations/streamrunagent.ts +0 -15831
- package/packages/orq-rc/src/models/operations/updateagent.ts +0 -8649
- package/packages/orq-rc/src/models/operations/updatebudget.ts +0 -502
- package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -361
- package/packages/orq-rc/src/models/operations/updatecontact.ts +0 -280
- package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -5374
- package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -326
- package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -288
- package/packages/orq-rc/src/models/operations/updateeval.ts +0 -7197
- package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -1925
- package/packages/orq-rc/src/models/operations/updatememory.ts +0 -238
- package/packages/orq-rc/src/models/operations/updatememorydocument.ts +0 -251
- package/packages/orq-rc/src/models/operations/updatememorystore.ts +0 -463
- package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -6410
- package/packages/orq-rc/src/models/operations/updatetool.ts +0 -4279
- package/packages/orq-rc/src/sdk/agents.ts +0 -244
- package/packages/orq-rc/src/sdk/budgets.ts +0 -99
- package/packages/orq-rc/src/sdk/chunking.ts +0 -27
- package/packages/orq-rc/src/sdk/contacts.ts +0 -99
- package/packages/orq-rc/src/sdk/datasets.ts +0 -204
- package/packages/orq-rc/src/sdk/deployments.ts +0 -89
- package/packages/orq-rc/src/sdk/evals.ts +0 -69
- package/packages/orq-rc/src/sdk/feedback.ts +0 -27
- package/packages/orq-rc/src/sdk/files.ts +0 -78
- package/packages/orq-rc/src/sdk/index.ts +0 -5
- package/packages/orq-rc/src/sdk/knowledge.ts +0 -309
- package/packages/orq-rc/src/sdk/memorystores.ts +0 -286
- package/packages/orq-rc/src/sdk/metrics.ts +0 -27
- package/packages/orq-rc/src/sdk/models.ts +0 -25
- package/packages/orq-rc/src/sdk/prompts.ts +0 -126
- package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
- package/packages/orq-rc/src/sdk/responses.ts +0 -27
- package/packages/orq-rc/src/sdk/sdk.ts +0 -97
- package/packages/orq-rc/src/sdk/tools.ts +0 -99
- package/packages/orq-rc/src/types/async.ts +0 -68
- package/packages/orq-rc/src/types/blobs.ts +0 -32
- package/packages/orq-rc/src/types/constdatetime.ts +0 -15
- package/packages/orq-rc/src/types/enums.ts +0 -45
- package/packages/orq-rc/src/types/fp.ts +0 -50
- package/packages/orq-rc/src/types/index.ts +0 -11
- package/packages/orq-rc/src/types/operations.ts +0 -105
- package/packages/orq-rc/src/types/rfcdate.ts +0 -54
- package/packages/orq-rc/src/types/streams.ts +0 -21
- package/packages/orq-rc/src/types/unrecognized.ts +0 -27
- package/packages/orq-rc/tsconfig.json +0 -41
|
@@ -1,1363 +0,0 @@
|
|
|
1
|
-
# Agents
|
|
2
|
-
(*agents*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [create](#create) - Create a new agent
|
|
9
|
-
* [delete](#delete) - Delete an agent
|
|
10
|
-
* [retrieve](#retrieve) - Get an agent
|
|
11
|
-
* [update](#update) - Update an agent
|
|
12
|
-
* [invoke](#invoke) - Invoke an agent
|
|
13
|
-
* [listTasks](#listtasks) - List all tasks for an agent
|
|
14
|
-
* [retrieveTask](#retrievetask) - Retrieve a specific agent task
|
|
15
|
-
* [list](#list) - List all agents
|
|
16
|
-
* [run](#run) - Run an agent
|
|
17
|
-
* [streamRun](#streamrun) - Run and stream agent execution
|
|
18
|
-
* [stream](#stream) - Stream agent execution events
|
|
19
|
-
* [listActions](#listactions) - List all actions
|
|
20
|
-
* [retrieveAction](#retrieveaction) - Retrieve an action executed by an agent task.
|
|
21
|
-
|
|
22
|
-
## create
|
|
23
|
-
|
|
24
|
-
Creates a new AI agent with specified configuration. Agents can be configured with a primary model and an optional fallback model that will be used automatically if the primary model fails.
|
|
25
|
-
|
|
26
|
-
### Example Usage
|
|
27
|
-
|
|
28
|
-
<!-- UsageSnippet language="typescript" operationID="CreateAgent" method="post" path="/v2/agents" -->
|
|
29
|
-
```typescript
|
|
30
|
-
import { Orq } from "@orq-ai/node";
|
|
31
|
-
|
|
32
|
-
const orq = new Orq({
|
|
33
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
34
|
-
});
|
|
35
|
-
|
|
36
|
-
async function run() {
|
|
37
|
-
const result = await orq.agents.create({
|
|
38
|
-
key: "<key>",
|
|
39
|
-
role: "<value>",
|
|
40
|
-
description: "neatly unless refine aside platter alarmed shampoo shakily yippee",
|
|
41
|
-
instructions: "<value>",
|
|
42
|
-
path: "Default",
|
|
43
|
-
model: "Camaro",
|
|
44
|
-
settings: {
|
|
45
|
-
tools: [
|
|
46
|
-
{
|
|
47
|
-
type: "mcp",
|
|
48
|
-
id: "01KA84ND5J0SWQMA2Q8HY5WZZZ",
|
|
49
|
-
toolId: "01KXYZ123456789",
|
|
50
|
-
requiresApproval: false,
|
|
51
|
-
},
|
|
52
|
-
],
|
|
53
|
-
},
|
|
54
|
-
knowledgeBases: [
|
|
55
|
-
{
|
|
56
|
-
knowledgeId: "customer-knowledge-base",
|
|
57
|
-
},
|
|
58
|
-
],
|
|
59
|
-
});
|
|
60
|
-
|
|
61
|
-
console.log(result);
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
run();
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
### Standalone function
|
|
68
|
-
|
|
69
|
-
The standalone function version of this method:
|
|
70
|
-
|
|
71
|
-
```typescript
|
|
72
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
73
|
-
import { agentsCreate } from "@orq-ai/node/funcs/agentsCreate.js";
|
|
74
|
-
|
|
75
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
76
|
-
// You can create one instance of it to use across an application.
|
|
77
|
-
const orq = new OrqCore({
|
|
78
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
79
|
-
});
|
|
80
|
-
|
|
81
|
-
async function run() {
|
|
82
|
-
const res = await agentsCreate(orq, {
|
|
83
|
-
key: "<key>",
|
|
84
|
-
role: "<value>",
|
|
85
|
-
description: "neatly unless refine aside platter alarmed shampoo shakily yippee",
|
|
86
|
-
instructions: "<value>",
|
|
87
|
-
path: "Default",
|
|
88
|
-
model: "Camaro",
|
|
89
|
-
settings: {
|
|
90
|
-
tools: [
|
|
91
|
-
{
|
|
92
|
-
type: "mcp",
|
|
93
|
-
id: "01KA84ND5J0SWQMA2Q8HY5WZZZ",
|
|
94
|
-
toolId: "01KXYZ123456789",
|
|
95
|
-
requiresApproval: false,
|
|
96
|
-
},
|
|
97
|
-
],
|
|
98
|
-
},
|
|
99
|
-
knowledgeBases: [
|
|
100
|
-
{
|
|
101
|
-
knowledgeId: "customer-knowledge-base",
|
|
102
|
-
},
|
|
103
|
-
],
|
|
104
|
-
});
|
|
105
|
-
if (res.ok) {
|
|
106
|
-
const { value: result } = res;
|
|
107
|
-
console.log(result);
|
|
108
|
-
} else {
|
|
109
|
-
console.log("agentsCreate failed:", res.error);
|
|
110
|
-
}
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
run();
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### Parameters
|
|
117
|
-
|
|
118
|
-
| Parameter | Type | Required | Description |
|
|
119
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
120
|
-
| `request` | [operations.CreateAgentRequestBody](../../models/operations/createagentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
121
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
122
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
123
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
124
|
-
|
|
125
|
-
### Response
|
|
126
|
-
|
|
127
|
-
**Promise\<[operations.CreateAgentResponseBody](../../models/operations/createagentresponsebody.md)\>**
|
|
128
|
-
|
|
129
|
-
### Errors
|
|
130
|
-
|
|
131
|
-
| Error Type | Status Code | Content Type |
|
|
132
|
-
| ------------------------------ | ------------------------------ | ------------------------------ |
|
|
133
|
-
| errors.CreateAgentResponseBody | 409 | application/json |
|
|
134
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
135
|
-
|
|
136
|
-
## delete
|
|
137
|
-
|
|
138
|
-
Permanently deletes an agent and all its configuration, including primary and fallback model settings.
|
|
139
|
-
|
|
140
|
-
### Example Usage
|
|
141
|
-
|
|
142
|
-
<!-- UsageSnippet language="typescript" operationID="DeleteAgent" method="delete" path="/v2/agents/{agent_key}" -->
|
|
143
|
-
```typescript
|
|
144
|
-
import { Orq } from "@orq-ai/node";
|
|
145
|
-
|
|
146
|
-
const orq = new Orq({
|
|
147
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
148
|
-
});
|
|
149
|
-
|
|
150
|
-
async function run() {
|
|
151
|
-
await orq.agents.delete({
|
|
152
|
-
agentKey: "<value>",
|
|
153
|
-
});
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
run();
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
### Standalone function
|
|
162
|
-
|
|
163
|
-
The standalone function version of this method:
|
|
164
|
-
|
|
165
|
-
```typescript
|
|
166
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
167
|
-
import { agentsDelete } from "@orq-ai/node/funcs/agentsDelete.js";
|
|
168
|
-
|
|
169
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
170
|
-
// You can create one instance of it to use across an application.
|
|
171
|
-
const orq = new OrqCore({
|
|
172
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
173
|
-
});
|
|
174
|
-
|
|
175
|
-
async function run() {
|
|
176
|
-
const res = await agentsDelete(orq, {
|
|
177
|
-
agentKey: "<value>",
|
|
178
|
-
});
|
|
179
|
-
if (res.ok) {
|
|
180
|
-
const { value: result } = res;
|
|
181
|
-
|
|
182
|
-
} else {
|
|
183
|
-
console.log("agentsDelete failed:", res.error);
|
|
184
|
-
}
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
run();
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
### Parameters
|
|
191
|
-
|
|
192
|
-
| Parameter | Type | Required | Description |
|
|
193
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
194
|
-
| `request` | [operations.DeleteAgentRequest](../../models/operations/deleteagentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
195
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
196
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
197
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
198
|
-
|
|
199
|
-
### Response
|
|
200
|
-
|
|
201
|
-
**Promise\<void\>**
|
|
202
|
-
|
|
203
|
-
### Errors
|
|
204
|
-
|
|
205
|
-
| Error Type | Status Code | Content Type |
|
|
206
|
-
| ------------------------------ | ------------------------------ | ------------------------------ |
|
|
207
|
-
| errors.DeleteAgentResponseBody | 404 | application/json |
|
|
208
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
209
|
-
|
|
210
|
-
## retrieve
|
|
211
|
-
|
|
212
|
-
Retrieves a single agent by its unique key, including its full configuration with primary and fallback model settings.
|
|
213
|
-
|
|
214
|
-
### Example Usage
|
|
215
|
-
|
|
216
|
-
<!-- UsageSnippet language="typescript" operationID="GetAgent" method="get" path="/v2/agents/{agent_key}" -->
|
|
217
|
-
```typescript
|
|
218
|
-
import { Orq } from "@orq-ai/node";
|
|
219
|
-
|
|
220
|
-
const orq = new Orq({
|
|
221
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
222
|
-
});
|
|
223
|
-
|
|
224
|
-
async function run() {
|
|
225
|
-
const result = await orq.agents.retrieve({
|
|
226
|
-
agentKey: "<value>",
|
|
227
|
-
});
|
|
228
|
-
|
|
229
|
-
console.log(result);
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
run();
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
### Standalone function
|
|
236
|
-
|
|
237
|
-
The standalone function version of this method:
|
|
238
|
-
|
|
239
|
-
```typescript
|
|
240
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
241
|
-
import { agentsRetrieve } from "@orq-ai/node/funcs/agentsRetrieve.js";
|
|
242
|
-
|
|
243
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
244
|
-
// You can create one instance of it to use across an application.
|
|
245
|
-
const orq = new OrqCore({
|
|
246
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
247
|
-
});
|
|
248
|
-
|
|
249
|
-
async function run() {
|
|
250
|
-
const res = await agentsRetrieve(orq, {
|
|
251
|
-
agentKey: "<value>",
|
|
252
|
-
});
|
|
253
|
-
if (res.ok) {
|
|
254
|
-
const { value: result } = res;
|
|
255
|
-
console.log(result);
|
|
256
|
-
} else {
|
|
257
|
-
console.log("agentsRetrieve failed:", res.error);
|
|
258
|
-
}
|
|
259
|
-
}
|
|
260
|
-
|
|
261
|
-
run();
|
|
262
|
-
```
|
|
263
|
-
|
|
264
|
-
### Parameters
|
|
265
|
-
|
|
266
|
-
| Parameter | Type | Required | Description |
|
|
267
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
268
|
-
| `request` | [operations.GetAgentRequest](../../models/operations/getagentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
269
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
270
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
271
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
272
|
-
|
|
273
|
-
### Response
|
|
274
|
-
|
|
275
|
-
**Promise\<[operations.GetAgentResponseBody](../../models/operations/getagentresponsebody.md)\>**
|
|
276
|
-
|
|
277
|
-
### Errors
|
|
278
|
-
|
|
279
|
-
| Error Type | Status Code | Content Type |
|
|
280
|
-
| --------------------------- | --------------------------- | --------------------------- |
|
|
281
|
-
| errors.GetAgentResponseBody | 404 | application/json |
|
|
282
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
283
|
-
|
|
284
|
-
## update
|
|
285
|
-
|
|
286
|
-
Updates an existing agent's configuration. You can update various fields including the model configuration and fallback model settings.
|
|
287
|
-
|
|
288
|
-
### Example Usage
|
|
289
|
-
|
|
290
|
-
<!-- UsageSnippet language="typescript" operationID="UpdateAgent" method="patch" path="/v2/agents/{agent_key}" -->
|
|
291
|
-
```typescript
|
|
292
|
-
import { Orq } from "@orq-ai/node";
|
|
293
|
-
|
|
294
|
-
const orq = new Orq({
|
|
295
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
296
|
-
});
|
|
297
|
-
|
|
298
|
-
async function run() {
|
|
299
|
-
const result = await orq.agents.update({
|
|
300
|
-
agentKey: "<value>",
|
|
301
|
-
requestBody: {
|
|
302
|
-
model: "El Camino",
|
|
303
|
-
settings: {
|
|
304
|
-
tools: [
|
|
305
|
-
{
|
|
306
|
-
type: "mcp",
|
|
307
|
-
id: "01KA84ND5J0SWQMA2Q8HY5WZZZ",
|
|
308
|
-
toolId: "01KXYZ123456789",
|
|
309
|
-
requiresApproval: false,
|
|
310
|
-
},
|
|
311
|
-
],
|
|
312
|
-
},
|
|
313
|
-
path: "Default",
|
|
314
|
-
knowledgeBases: [
|
|
315
|
-
{
|
|
316
|
-
knowledgeId: "customer-knowledge-base",
|
|
317
|
-
},
|
|
318
|
-
],
|
|
319
|
-
},
|
|
320
|
-
});
|
|
321
|
-
|
|
322
|
-
console.log(result);
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
run();
|
|
326
|
-
```
|
|
327
|
-
|
|
328
|
-
### Standalone function
|
|
329
|
-
|
|
330
|
-
The standalone function version of this method:
|
|
331
|
-
|
|
332
|
-
```typescript
|
|
333
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
334
|
-
import { agentsUpdate } from "@orq-ai/node/funcs/agentsUpdate.js";
|
|
335
|
-
|
|
336
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
337
|
-
// You can create one instance of it to use across an application.
|
|
338
|
-
const orq = new OrqCore({
|
|
339
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
340
|
-
});
|
|
341
|
-
|
|
342
|
-
async function run() {
|
|
343
|
-
const res = await agentsUpdate(orq, {
|
|
344
|
-
agentKey: "<value>",
|
|
345
|
-
requestBody: {
|
|
346
|
-
model: "El Camino",
|
|
347
|
-
settings: {
|
|
348
|
-
tools: [
|
|
349
|
-
{
|
|
350
|
-
type: "mcp",
|
|
351
|
-
id: "01KA84ND5J0SWQMA2Q8HY5WZZZ",
|
|
352
|
-
toolId: "01KXYZ123456789",
|
|
353
|
-
requiresApproval: false,
|
|
354
|
-
},
|
|
355
|
-
],
|
|
356
|
-
},
|
|
357
|
-
path: "Default",
|
|
358
|
-
knowledgeBases: [
|
|
359
|
-
{
|
|
360
|
-
knowledgeId: "customer-knowledge-base",
|
|
361
|
-
},
|
|
362
|
-
],
|
|
363
|
-
},
|
|
364
|
-
});
|
|
365
|
-
if (res.ok) {
|
|
366
|
-
const { value: result } = res;
|
|
367
|
-
console.log(result);
|
|
368
|
-
} else {
|
|
369
|
-
console.log("agentsUpdate failed:", res.error);
|
|
370
|
-
}
|
|
371
|
-
}
|
|
372
|
-
|
|
373
|
-
run();
|
|
374
|
-
```
|
|
375
|
-
|
|
376
|
-
### Parameters
|
|
377
|
-
|
|
378
|
-
| Parameter | Type | Required | Description |
|
|
379
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
380
|
-
| `request` | [operations.UpdateAgentRequest](../../models/operations/updateagentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
381
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
382
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
383
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
384
|
-
|
|
385
|
-
### Response
|
|
386
|
-
|
|
387
|
-
**Promise\<[operations.UpdateAgentResponseBody](../../models/operations/updateagentresponsebody.md)\>**
|
|
388
|
-
|
|
389
|
-
### Errors
|
|
390
|
-
|
|
391
|
-
| Error Type | Status Code | Content Type |
|
|
392
|
-
| ------------------------------ | ------------------------------ | ------------------------------ |
|
|
393
|
-
| errors.UpdateAgentResponseBody | 404 | application/json |
|
|
394
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
395
|
-
|
|
396
|
-
## invoke
|
|
397
|
-
|
|
398
|
-
Executes an existing agent with the provided input. The agent uses its pre-configured primary model and will automatically fall back to its configured fallback model if the primary model fails. Fallback models are configured at the agent level, not during execution.
|
|
399
|
-
|
|
400
|
-
### Example Usage
|
|
401
|
-
|
|
402
|
-
<!-- UsageSnippet language="typescript" operationID="InvokeAgent" method="post" path="/v2/agents/{key}/task" -->
|
|
403
|
-
```typescript
|
|
404
|
-
import { Orq } from "@orq-ai/node";
|
|
405
|
-
|
|
406
|
-
const orq = new Orq({
|
|
407
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
408
|
-
});
|
|
409
|
-
|
|
410
|
-
async function run() {
|
|
411
|
-
const result = await orq.agents.invoke({
|
|
412
|
-
key: "<key>",
|
|
413
|
-
requestBody: {
|
|
414
|
-
message: {
|
|
415
|
-
role: "user",
|
|
416
|
-
parts: [],
|
|
417
|
-
},
|
|
418
|
-
contact: {
|
|
419
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
420
|
-
displayName: "Jane Doe",
|
|
421
|
-
email: "jane.doe@example.com",
|
|
422
|
-
metadata: [
|
|
423
|
-
{
|
|
424
|
-
"department": "Engineering",
|
|
425
|
-
"role": "Senior Developer",
|
|
426
|
-
},
|
|
427
|
-
],
|
|
428
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
429
|
-
tags: [
|
|
430
|
-
"hr",
|
|
431
|
-
"engineering",
|
|
432
|
-
],
|
|
433
|
-
},
|
|
434
|
-
thread: {
|
|
435
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
436
|
-
tags: [
|
|
437
|
-
"customer-support",
|
|
438
|
-
"priority-high",
|
|
439
|
-
],
|
|
440
|
-
},
|
|
441
|
-
},
|
|
442
|
-
});
|
|
443
|
-
|
|
444
|
-
console.log(result);
|
|
445
|
-
}
|
|
446
|
-
|
|
447
|
-
run();
|
|
448
|
-
```
|
|
449
|
-
|
|
450
|
-
### Standalone function
|
|
451
|
-
|
|
452
|
-
The standalone function version of this method:
|
|
453
|
-
|
|
454
|
-
```typescript
|
|
455
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
456
|
-
import { agentsInvoke } from "@orq-ai/node/funcs/agentsInvoke.js";
|
|
457
|
-
|
|
458
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
459
|
-
// You can create one instance of it to use across an application.
|
|
460
|
-
const orq = new OrqCore({
|
|
461
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
462
|
-
});
|
|
463
|
-
|
|
464
|
-
async function run() {
|
|
465
|
-
const res = await agentsInvoke(orq, {
|
|
466
|
-
key: "<key>",
|
|
467
|
-
requestBody: {
|
|
468
|
-
message: {
|
|
469
|
-
role: "user",
|
|
470
|
-
parts: [],
|
|
471
|
-
},
|
|
472
|
-
contact: {
|
|
473
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
474
|
-
displayName: "Jane Doe",
|
|
475
|
-
email: "jane.doe@example.com",
|
|
476
|
-
metadata: [
|
|
477
|
-
{
|
|
478
|
-
"department": "Engineering",
|
|
479
|
-
"role": "Senior Developer",
|
|
480
|
-
},
|
|
481
|
-
],
|
|
482
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
483
|
-
tags: [
|
|
484
|
-
"hr",
|
|
485
|
-
"engineering",
|
|
486
|
-
],
|
|
487
|
-
},
|
|
488
|
-
thread: {
|
|
489
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
490
|
-
tags: [
|
|
491
|
-
"customer-support",
|
|
492
|
-
"priority-high",
|
|
493
|
-
],
|
|
494
|
-
},
|
|
495
|
-
},
|
|
496
|
-
});
|
|
497
|
-
if (res.ok) {
|
|
498
|
-
const { value: result } = res;
|
|
499
|
-
console.log(result);
|
|
500
|
-
} else {
|
|
501
|
-
console.log("agentsInvoke failed:", res.error);
|
|
502
|
-
}
|
|
503
|
-
}
|
|
504
|
-
|
|
505
|
-
run();
|
|
506
|
-
```
|
|
507
|
-
|
|
508
|
-
### Parameters
|
|
509
|
-
|
|
510
|
-
| Parameter | Type | Required | Description |
|
|
511
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
512
|
-
| `request` | [operations.InvokeAgentRequest](../../models/operations/invokeagentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
513
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
514
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
515
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
516
|
-
|
|
517
|
-
### Response
|
|
518
|
-
|
|
519
|
-
**Promise\<[operations.InvokeAgentA2ATaskResponse](../../models/operations/invokeagenta2ataskresponse.md)\>**
|
|
520
|
-
|
|
521
|
-
### Errors
|
|
522
|
-
|
|
523
|
-
| Error Type | Status Code | Content Type |
|
|
524
|
-
| --------------- | --------------- | --------------- |
|
|
525
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
526
|
-
|
|
527
|
-
## listTasks
|
|
528
|
-
|
|
529
|
-
Retrieves a paginated list of all tasks associated with a specific agent, optionally filtered by status.
|
|
530
|
-
|
|
531
|
-
### Example Usage
|
|
532
|
-
|
|
533
|
-
<!-- UsageSnippet language="typescript" operationID="ListAgentTasks" method="get" path="/v2/agents/{agent_key}/tasks" -->
|
|
534
|
-
```typescript
|
|
535
|
-
import { Orq } from "@orq-ai/node";
|
|
536
|
-
|
|
537
|
-
const orq = new Orq({
|
|
538
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
539
|
-
});
|
|
540
|
-
|
|
541
|
-
async function run() {
|
|
542
|
-
const result = await orq.agents.listTasks({
|
|
543
|
-
agentKey: "<value>",
|
|
544
|
-
});
|
|
545
|
-
|
|
546
|
-
console.log(result);
|
|
547
|
-
}
|
|
548
|
-
|
|
549
|
-
run();
|
|
550
|
-
```
|
|
551
|
-
|
|
552
|
-
### Standalone function
|
|
553
|
-
|
|
554
|
-
The standalone function version of this method:
|
|
555
|
-
|
|
556
|
-
```typescript
|
|
557
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
558
|
-
import { agentsListTasks } from "@orq-ai/node/funcs/agentsListTasks.js";
|
|
559
|
-
|
|
560
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
561
|
-
// You can create one instance of it to use across an application.
|
|
562
|
-
const orq = new OrqCore({
|
|
563
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
564
|
-
});
|
|
565
|
-
|
|
566
|
-
async function run() {
|
|
567
|
-
const res = await agentsListTasks(orq, {
|
|
568
|
-
agentKey: "<value>",
|
|
569
|
-
});
|
|
570
|
-
if (res.ok) {
|
|
571
|
-
const { value: result } = res;
|
|
572
|
-
console.log(result);
|
|
573
|
-
} else {
|
|
574
|
-
console.log("agentsListTasks failed:", res.error);
|
|
575
|
-
}
|
|
576
|
-
}
|
|
577
|
-
|
|
578
|
-
run();
|
|
579
|
-
```
|
|
580
|
-
|
|
581
|
-
### Parameters
|
|
582
|
-
|
|
583
|
-
| Parameter | Type | Required | Description |
|
|
584
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
585
|
-
| `request` | [operations.ListAgentTasksRequest](../../models/operations/listagenttasksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
586
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
587
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
588
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
589
|
-
|
|
590
|
-
### Response
|
|
591
|
-
|
|
592
|
-
**Promise\<[operations.ListAgentTasksAgentTasksListResponse](../../models/operations/listagenttasksagenttaskslistresponse.md)\>**
|
|
593
|
-
|
|
594
|
-
### Errors
|
|
595
|
-
|
|
596
|
-
| Error Type | Status Code | Content Type |
|
|
597
|
-
| --------------------------------- | --------------------------------- | --------------------------------- |
|
|
598
|
-
| errors.ListAgentTasksResponseBody | 404 | application/json |
|
|
599
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
600
|
-
|
|
601
|
-
## retrieveTask
|
|
602
|
-
|
|
603
|
-
Retrieves detailed information about a specific task for a given agent, including execution status and results.
|
|
604
|
-
|
|
605
|
-
### Example Usage
|
|
606
|
-
|
|
607
|
-
<!-- UsageSnippet language="typescript" operationID="GetAgentTask" method="get" path="/v2/agents/{agent_key}/tasks/{task_id}" -->
|
|
608
|
-
```typescript
|
|
609
|
-
import { Orq } from "@orq-ai/node";
|
|
610
|
-
|
|
611
|
-
const orq = new Orq({
|
|
612
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
613
|
-
});
|
|
614
|
-
|
|
615
|
-
async function run() {
|
|
616
|
-
const result = await orq.agents.retrieveTask({
|
|
617
|
-
agentKey: "<value>",
|
|
618
|
-
taskId: "<id>",
|
|
619
|
-
});
|
|
620
|
-
|
|
621
|
-
console.log(result);
|
|
622
|
-
}
|
|
623
|
-
|
|
624
|
-
run();
|
|
625
|
-
```
|
|
626
|
-
|
|
627
|
-
### Standalone function
|
|
628
|
-
|
|
629
|
-
The standalone function version of this method:
|
|
630
|
-
|
|
631
|
-
```typescript
|
|
632
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
633
|
-
import { agentsRetrieveTask } from "@orq-ai/node/funcs/agentsRetrieveTask.js";
|
|
634
|
-
|
|
635
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
636
|
-
// You can create one instance of it to use across an application.
|
|
637
|
-
const orq = new OrqCore({
|
|
638
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
639
|
-
});
|
|
640
|
-
|
|
641
|
-
async function run() {
|
|
642
|
-
const res = await agentsRetrieveTask(orq, {
|
|
643
|
-
agentKey: "<value>",
|
|
644
|
-
taskId: "<id>",
|
|
645
|
-
});
|
|
646
|
-
if (res.ok) {
|
|
647
|
-
const { value: result } = res;
|
|
648
|
-
console.log(result);
|
|
649
|
-
} else {
|
|
650
|
-
console.log("agentsRetrieveTask failed:", res.error);
|
|
651
|
-
}
|
|
652
|
-
}
|
|
653
|
-
|
|
654
|
-
run();
|
|
655
|
-
```
|
|
656
|
-
|
|
657
|
-
### Parameters
|
|
658
|
-
|
|
659
|
-
| Parameter | Type | Required | Description |
|
|
660
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
661
|
-
| `request` | [operations.GetAgentTaskRequest](../../models/operations/getagenttaskrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
662
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
663
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
664
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
665
|
-
|
|
666
|
-
### Response
|
|
667
|
-
|
|
668
|
-
**Promise\<[operations.GetAgentTaskExtendedTaskResponse](../../models/operations/getagenttaskextendedtaskresponse.md)\>**
|
|
669
|
-
|
|
670
|
-
### Errors
|
|
671
|
-
|
|
672
|
-
| Error Type | Status Code | Content Type |
|
|
673
|
-
| ------------------- | ------------------- | ------------------- |
|
|
674
|
-
| errors.HonoApiError | 404 | application/json |
|
|
675
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
676
|
-
|
|
677
|
-
## list
|
|
678
|
-
|
|
679
|
-
Retrieves a list of all agents in your workspace. When no limit is provided, returns all agents without pagination. When a limit is specified, returns a paginated list. Each agent includes its configuration, primary model, and optional fallback model settings.
|
|
680
|
-
|
|
681
|
-
### Example Usage
|
|
682
|
-
|
|
683
|
-
<!-- UsageSnippet language="typescript" operationID="ListAgents" method="get" path="/v2/agents/" -->
|
|
684
|
-
```typescript
|
|
685
|
-
import { Orq } from "@orq-ai/node";
|
|
686
|
-
|
|
687
|
-
const orq = new Orq({
|
|
688
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
689
|
-
});
|
|
690
|
-
|
|
691
|
-
async function run() {
|
|
692
|
-
const result = await orq.agents.list({
|
|
693
|
-
limit: 10,
|
|
694
|
-
});
|
|
695
|
-
|
|
696
|
-
console.log(result);
|
|
697
|
-
}
|
|
698
|
-
|
|
699
|
-
run();
|
|
700
|
-
```
|
|
701
|
-
|
|
702
|
-
### Standalone function
|
|
703
|
-
|
|
704
|
-
The standalone function version of this method:
|
|
705
|
-
|
|
706
|
-
```typescript
|
|
707
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
708
|
-
import { agentsList } from "@orq-ai/node/funcs/agentsList.js";
|
|
709
|
-
|
|
710
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
711
|
-
// You can create one instance of it to use across an application.
|
|
712
|
-
const orq = new OrqCore({
|
|
713
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
714
|
-
});
|
|
715
|
-
|
|
716
|
-
async function run() {
|
|
717
|
-
const res = await agentsList(orq, {
|
|
718
|
-
limit: 10,
|
|
719
|
-
});
|
|
720
|
-
if (res.ok) {
|
|
721
|
-
const { value: result } = res;
|
|
722
|
-
console.log(result);
|
|
723
|
-
} else {
|
|
724
|
-
console.log("agentsList failed:", res.error);
|
|
725
|
-
}
|
|
726
|
-
}
|
|
727
|
-
|
|
728
|
-
run();
|
|
729
|
-
```
|
|
730
|
-
|
|
731
|
-
### Parameters
|
|
732
|
-
|
|
733
|
-
| Parameter | Type | Required | Description |
|
|
734
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
735
|
-
| `request` | [operations.ListAgentsRequest](../../models/operations/listagentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
736
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
737
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
738
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
739
|
-
|
|
740
|
-
### Response
|
|
741
|
-
|
|
742
|
-
**Promise\<[operations.ListAgentsResponseBody](../../models/operations/listagentsresponsebody.md)\>**
|
|
743
|
-
|
|
744
|
-
### Errors
|
|
745
|
-
|
|
746
|
-
| Error Type | Status Code | Content Type |
|
|
747
|
-
| --------------- | --------------- | --------------- |
|
|
748
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
749
|
-
|
|
750
|
-
## run
|
|
751
|
-
|
|
752
|
-
Executes an agent with the provided configuration using A2A message format. If the agent already exists with the same configuration, it will be reused. If the configuration differs, a new version is created. The fallback model is configured at the agent level and will be used automatically if the primary model fails during execution.
|
|
753
|
-
|
|
754
|
-
### Example Usage
|
|
755
|
-
|
|
756
|
-
<!-- UsageSnippet language="typescript" operationID="RunAgent" method="post" path="/v2/agents/run" -->
|
|
757
|
-
```typescript
|
|
758
|
-
import { Orq } from "@orq-ai/node";
|
|
759
|
-
|
|
760
|
-
const orq = new Orq({
|
|
761
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
762
|
-
});
|
|
763
|
-
|
|
764
|
-
async function run() {
|
|
765
|
-
const result = await orq.agents.run({
|
|
766
|
-
key: "<key>",
|
|
767
|
-
model: "F-150",
|
|
768
|
-
role: "<value>",
|
|
769
|
-
instructions: "<value>",
|
|
770
|
-
message: {
|
|
771
|
-
role: "tool",
|
|
772
|
-
parts: [
|
|
773
|
-
{
|
|
774
|
-
kind: "file",
|
|
775
|
-
file: {
|
|
776
|
-
uri: "https://front-pecan.info",
|
|
777
|
-
},
|
|
778
|
-
},
|
|
779
|
-
],
|
|
780
|
-
},
|
|
781
|
-
contact: {
|
|
782
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
783
|
-
displayName: "Jane Doe",
|
|
784
|
-
email: "jane.doe@example.com",
|
|
785
|
-
metadata: [
|
|
786
|
-
{
|
|
787
|
-
"department": "Engineering",
|
|
788
|
-
"role": "Senior Developer",
|
|
789
|
-
},
|
|
790
|
-
],
|
|
791
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
792
|
-
tags: [
|
|
793
|
-
"hr",
|
|
794
|
-
"engineering",
|
|
795
|
-
],
|
|
796
|
-
},
|
|
797
|
-
thread: {
|
|
798
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
799
|
-
tags: [
|
|
800
|
-
"customer-support",
|
|
801
|
-
"priority-high",
|
|
802
|
-
],
|
|
803
|
-
},
|
|
804
|
-
path: "Default",
|
|
805
|
-
knowledgeBases: [
|
|
806
|
-
{
|
|
807
|
-
knowledgeId: "customer-knowledge-base",
|
|
808
|
-
},
|
|
809
|
-
],
|
|
810
|
-
settings: {},
|
|
811
|
-
});
|
|
812
|
-
|
|
813
|
-
console.log(result);
|
|
814
|
-
}
|
|
815
|
-
|
|
816
|
-
run();
|
|
817
|
-
```
|
|
818
|
-
|
|
819
|
-
### Standalone function
|
|
820
|
-
|
|
821
|
-
The standalone function version of this method:
|
|
822
|
-
|
|
823
|
-
```typescript
|
|
824
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
825
|
-
import { agentsRun } from "@orq-ai/node/funcs/agentsRun.js";
|
|
826
|
-
|
|
827
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
828
|
-
// You can create one instance of it to use across an application.
|
|
829
|
-
const orq = new OrqCore({
|
|
830
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
831
|
-
});
|
|
832
|
-
|
|
833
|
-
async function run() {
|
|
834
|
-
const res = await agentsRun(orq, {
|
|
835
|
-
key: "<key>",
|
|
836
|
-
model: "F-150",
|
|
837
|
-
role: "<value>",
|
|
838
|
-
instructions: "<value>",
|
|
839
|
-
message: {
|
|
840
|
-
role: "tool",
|
|
841
|
-
parts: [
|
|
842
|
-
{
|
|
843
|
-
kind: "file",
|
|
844
|
-
file: {
|
|
845
|
-
uri: "https://front-pecan.info",
|
|
846
|
-
},
|
|
847
|
-
},
|
|
848
|
-
],
|
|
849
|
-
},
|
|
850
|
-
contact: {
|
|
851
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
852
|
-
displayName: "Jane Doe",
|
|
853
|
-
email: "jane.doe@example.com",
|
|
854
|
-
metadata: [
|
|
855
|
-
{
|
|
856
|
-
"department": "Engineering",
|
|
857
|
-
"role": "Senior Developer",
|
|
858
|
-
},
|
|
859
|
-
],
|
|
860
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
861
|
-
tags: [
|
|
862
|
-
"hr",
|
|
863
|
-
"engineering",
|
|
864
|
-
],
|
|
865
|
-
},
|
|
866
|
-
thread: {
|
|
867
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
868
|
-
tags: [
|
|
869
|
-
"customer-support",
|
|
870
|
-
"priority-high",
|
|
871
|
-
],
|
|
872
|
-
},
|
|
873
|
-
path: "Default",
|
|
874
|
-
knowledgeBases: [
|
|
875
|
-
{
|
|
876
|
-
knowledgeId: "customer-knowledge-base",
|
|
877
|
-
},
|
|
878
|
-
],
|
|
879
|
-
settings: {},
|
|
880
|
-
});
|
|
881
|
-
if (res.ok) {
|
|
882
|
-
const { value: result } = res;
|
|
883
|
-
console.log(result);
|
|
884
|
-
} else {
|
|
885
|
-
console.log("agentsRun failed:", res.error);
|
|
886
|
-
}
|
|
887
|
-
}
|
|
888
|
-
|
|
889
|
-
run();
|
|
890
|
-
```
|
|
891
|
-
|
|
892
|
-
### Parameters
|
|
893
|
-
|
|
894
|
-
| Parameter | Type | Required | Description |
|
|
895
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
896
|
-
| `request` | [operations.RunAgentRequestBody](../../models/operations/runagentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
897
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
898
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
899
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
900
|
-
|
|
901
|
-
### Response
|
|
902
|
-
|
|
903
|
-
**Promise\<[operations.RunAgentA2ATaskResponse](../../models/operations/runagenta2ataskresponse.md)\>**
|
|
904
|
-
|
|
905
|
-
### Errors
|
|
906
|
-
|
|
907
|
-
| Error Type | Status Code | Content Type |
|
|
908
|
-
| --------------- | --------------- | --------------- |
|
|
909
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
910
|
-
|
|
911
|
-
## streamRun
|
|
912
|
-
|
|
913
|
-
Creates or updates an agent with the provided configuration, then streams execution events via Server-Sent Events (SSE). If the agent already exists with the same configuration, it will be reused. If the configuration differs, a new version is created. The stream will continue until the agent completes, errors, or reaches the configured timeout.
|
|
914
|
-
|
|
915
|
-
### Example Usage
|
|
916
|
-
|
|
917
|
-
<!-- UsageSnippet language="typescript" operationID="StreamRunAgent" method="post" path="/v2/agents/stream-run" -->
|
|
918
|
-
```typescript
|
|
919
|
-
import { Orq } from "@orq-ai/node";
|
|
920
|
-
|
|
921
|
-
const orq = new Orq({
|
|
922
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
923
|
-
});
|
|
924
|
-
|
|
925
|
-
async function run() {
|
|
926
|
-
const result = await orq.agents.streamRun({
|
|
927
|
-
key: "<key>",
|
|
928
|
-
model: "Alpine",
|
|
929
|
-
role: "<value>",
|
|
930
|
-
instructions: "<value>",
|
|
931
|
-
message: {
|
|
932
|
-
role: "user",
|
|
933
|
-
parts: [
|
|
934
|
-
{
|
|
935
|
-
kind: "file",
|
|
936
|
-
file: {
|
|
937
|
-
uri: "https://jumbo-zebra.info/",
|
|
938
|
-
},
|
|
939
|
-
},
|
|
940
|
-
],
|
|
941
|
-
},
|
|
942
|
-
contact: {
|
|
943
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
944
|
-
displayName: "Jane Doe",
|
|
945
|
-
email: "jane.doe@example.com",
|
|
946
|
-
metadata: [
|
|
947
|
-
{
|
|
948
|
-
"department": "Engineering",
|
|
949
|
-
"role": "Senior Developer",
|
|
950
|
-
},
|
|
951
|
-
],
|
|
952
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
953
|
-
tags: [
|
|
954
|
-
"hr",
|
|
955
|
-
"engineering",
|
|
956
|
-
],
|
|
957
|
-
},
|
|
958
|
-
thread: {
|
|
959
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
960
|
-
tags: [
|
|
961
|
-
"customer-support",
|
|
962
|
-
"priority-high",
|
|
963
|
-
],
|
|
964
|
-
},
|
|
965
|
-
path: "Default",
|
|
966
|
-
knowledgeBases: [
|
|
967
|
-
{
|
|
968
|
-
knowledgeId: "customer-knowledge-base",
|
|
969
|
-
},
|
|
970
|
-
],
|
|
971
|
-
settings: {},
|
|
972
|
-
});
|
|
973
|
-
|
|
974
|
-
for await (const event of result) {
|
|
975
|
-
console.log(event);
|
|
976
|
-
}
|
|
977
|
-
}
|
|
978
|
-
|
|
979
|
-
run();
|
|
980
|
-
```
|
|
981
|
-
|
|
982
|
-
### Standalone function
|
|
983
|
-
|
|
984
|
-
The standalone function version of this method:
|
|
985
|
-
|
|
986
|
-
```typescript
|
|
987
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
988
|
-
import { agentsStreamRun } from "@orq-ai/node/funcs/agentsStreamRun.js";
|
|
989
|
-
|
|
990
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
991
|
-
// You can create one instance of it to use across an application.
|
|
992
|
-
const orq = new OrqCore({
|
|
993
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
994
|
-
});
|
|
995
|
-
|
|
996
|
-
async function run() {
|
|
997
|
-
const res = await agentsStreamRun(orq, {
|
|
998
|
-
key: "<key>",
|
|
999
|
-
model: "Alpine",
|
|
1000
|
-
role: "<value>",
|
|
1001
|
-
instructions: "<value>",
|
|
1002
|
-
message: {
|
|
1003
|
-
role: "user",
|
|
1004
|
-
parts: [
|
|
1005
|
-
{
|
|
1006
|
-
kind: "file",
|
|
1007
|
-
file: {
|
|
1008
|
-
uri: "https://jumbo-zebra.info/",
|
|
1009
|
-
},
|
|
1010
|
-
},
|
|
1011
|
-
],
|
|
1012
|
-
},
|
|
1013
|
-
contact: {
|
|
1014
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
1015
|
-
displayName: "Jane Doe",
|
|
1016
|
-
email: "jane.doe@example.com",
|
|
1017
|
-
metadata: [
|
|
1018
|
-
{
|
|
1019
|
-
"department": "Engineering",
|
|
1020
|
-
"role": "Senior Developer",
|
|
1021
|
-
},
|
|
1022
|
-
],
|
|
1023
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
1024
|
-
tags: [
|
|
1025
|
-
"hr",
|
|
1026
|
-
"engineering",
|
|
1027
|
-
],
|
|
1028
|
-
},
|
|
1029
|
-
thread: {
|
|
1030
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
1031
|
-
tags: [
|
|
1032
|
-
"customer-support",
|
|
1033
|
-
"priority-high",
|
|
1034
|
-
],
|
|
1035
|
-
},
|
|
1036
|
-
path: "Default",
|
|
1037
|
-
knowledgeBases: [
|
|
1038
|
-
{
|
|
1039
|
-
knowledgeId: "customer-knowledge-base",
|
|
1040
|
-
},
|
|
1041
|
-
],
|
|
1042
|
-
settings: {},
|
|
1043
|
-
});
|
|
1044
|
-
if (res.ok) {
|
|
1045
|
-
const { value: result } = res;
|
|
1046
|
-
for await (const event of result) {
|
|
1047
|
-
console.log(event);
|
|
1048
|
-
}
|
|
1049
|
-
} else {
|
|
1050
|
-
console.log("agentsStreamRun failed:", res.error);
|
|
1051
|
-
}
|
|
1052
|
-
}
|
|
1053
|
-
|
|
1054
|
-
run();
|
|
1055
|
-
```
|
|
1056
|
-
|
|
1057
|
-
### Parameters
|
|
1058
|
-
|
|
1059
|
-
| Parameter | Type | Required | Description |
|
|
1060
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1061
|
-
| `request` | [operations.StreamRunAgentRequestBody](../../models/operations/streamrunagentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1062
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1063
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1064
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1065
|
-
|
|
1066
|
-
### Response
|
|
1067
|
-
|
|
1068
|
-
**Promise\<[EventStream<operations.StreamRunAgentResponseBody>](../../models/.md)\>**
|
|
1069
|
-
|
|
1070
|
-
### Errors
|
|
1071
|
-
|
|
1072
|
-
| Error Type | Status Code | Content Type |
|
|
1073
|
-
| --------------------------------- | --------------------------------- | --------------------------------- |
|
|
1074
|
-
| errors.StreamRunAgentResponseBody | 404 | application/json |
|
|
1075
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1076
|
-
|
|
1077
|
-
## stream
|
|
1078
|
-
|
|
1079
|
-
Executes an agent and streams events via Server-Sent Events (SSE). The stream will continue until the agent completes, errors, or reaches the configured timeout.
|
|
1080
|
-
|
|
1081
|
-
### Example Usage
|
|
1082
|
-
|
|
1083
|
-
<!-- UsageSnippet language="typescript" operationID="StreamAgent" method="post" path="/v2/agents/{key}/stream-task" -->
|
|
1084
|
-
```typescript
|
|
1085
|
-
import { Orq } from "@orq-ai/node";
|
|
1086
|
-
|
|
1087
|
-
const orq = new Orq({
|
|
1088
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1089
|
-
});
|
|
1090
|
-
|
|
1091
|
-
async function run() {
|
|
1092
|
-
const result = await orq.agents.stream({
|
|
1093
|
-
key: "<key>",
|
|
1094
|
-
requestBody: {
|
|
1095
|
-
message: {
|
|
1096
|
-
role: "user",
|
|
1097
|
-
parts: [],
|
|
1098
|
-
},
|
|
1099
|
-
contact: {
|
|
1100
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
1101
|
-
displayName: "Jane Doe",
|
|
1102
|
-
email: "jane.doe@example.com",
|
|
1103
|
-
metadata: [
|
|
1104
|
-
{
|
|
1105
|
-
"department": "Engineering",
|
|
1106
|
-
"role": "Senior Developer",
|
|
1107
|
-
},
|
|
1108
|
-
],
|
|
1109
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
1110
|
-
tags: [
|
|
1111
|
-
"hr",
|
|
1112
|
-
"engineering",
|
|
1113
|
-
],
|
|
1114
|
-
},
|
|
1115
|
-
thread: {
|
|
1116
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
1117
|
-
tags: [
|
|
1118
|
-
"customer-support",
|
|
1119
|
-
"priority-high",
|
|
1120
|
-
],
|
|
1121
|
-
},
|
|
1122
|
-
},
|
|
1123
|
-
});
|
|
1124
|
-
|
|
1125
|
-
for await (const event of result) {
|
|
1126
|
-
console.log(event);
|
|
1127
|
-
}
|
|
1128
|
-
}
|
|
1129
|
-
|
|
1130
|
-
run();
|
|
1131
|
-
```
|
|
1132
|
-
|
|
1133
|
-
### Standalone function
|
|
1134
|
-
|
|
1135
|
-
The standalone function version of this method:
|
|
1136
|
-
|
|
1137
|
-
```typescript
|
|
1138
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1139
|
-
import { agentsStream } from "@orq-ai/node/funcs/agentsStream.js";
|
|
1140
|
-
|
|
1141
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
1142
|
-
// You can create one instance of it to use across an application.
|
|
1143
|
-
const orq = new OrqCore({
|
|
1144
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1145
|
-
});
|
|
1146
|
-
|
|
1147
|
-
async function run() {
|
|
1148
|
-
const res = await agentsStream(orq, {
|
|
1149
|
-
key: "<key>",
|
|
1150
|
-
requestBody: {
|
|
1151
|
-
message: {
|
|
1152
|
-
role: "user",
|
|
1153
|
-
parts: [],
|
|
1154
|
-
},
|
|
1155
|
-
contact: {
|
|
1156
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
1157
|
-
displayName: "Jane Doe",
|
|
1158
|
-
email: "jane.doe@example.com",
|
|
1159
|
-
metadata: [
|
|
1160
|
-
{
|
|
1161
|
-
"department": "Engineering",
|
|
1162
|
-
"role": "Senior Developer",
|
|
1163
|
-
},
|
|
1164
|
-
],
|
|
1165
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
1166
|
-
tags: [
|
|
1167
|
-
"hr",
|
|
1168
|
-
"engineering",
|
|
1169
|
-
],
|
|
1170
|
-
},
|
|
1171
|
-
thread: {
|
|
1172
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
1173
|
-
tags: [
|
|
1174
|
-
"customer-support",
|
|
1175
|
-
"priority-high",
|
|
1176
|
-
],
|
|
1177
|
-
},
|
|
1178
|
-
},
|
|
1179
|
-
});
|
|
1180
|
-
if (res.ok) {
|
|
1181
|
-
const { value: result } = res;
|
|
1182
|
-
for await (const event of result) {
|
|
1183
|
-
console.log(event);
|
|
1184
|
-
}
|
|
1185
|
-
} else {
|
|
1186
|
-
console.log("agentsStream failed:", res.error);
|
|
1187
|
-
}
|
|
1188
|
-
}
|
|
1189
|
-
|
|
1190
|
-
run();
|
|
1191
|
-
```
|
|
1192
|
-
|
|
1193
|
-
### Parameters
|
|
1194
|
-
|
|
1195
|
-
| Parameter | Type | Required | Description |
|
|
1196
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1197
|
-
| `request` | [operations.StreamAgentRequest](../../models/operations/streamagentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1198
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1199
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1200
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1201
|
-
|
|
1202
|
-
### Response
|
|
1203
|
-
|
|
1204
|
-
**Promise\<[EventStream<operations.StreamAgentResponseBody>](../../models/.md)\>**
|
|
1205
|
-
|
|
1206
|
-
### Errors
|
|
1207
|
-
|
|
1208
|
-
| Error Type | Status Code | Content Type |
|
|
1209
|
-
| ------------------------------ | ------------------------------ | ------------------------------ |
|
|
1210
|
-
| errors.StreamAgentResponseBody | 404 | application/json |
|
|
1211
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1212
|
-
|
|
1213
|
-
## listActions
|
|
1214
|
-
|
|
1215
|
-
List all actions
|
|
1216
|
-
|
|
1217
|
-
### Example Usage
|
|
1218
|
-
|
|
1219
|
-
<!-- UsageSnippet language="typescript" operationID="ListActions" method="get" path="/v2/agents/{agent_key}/tasks/{task_id}/actions" -->
|
|
1220
|
-
```typescript
|
|
1221
|
-
import { Orq } from "@orq-ai/node";
|
|
1222
|
-
|
|
1223
|
-
const orq = new Orq({
|
|
1224
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1225
|
-
});
|
|
1226
|
-
|
|
1227
|
-
async function run() {
|
|
1228
|
-
const result = await orq.agents.listActions({
|
|
1229
|
-
agentKey: "<value>",
|
|
1230
|
-
taskId: "<id>",
|
|
1231
|
-
});
|
|
1232
|
-
|
|
1233
|
-
console.log(result);
|
|
1234
|
-
}
|
|
1235
|
-
|
|
1236
|
-
run();
|
|
1237
|
-
```
|
|
1238
|
-
|
|
1239
|
-
### Standalone function
|
|
1240
|
-
|
|
1241
|
-
The standalone function version of this method:
|
|
1242
|
-
|
|
1243
|
-
```typescript
|
|
1244
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1245
|
-
import { agentsListActions } from "@orq-ai/node/funcs/agentsListActions.js";
|
|
1246
|
-
|
|
1247
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
1248
|
-
// You can create one instance of it to use across an application.
|
|
1249
|
-
const orq = new OrqCore({
|
|
1250
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1251
|
-
});
|
|
1252
|
-
|
|
1253
|
-
async function run() {
|
|
1254
|
-
const res = await agentsListActions(orq, {
|
|
1255
|
-
agentKey: "<value>",
|
|
1256
|
-
taskId: "<id>",
|
|
1257
|
-
});
|
|
1258
|
-
if (res.ok) {
|
|
1259
|
-
const { value: result } = res;
|
|
1260
|
-
console.log(result);
|
|
1261
|
-
} else {
|
|
1262
|
-
console.log("agentsListActions failed:", res.error);
|
|
1263
|
-
}
|
|
1264
|
-
}
|
|
1265
|
-
|
|
1266
|
-
run();
|
|
1267
|
-
```
|
|
1268
|
-
|
|
1269
|
-
### Parameters
|
|
1270
|
-
|
|
1271
|
-
| Parameter | Type | Required | Description |
|
|
1272
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1273
|
-
| `request` | [operations.ListActionsRequest](../../models/operations/listactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1274
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1275
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1276
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1277
|
-
|
|
1278
|
-
### Response
|
|
1279
|
-
|
|
1280
|
-
**Promise\<[operations.ListActionsResponseBody](../../models/operations/listactionsresponsebody.md)\>**
|
|
1281
|
-
|
|
1282
|
-
### Errors
|
|
1283
|
-
|
|
1284
|
-
| Error Type | Status Code | Content Type |
|
|
1285
|
-
| --------------- | --------------- | --------------- |
|
|
1286
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1287
|
-
|
|
1288
|
-
## retrieveAction
|
|
1289
|
-
|
|
1290
|
-
Retrieve an action executed by an agent task.
|
|
1291
|
-
|
|
1292
|
-
### Example Usage
|
|
1293
|
-
|
|
1294
|
-
<!-- UsageSnippet language="typescript" operationID="RetrieveAction" method="get" path="/v2/agents/{agent_key}/tasks/{task_id}/actions/{action_id}" -->
|
|
1295
|
-
```typescript
|
|
1296
|
-
import { Orq } from "@orq-ai/node";
|
|
1297
|
-
|
|
1298
|
-
const orq = new Orq({
|
|
1299
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1300
|
-
});
|
|
1301
|
-
|
|
1302
|
-
async function run() {
|
|
1303
|
-
const result = await orq.agents.retrieveAction({
|
|
1304
|
-
agentKey: "<value>",
|
|
1305
|
-
taskId: "<id>",
|
|
1306
|
-
actionId: "<id>",
|
|
1307
|
-
});
|
|
1308
|
-
|
|
1309
|
-
console.log(result);
|
|
1310
|
-
}
|
|
1311
|
-
|
|
1312
|
-
run();
|
|
1313
|
-
```
|
|
1314
|
-
|
|
1315
|
-
### Standalone function
|
|
1316
|
-
|
|
1317
|
-
The standalone function version of this method:
|
|
1318
|
-
|
|
1319
|
-
```typescript
|
|
1320
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1321
|
-
import { agentsRetrieveAction } from "@orq-ai/node/funcs/agentsRetrieveAction.js";
|
|
1322
|
-
|
|
1323
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
1324
|
-
// You can create one instance of it to use across an application.
|
|
1325
|
-
const orq = new OrqCore({
|
|
1326
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1327
|
-
});
|
|
1328
|
-
|
|
1329
|
-
async function run() {
|
|
1330
|
-
const res = await agentsRetrieveAction(orq, {
|
|
1331
|
-
agentKey: "<value>",
|
|
1332
|
-
taskId: "<id>",
|
|
1333
|
-
actionId: "<id>",
|
|
1334
|
-
});
|
|
1335
|
-
if (res.ok) {
|
|
1336
|
-
const { value: result } = res;
|
|
1337
|
-
console.log(result);
|
|
1338
|
-
} else {
|
|
1339
|
-
console.log("agentsRetrieveAction failed:", res.error);
|
|
1340
|
-
}
|
|
1341
|
-
}
|
|
1342
|
-
|
|
1343
|
-
run();
|
|
1344
|
-
```
|
|
1345
|
-
|
|
1346
|
-
### Parameters
|
|
1347
|
-
|
|
1348
|
-
| Parameter | Type | Required | Description |
|
|
1349
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1350
|
-
| `request` | [operations.RetrieveActionRequest](../../models/operations/retrieveactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1351
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1352
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1353
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1354
|
-
|
|
1355
|
-
### Response
|
|
1356
|
-
|
|
1357
|
-
**Promise\<[operations.RetrieveActionResponseBody](../../models/operations/retrieveactionresponsebody.md)\>**
|
|
1358
|
-
|
|
1359
|
-
### Errors
|
|
1360
|
-
|
|
1361
|
-
| Error Type | Status Code | Content Type |
|
|
1362
|
-
| --------------- | --------------- | --------------- |
|
|
1363
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|