@orq-ai/node 4.0.5 → 4.1.0-rc.1
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 -901
- package/packages/orq-rc/RUNTIMES.md +0 -48
- package/packages/orq-rc/docs/sdks/agents/README.md +0 -1064
- 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 -134
- 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 -174
- package/packages/orq-rc/src/funcs/agentsDelete.ts +0 -180
- package/packages/orq-rc/src/funcs/agentsInvoke.ts +0 -177
- package/packages/orq-rc/src/funcs/agentsList.ts +0 -179
- package/packages/orq-rc/src/funcs/agentsResponsesCreate.ts +0 -179
- package/packages/orq-rc/src/funcs/agentsRetrieve.ts +0 -180
- package/packages/orq-rc/src/funcs/agentsRun.ts +0 -165
- package/packages/orq-rc/src/funcs/agentsStream.ts +0 -201
- package/packages/orq-rc/src/funcs/agentsStreamRun.ts +0 -191
- package/packages/orq-rc/src/funcs/agentsUpdate.ts +0 -184
- 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 -251
- 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 -40
- package/packages/orq-rc/src/mcp-server/tools/agentsList.ts +0 -41
- package/packages/orq-rc/src/mcp-server/tools/agentsResponsesCreate.ts +0 -41
- package/packages/orq-rc/src/mcp-server/tools/agentsRetrieve.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 -40
- package/packages/orq-rc/src/mcp-server/tools/agentsStreamRun.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/agentsUpdate.ts +0 -41
- 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/createagentrequest.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/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 -26
- 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/retrieveagentrequest.ts +0 -67
- 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/createagentrequest.ts +0 -8215
- package/packages/orq-rc/src/models/operations/createagentresponserequest.ts +0 -1353
- 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/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 -98
- package/packages/orq-rc/src/models/operations/invokeagent.ts +0 -1893
- package/packages/orq-rc/src/models/operations/listagents.ts +0 -3614
- 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/retrieveagentrequest.ts +0 -3741
- 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 -7613
- 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 -15817
- 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 -196
- 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 -29
- 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,1171 +0,0 @@
|
|
|
1
|
-
# MemoryStores
|
|
2
|
-
(*memoryStores*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [list](#list) - List memory stores
|
|
9
|
-
* [create](#create) - Create memory store
|
|
10
|
-
* [retrieve](#retrieve) - Retrieve memory store
|
|
11
|
-
* [update](#update) - Update memory store
|
|
12
|
-
* [delete](#delete) - Delete memory store
|
|
13
|
-
* [listMemories](#listmemories) - List all memories
|
|
14
|
-
* [createMemory](#creatememory) - Create a new memory
|
|
15
|
-
* [retrieveMemory](#retrievememory) - Retrieve a specific memory
|
|
16
|
-
* [updateMemory](#updatememory) - Update a specific memory
|
|
17
|
-
* [deleteMemory](#deletememory) - Delete a specific memory
|
|
18
|
-
* [listDocuments](#listdocuments) - List all documents for a memory
|
|
19
|
-
* [createDocument](#createdocument) - Create a new memory document
|
|
20
|
-
* [retrieveDocument](#retrievedocument) - Retrieve a specific memory document
|
|
21
|
-
* [updateDocument](#updatedocument) - Update a specific memory document
|
|
22
|
-
* [deleteDocument](#deletedocument) - Delete a specific memory document
|
|
23
|
-
|
|
24
|
-
## list
|
|
25
|
-
|
|
26
|
-
Retrieves a paginated list of memory stores in the workspace. Use cursor-based pagination parameters to navigate through the results.
|
|
27
|
-
|
|
28
|
-
### Example Usage
|
|
29
|
-
|
|
30
|
-
<!-- UsageSnippet language="typescript" operationID="GetAllMemoryStores" method="get" path="/v2/memory-stores" -->
|
|
31
|
-
```typescript
|
|
32
|
-
import { Orq } from "@orq-ai/node";
|
|
33
|
-
|
|
34
|
-
const orq = new Orq({
|
|
35
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
36
|
-
});
|
|
37
|
-
|
|
38
|
-
async function run() {
|
|
39
|
-
const result = await orq.memoryStores.list({});
|
|
40
|
-
|
|
41
|
-
console.log(result);
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
run();
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
### Standalone function
|
|
48
|
-
|
|
49
|
-
The standalone function version of this method:
|
|
50
|
-
|
|
51
|
-
```typescript
|
|
52
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
53
|
-
import { memoryStoresList } from "@orq-ai/node/funcs/memoryStoresList.js";
|
|
54
|
-
|
|
55
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
56
|
-
// You can create one instance of it to use across an application.
|
|
57
|
-
const orq = new OrqCore({
|
|
58
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
59
|
-
});
|
|
60
|
-
|
|
61
|
-
async function run() {
|
|
62
|
-
const res = await memoryStoresList(orq, {});
|
|
63
|
-
if (res.ok) {
|
|
64
|
-
const { value: result } = res;
|
|
65
|
-
console.log(result);
|
|
66
|
-
} else {
|
|
67
|
-
console.log("memoryStoresList failed:", res.error);
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
run();
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
### Parameters
|
|
75
|
-
|
|
76
|
-
| Parameter | Type | Required | Description |
|
|
77
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
78
|
-
| `request` | [operations.GetAllMemoryStoresRequest](../../models/operations/getallmemorystoresrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
79
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
80
|
-
| `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. |
|
|
81
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
82
|
-
|
|
83
|
-
### Response
|
|
84
|
-
|
|
85
|
-
**Promise\<[operations.GetAllMemoryStoresResponseBody](../../models/operations/getallmemorystoresresponsebody.md)\>**
|
|
86
|
-
|
|
87
|
-
### Errors
|
|
88
|
-
|
|
89
|
-
| Error Type | Status Code | Content Type |
|
|
90
|
-
| ------------------- | ------------------- | ------------------- |
|
|
91
|
-
| errors.HonoApiError | 401 | application/json |
|
|
92
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
93
|
-
|
|
94
|
-
## create
|
|
95
|
-
|
|
96
|
-
Create memory store
|
|
97
|
-
|
|
98
|
-
### Example Usage
|
|
99
|
-
|
|
100
|
-
<!-- UsageSnippet language="typescript" operationID="CreateMemoryStore" method="post" path="/v2/memory-stores" -->
|
|
101
|
-
```typescript
|
|
102
|
-
import { Orq } from "@orq-ai/node";
|
|
103
|
-
|
|
104
|
-
const orq = new Orq({
|
|
105
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
106
|
-
});
|
|
107
|
-
|
|
108
|
-
async function run() {
|
|
109
|
-
const result = await orq.memoryStores.create({
|
|
110
|
-
key: "<key>",
|
|
111
|
-
embeddingConfig: {
|
|
112
|
-
model: "cohere/embed-multilingual-light-v3.0",
|
|
113
|
-
},
|
|
114
|
-
description: "unlike excluding soulful quirkily hmph baseboard whereas gee deserted",
|
|
115
|
-
path: "Default",
|
|
116
|
-
});
|
|
117
|
-
|
|
118
|
-
console.log(result);
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
run();
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
### Standalone function
|
|
125
|
-
|
|
126
|
-
The standalone function version of this method:
|
|
127
|
-
|
|
128
|
-
```typescript
|
|
129
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
130
|
-
import { memoryStoresCreate } from "@orq-ai/node/funcs/memoryStoresCreate.js";
|
|
131
|
-
|
|
132
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
133
|
-
// You can create one instance of it to use across an application.
|
|
134
|
-
const orq = new OrqCore({
|
|
135
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
136
|
-
});
|
|
137
|
-
|
|
138
|
-
async function run() {
|
|
139
|
-
const res = await memoryStoresCreate(orq, {
|
|
140
|
-
key: "<key>",
|
|
141
|
-
embeddingConfig: {
|
|
142
|
-
model: "cohere/embed-multilingual-light-v3.0",
|
|
143
|
-
},
|
|
144
|
-
description: "unlike excluding soulful quirkily hmph baseboard whereas gee deserted",
|
|
145
|
-
path: "Default",
|
|
146
|
-
});
|
|
147
|
-
if (res.ok) {
|
|
148
|
-
const { value: result } = res;
|
|
149
|
-
console.log(result);
|
|
150
|
-
} else {
|
|
151
|
-
console.log("memoryStoresCreate failed:", res.error);
|
|
152
|
-
}
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
run();
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
### Parameters
|
|
159
|
-
|
|
160
|
-
| Parameter | Type | Required | Description |
|
|
161
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
162
|
-
| `request` | [operations.CreateMemoryStoreRequestBody](../../models/operations/creatememorystorerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
163
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
164
|
-
| `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. |
|
|
165
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
166
|
-
|
|
167
|
-
### Response
|
|
168
|
-
|
|
169
|
-
**Promise\<[operations.CreateMemoryStoreResponseBody](../../models/operations/creatememorystoreresponsebody.md)\>**
|
|
170
|
-
|
|
171
|
-
### Errors
|
|
172
|
-
|
|
173
|
-
| Error Type | Status Code | Content Type |
|
|
174
|
-
| --------------- | --------------- | --------------- |
|
|
175
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
176
|
-
|
|
177
|
-
## retrieve
|
|
178
|
-
|
|
179
|
-
Retrieves detailed information about a specific memory store, including its configuration and metadata.
|
|
180
|
-
|
|
181
|
-
### Example Usage
|
|
182
|
-
|
|
183
|
-
<!-- UsageSnippet language="typescript" operationID="RetrieveMemoryStore" method="get" path="/v2/memory-stores/{memory_store_key}" -->
|
|
184
|
-
```typescript
|
|
185
|
-
import { Orq } from "@orq-ai/node";
|
|
186
|
-
|
|
187
|
-
const orq = new Orq({
|
|
188
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
189
|
-
});
|
|
190
|
-
|
|
191
|
-
async function run() {
|
|
192
|
-
const result = await orq.memoryStores.retrieve({
|
|
193
|
-
memoryStoreKey: "<value>",
|
|
194
|
-
});
|
|
195
|
-
|
|
196
|
-
console.log(result);
|
|
197
|
-
}
|
|
198
|
-
|
|
199
|
-
run();
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
### Standalone function
|
|
203
|
-
|
|
204
|
-
The standalone function version of this method:
|
|
205
|
-
|
|
206
|
-
```typescript
|
|
207
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
208
|
-
import { memoryStoresRetrieve } from "@orq-ai/node/funcs/memoryStoresRetrieve.js";
|
|
209
|
-
|
|
210
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
211
|
-
// You can create one instance of it to use across an application.
|
|
212
|
-
const orq = new OrqCore({
|
|
213
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
214
|
-
});
|
|
215
|
-
|
|
216
|
-
async function run() {
|
|
217
|
-
const res = await memoryStoresRetrieve(orq, {
|
|
218
|
-
memoryStoreKey: "<value>",
|
|
219
|
-
});
|
|
220
|
-
if (res.ok) {
|
|
221
|
-
const { value: result } = res;
|
|
222
|
-
console.log(result);
|
|
223
|
-
} else {
|
|
224
|
-
console.log("memoryStoresRetrieve failed:", res.error);
|
|
225
|
-
}
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
run();
|
|
229
|
-
```
|
|
230
|
-
|
|
231
|
-
### Parameters
|
|
232
|
-
|
|
233
|
-
| Parameter | Type | Required | Description |
|
|
234
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
235
|
-
| `request` | [operations.RetrieveMemoryStoreRequest](../../models/operations/retrievememorystorerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
236
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
237
|
-
| `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. |
|
|
238
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
239
|
-
|
|
240
|
-
### Response
|
|
241
|
-
|
|
242
|
-
**Promise\<[operations.RetrieveMemoryStoreResponseBody](../../models/operations/retrievememorystoreresponsebody.md)\>**
|
|
243
|
-
|
|
244
|
-
### Errors
|
|
245
|
-
|
|
246
|
-
| Error Type | Status Code | Content Type |
|
|
247
|
-
| ------------------- | ------------------- | ------------------- |
|
|
248
|
-
| errors.HonoApiError | 401, 403, 404 | application/json |
|
|
249
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
250
|
-
|
|
251
|
-
## update
|
|
252
|
-
|
|
253
|
-
Update the memory store configuration
|
|
254
|
-
|
|
255
|
-
### Example Usage
|
|
256
|
-
|
|
257
|
-
<!-- UsageSnippet language="typescript" operationID="UpdateMemoryStore" method="patch" path="/v2/memory-stores/{memory_store_key}" -->
|
|
258
|
-
```typescript
|
|
259
|
-
import { Orq } from "@orq-ai/node";
|
|
260
|
-
|
|
261
|
-
const orq = new Orq({
|
|
262
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
263
|
-
});
|
|
264
|
-
|
|
265
|
-
async function run() {
|
|
266
|
-
const result = await orq.memoryStores.update({
|
|
267
|
-
memoryStoreKey: "<value>",
|
|
268
|
-
requestBody: {
|
|
269
|
-
embeddingConfig: {
|
|
270
|
-
model: "google/text-multilingual-embedding-002",
|
|
271
|
-
},
|
|
272
|
-
description: "wherever cash since now exempt proliferate aha tabulate ack",
|
|
273
|
-
path: "Default",
|
|
274
|
-
},
|
|
275
|
-
});
|
|
276
|
-
|
|
277
|
-
console.log(result);
|
|
278
|
-
}
|
|
279
|
-
|
|
280
|
-
run();
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
### Standalone function
|
|
284
|
-
|
|
285
|
-
The standalone function version of this method:
|
|
286
|
-
|
|
287
|
-
```typescript
|
|
288
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
289
|
-
import { memoryStoresUpdate } from "@orq-ai/node/funcs/memoryStoresUpdate.js";
|
|
290
|
-
|
|
291
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
292
|
-
// You can create one instance of it to use across an application.
|
|
293
|
-
const orq = new OrqCore({
|
|
294
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
295
|
-
});
|
|
296
|
-
|
|
297
|
-
async function run() {
|
|
298
|
-
const res = await memoryStoresUpdate(orq, {
|
|
299
|
-
memoryStoreKey: "<value>",
|
|
300
|
-
requestBody: {
|
|
301
|
-
embeddingConfig: {
|
|
302
|
-
model: "google/text-multilingual-embedding-002",
|
|
303
|
-
},
|
|
304
|
-
description: "wherever cash since now exempt proliferate aha tabulate ack",
|
|
305
|
-
path: "Default",
|
|
306
|
-
},
|
|
307
|
-
});
|
|
308
|
-
if (res.ok) {
|
|
309
|
-
const { value: result } = res;
|
|
310
|
-
console.log(result);
|
|
311
|
-
} else {
|
|
312
|
-
console.log("memoryStoresUpdate failed:", res.error);
|
|
313
|
-
}
|
|
314
|
-
}
|
|
315
|
-
|
|
316
|
-
run();
|
|
317
|
-
```
|
|
318
|
-
|
|
319
|
-
### Parameters
|
|
320
|
-
|
|
321
|
-
| Parameter | Type | Required | Description |
|
|
322
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
323
|
-
| `request` | [operations.UpdateMemoryStoreRequest](../../models/operations/updatememorystorerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
324
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
325
|
-
| `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. |
|
|
326
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
327
|
-
|
|
328
|
-
### Response
|
|
329
|
-
|
|
330
|
-
**Promise\<[operations.UpdateMemoryStoreResponseBody](../../models/operations/updatememorystoreresponsebody.md)\>**
|
|
331
|
-
|
|
332
|
-
### Errors
|
|
333
|
-
|
|
334
|
-
| Error Type | Status Code | Content Type |
|
|
335
|
-
| --------------- | --------------- | --------------- |
|
|
336
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
337
|
-
|
|
338
|
-
## delete
|
|
339
|
-
|
|
340
|
-
Permanently delete a memory store, including memories and documents.
|
|
341
|
-
|
|
342
|
-
### Example Usage
|
|
343
|
-
|
|
344
|
-
<!-- UsageSnippet language="typescript" operationID="DeleteMemoryStore" method="delete" path="/v2/memory-stores/{memory_store_key}" -->
|
|
345
|
-
```typescript
|
|
346
|
-
import { Orq } from "@orq-ai/node";
|
|
347
|
-
|
|
348
|
-
const orq = new Orq({
|
|
349
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
350
|
-
});
|
|
351
|
-
|
|
352
|
-
async function run() {
|
|
353
|
-
await orq.memoryStores.delete({
|
|
354
|
-
memoryStoreKey: "<value>",
|
|
355
|
-
});
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
run();
|
|
361
|
-
```
|
|
362
|
-
|
|
363
|
-
### Standalone function
|
|
364
|
-
|
|
365
|
-
The standalone function version of this method:
|
|
366
|
-
|
|
367
|
-
```typescript
|
|
368
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
369
|
-
import { memoryStoresDelete } from "@orq-ai/node/funcs/memoryStoresDelete.js";
|
|
370
|
-
|
|
371
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
372
|
-
// You can create one instance of it to use across an application.
|
|
373
|
-
const orq = new OrqCore({
|
|
374
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
375
|
-
});
|
|
376
|
-
|
|
377
|
-
async function run() {
|
|
378
|
-
const res = await memoryStoresDelete(orq, {
|
|
379
|
-
memoryStoreKey: "<value>",
|
|
380
|
-
});
|
|
381
|
-
if (res.ok) {
|
|
382
|
-
const { value: result } = res;
|
|
383
|
-
|
|
384
|
-
} else {
|
|
385
|
-
console.log("memoryStoresDelete failed:", res.error);
|
|
386
|
-
}
|
|
387
|
-
}
|
|
388
|
-
|
|
389
|
-
run();
|
|
390
|
-
```
|
|
391
|
-
|
|
392
|
-
### Parameters
|
|
393
|
-
|
|
394
|
-
| Parameter | Type | Required | Description |
|
|
395
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
396
|
-
| `request` | [operations.DeleteMemoryStoreRequest](../../models/operations/deletememorystorerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
397
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
398
|
-
| `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. |
|
|
399
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
400
|
-
|
|
401
|
-
### Response
|
|
402
|
-
|
|
403
|
-
**Promise\<void\>**
|
|
404
|
-
|
|
405
|
-
### Errors
|
|
406
|
-
|
|
407
|
-
| Error Type | Status Code | Content Type |
|
|
408
|
-
| --------------- | --------------- | --------------- |
|
|
409
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
410
|
-
|
|
411
|
-
## listMemories
|
|
412
|
-
|
|
413
|
-
Retrieves a paginated list of memories for the memory store
|
|
414
|
-
|
|
415
|
-
### Example Usage
|
|
416
|
-
|
|
417
|
-
<!-- UsageSnippet language="typescript" operationID="GetAllMemories" method="get" path="/v2/memory-stores/{memory_store_key}/memories" -->
|
|
418
|
-
```typescript
|
|
419
|
-
import { Orq } from "@orq-ai/node";
|
|
420
|
-
|
|
421
|
-
const orq = new Orq({
|
|
422
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
423
|
-
});
|
|
424
|
-
|
|
425
|
-
async function run() {
|
|
426
|
-
const result = await orq.memoryStores.listMemories({
|
|
427
|
-
memoryStoreKey: "<value>",
|
|
428
|
-
});
|
|
429
|
-
|
|
430
|
-
console.log(result);
|
|
431
|
-
}
|
|
432
|
-
|
|
433
|
-
run();
|
|
434
|
-
```
|
|
435
|
-
|
|
436
|
-
### Standalone function
|
|
437
|
-
|
|
438
|
-
The standalone function version of this method:
|
|
439
|
-
|
|
440
|
-
```typescript
|
|
441
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
442
|
-
import { memoryStoresListMemories } from "@orq-ai/node/funcs/memoryStoresListMemories.js";
|
|
443
|
-
|
|
444
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
445
|
-
// You can create one instance of it to use across an application.
|
|
446
|
-
const orq = new OrqCore({
|
|
447
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
448
|
-
});
|
|
449
|
-
|
|
450
|
-
async function run() {
|
|
451
|
-
const res = await memoryStoresListMemories(orq, {
|
|
452
|
-
memoryStoreKey: "<value>",
|
|
453
|
-
});
|
|
454
|
-
if (res.ok) {
|
|
455
|
-
const { value: result } = res;
|
|
456
|
-
console.log(result);
|
|
457
|
-
} else {
|
|
458
|
-
console.log("memoryStoresListMemories failed:", res.error);
|
|
459
|
-
}
|
|
460
|
-
}
|
|
461
|
-
|
|
462
|
-
run();
|
|
463
|
-
```
|
|
464
|
-
|
|
465
|
-
### Parameters
|
|
466
|
-
|
|
467
|
-
| Parameter | Type | Required | Description |
|
|
468
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
469
|
-
| `request` | [operations.GetAllMemoriesRequest](../../models/operations/getallmemoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
470
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
471
|
-
| `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. |
|
|
472
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
473
|
-
|
|
474
|
-
### Response
|
|
475
|
-
|
|
476
|
-
**Promise\<[operations.GetAllMemoriesResponseBody](../../models/operations/getallmemoriesresponsebody.md)\>**
|
|
477
|
-
|
|
478
|
-
### Errors
|
|
479
|
-
|
|
480
|
-
| Error Type | Status Code | Content Type |
|
|
481
|
-
| --------------- | --------------- | --------------- |
|
|
482
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
483
|
-
|
|
484
|
-
## createMemory
|
|
485
|
-
|
|
486
|
-
Creates a new memory in the specified memory store.
|
|
487
|
-
|
|
488
|
-
### Example Usage
|
|
489
|
-
|
|
490
|
-
<!-- UsageSnippet language="typescript" operationID="CreateMemory" method="post" path="/v2/memory-stores/{memory_store_key}/memories" -->
|
|
491
|
-
```typescript
|
|
492
|
-
import { Orq } from "@orq-ai/node";
|
|
493
|
-
|
|
494
|
-
const orq = new Orq({
|
|
495
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
496
|
-
});
|
|
497
|
-
|
|
498
|
-
async function run() {
|
|
499
|
-
const result = await orq.memoryStores.createMemory({
|
|
500
|
-
memoryStoreKey: "<value>",
|
|
501
|
-
});
|
|
502
|
-
|
|
503
|
-
console.log(result);
|
|
504
|
-
}
|
|
505
|
-
|
|
506
|
-
run();
|
|
507
|
-
```
|
|
508
|
-
|
|
509
|
-
### Standalone function
|
|
510
|
-
|
|
511
|
-
The standalone function version of this method:
|
|
512
|
-
|
|
513
|
-
```typescript
|
|
514
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
515
|
-
import { memoryStoresCreateMemory } from "@orq-ai/node/funcs/memoryStoresCreateMemory.js";
|
|
516
|
-
|
|
517
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
518
|
-
// You can create one instance of it to use across an application.
|
|
519
|
-
const orq = new OrqCore({
|
|
520
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
521
|
-
});
|
|
522
|
-
|
|
523
|
-
async function run() {
|
|
524
|
-
const res = await memoryStoresCreateMemory(orq, {
|
|
525
|
-
memoryStoreKey: "<value>",
|
|
526
|
-
});
|
|
527
|
-
if (res.ok) {
|
|
528
|
-
const { value: result } = res;
|
|
529
|
-
console.log(result);
|
|
530
|
-
} else {
|
|
531
|
-
console.log("memoryStoresCreateMemory failed:", res.error);
|
|
532
|
-
}
|
|
533
|
-
}
|
|
534
|
-
|
|
535
|
-
run();
|
|
536
|
-
```
|
|
537
|
-
|
|
538
|
-
### Parameters
|
|
539
|
-
|
|
540
|
-
| Parameter | Type | Required | Description |
|
|
541
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
542
|
-
| `request` | [operations.CreateMemoryRequest](../../models/operations/creatememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
543
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
544
|
-
| `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. |
|
|
545
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
546
|
-
|
|
547
|
-
### Response
|
|
548
|
-
|
|
549
|
-
**Promise\<[operations.CreateMemoryResponseBody](../../models/operations/creatememoryresponsebody.md)\>**
|
|
550
|
-
|
|
551
|
-
### Errors
|
|
552
|
-
|
|
553
|
-
| Error Type | Status Code | Content Type |
|
|
554
|
-
| --------------- | --------------- | --------------- |
|
|
555
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
556
|
-
|
|
557
|
-
## retrieveMemory
|
|
558
|
-
|
|
559
|
-
Retrieves details of a specific memory by its ID
|
|
560
|
-
|
|
561
|
-
### Example Usage
|
|
562
|
-
|
|
563
|
-
<!-- UsageSnippet language="typescript" operationID="RetrieveMemory" method="get" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}" -->
|
|
564
|
-
```typescript
|
|
565
|
-
import { Orq } from "@orq-ai/node";
|
|
566
|
-
|
|
567
|
-
const orq = new Orq({
|
|
568
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
569
|
-
});
|
|
570
|
-
|
|
571
|
-
async function run() {
|
|
572
|
-
const result = await orq.memoryStores.retrieveMemory({
|
|
573
|
-
memoryStoreKey: "<value>",
|
|
574
|
-
memoryId: "<id>",
|
|
575
|
-
});
|
|
576
|
-
|
|
577
|
-
console.log(result);
|
|
578
|
-
}
|
|
579
|
-
|
|
580
|
-
run();
|
|
581
|
-
```
|
|
582
|
-
|
|
583
|
-
### Standalone function
|
|
584
|
-
|
|
585
|
-
The standalone function version of this method:
|
|
586
|
-
|
|
587
|
-
```typescript
|
|
588
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
589
|
-
import { memoryStoresRetrieveMemory } from "@orq-ai/node/funcs/memoryStoresRetrieveMemory.js";
|
|
590
|
-
|
|
591
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
592
|
-
// You can create one instance of it to use across an application.
|
|
593
|
-
const orq = new OrqCore({
|
|
594
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
595
|
-
});
|
|
596
|
-
|
|
597
|
-
async function run() {
|
|
598
|
-
const res = await memoryStoresRetrieveMemory(orq, {
|
|
599
|
-
memoryStoreKey: "<value>",
|
|
600
|
-
memoryId: "<id>",
|
|
601
|
-
});
|
|
602
|
-
if (res.ok) {
|
|
603
|
-
const { value: result } = res;
|
|
604
|
-
console.log(result);
|
|
605
|
-
} else {
|
|
606
|
-
console.log("memoryStoresRetrieveMemory failed:", res.error);
|
|
607
|
-
}
|
|
608
|
-
}
|
|
609
|
-
|
|
610
|
-
run();
|
|
611
|
-
```
|
|
612
|
-
|
|
613
|
-
### Parameters
|
|
614
|
-
|
|
615
|
-
| Parameter | Type | Required | Description |
|
|
616
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
617
|
-
| `request` | [operations.RetrieveMemoryRequest](../../models/operations/retrievememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
618
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
619
|
-
| `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. |
|
|
620
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
621
|
-
|
|
622
|
-
### Response
|
|
623
|
-
|
|
624
|
-
**Promise\<[operations.RetrieveMemoryResponseBody](../../models/operations/retrievememoryresponsebody.md)\>**
|
|
625
|
-
|
|
626
|
-
### Errors
|
|
627
|
-
|
|
628
|
-
| Error Type | Status Code | Content Type |
|
|
629
|
-
| --------------- | --------------- | --------------- |
|
|
630
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
631
|
-
|
|
632
|
-
## updateMemory
|
|
633
|
-
|
|
634
|
-
Updates the details of a specific memory.
|
|
635
|
-
|
|
636
|
-
### Example Usage
|
|
637
|
-
|
|
638
|
-
<!-- UsageSnippet language="typescript" operationID="UpdateMemory" method="patch" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}" -->
|
|
639
|
-
```typescript
|
|
640
|
-
import { Orq } from "@orq-ai/node";
|
|
641
|
-
|
|
642
|
-
const orq = new Orq({
|
|
643
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
644
|
-
});
|
|
645
|
-
|
|
646
|
-
async function run() {
|
|
647
|
-
const result = await orq.memoryStores.updateMemory({
|
|
648
|
-
memoryStoreKey: "<value>",
|
|
649
|
-
memoryId: "<id>",
|
|
650
|
-
});
|
|
651
|
-
|
|
652
|
-
console.log(result);
|
|
653
|
-
}
|
|
654
|
-
|
|
655
|
-
run();
|
|
656
|
-
```
|
|
657
|
-
|
|
658
|
-
### Standalone function
|
|
659
|
-
|
|
660
|
-
The standalone function version of this method:
|
|
661
|
-
|
|
662
|
-
```typescript
|
|
663
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
664
|
-
import { memoryStoresUpdateMemory } from "@orq-ai/node/funcs/memoryStoresUpdateMemory.js";
|
|
665
|
-
|
|
666
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
667
|
-
// You can create one instance of it to use across an application.
|
|
668
|
-
const orq = new OrqCore({
|
|
669
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
670
|
-
});
|
|
671
|
-
|
|
672
|
-
async function run() {
|
|
673
|
-
const res = await memoryStoresUpdateMemory(orq, {
|
|
674
|
-
memoryStoreKey: "<value>",
|
|
675
|
-
memoryId: "<id>",
|
|
676
|
-
});
|
|
677
|
-
if (res.ok) {
|
|
678
|
-
const { value: result } = res;
|
|
679
|
-
console.log(result);
|
|
680
|
-
} else {
|
|
681
|
-
console.log("memoryStoresUpdateMemory failed:", res.error);
|
|
682
|
-
}
|
|
683
|
-
}
|
|
684
|
-
|
|
685
|
-
run();
|
|
686
|
-
```
|
|
687
|
-
|
|
688
|
-
### Parameters
|
|
689
|
-
|
|
690
|
-
| Parameter | Type | Required | Description |
|
|
691
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
692
|
-
| `request` | [operations.UpdateMemoryRequest](../../models/operations/updatememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
693
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
694
|
-
| `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. |
|
|
695
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
696
|
-
|
|
697
|
-
### Response
|
|
698
|
-
|
|
699
|
-
**Promise\<[operations.UpdateMemoryResponseBody](../../models/operations/updatememoryresponsebody.md)\>**
|
|
700
|
-
|
|
701
|
-
### Errors
|
|
702
|
-
|
|
703
|
-
| Error Type | Status Code | Content Type |
|
|
704
|
-
| --------------- | --------------- | --------------- |
|
|
705
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
706
|
-
|
|
707
|
-
## deleteMemory
|
|
708
|
-
|
|
709
|
-
Permanently deletes a specific memory.
|
|
710
|
-
|
|
711
|
-
Use this endpoint to:
|
|
712
|
-
- Remove a memory from the store
|
|
713
|
-
- Clean up unused memories
|
|
714
|
-
- Manage memory storage space
|
|
715
|
-
|
|
716
|
-
### Example Usage
|
|
717
|
-
|
|
718
|
-
<!-- UsageSnippet language="typescript" operationID="DeleteMemory" method="delete" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}" -->
|
|
719
|
-
```typescript
|
|
720
|
-
import { Orq } from "@orq-ai/node";
|
|
721
|
-
|
|
722
|
-
const orq = new Orq({
|
|
723
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
724
|
-
});
|
|
725
|
-
|
|
726
|
-
async function run() {
|
|
727
|
-
await orq.memoryStores.deleteMemory({
|
|
728
|
-
memoryStoreKey: "<value>",
|
|
729
|
-
memoryId: "<id>",
|
|
730
|
-
});
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
}
|
|
734
|
-
|
|
735
|
-
run();
|
|
736
|
-
```
|
|
737
|
-
|
|
738
|
-
### Standalone function
|
|
739
|
-
|
|
740
|
-
The standalone function version of this method:
|
|
741
|
-
|
|
742
|
-
```typescript
|
|
743
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
744
|
-
import { memoryStoresDeleteMemory } from "@orq-ai/node/funcs/memoryStoresDeleteMemory.js";
|
|
745
|
-
|
|
746
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
747
|
-
// You can create one instance of it to use across an application.
|
|
748
|
-
const orq = new OrqCore({
|
|
749
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
750
|
-
});
|
|
751
|
-
|
|
752
|
-
async function run() {
|
|
753
|
-
const res = await memoryStoresDeleteMemory(orq, {
|
|
754
|
-
memoryStoreKey: "<value>",
|
|
755
|
-
memoryId: "<id>",
|
|
756
|
-
});
|
|
757
|
-
if (res.ok) {
|
|
758
|
-
const { value: result } = res;
|
|
759
|
-
|
|
760
|
-
} else {
|
|
761
|
-
console.log("memoryStoresDeleteMemory failed:", res.error);
|
|
762
|
-
}
|
|
763
|
-
}
|
|
764
|
-
|
|
765
|
-
run();
|
|
766
|
-
```
|
|
767
|
-
|
|
768
|
-
### Parameters
|
|
769
|
-
|
|
770
|
-
| Parameter | Type | Required | Description |
|
|
771
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
772
|
-
| `request` | [operations.DeleteMemoryRequest](../../models/operations/deletememoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
773
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
774
|
-
| `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. |
|
|
775
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
776
|
-
|
|
777
|
-
### Response
|
|
778
|
-
|
|
779
|
-
**Promise\<void\>**
|
|
780
|
-
|
|
781
|
-
### Errors
|
|
782
|
-
|
|
783
|
-
| Error Type | Status Code | Content Type |
|
|
784
|
-
| --------------- | --------------- | --------------- |
|
|
785
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
786
|
-
|
|
787
|
-
## listDocuments
|
|
788
|
-
|
|
789
|
-
Retrieves a paginated list of documents associated with a specific memory.
|
|
790
|
-
|
|
791
|
-
### Example Usage
|
|
792
|
-
|
|
793
|
-
<!-- UsageSnippet language="typescript" operationID="GetAllMemoryDocuments" method="get" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents" -->
|
|
794
|
-
```typescript
|
|
795
|
-
import { Orq } from "@orq-ai/node";
|
|
796
|
-
|
|
797
|
-
const orq = new Orq({
|
|
798
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
799
|
-
});
|
|
800
|
-
|
|
801
|
-
async function run() {
|
|
802
|
-
const result = await orq.memoryStores.listDocuments({
|
|
803
|
-
memoryStoreKey: "<value>",
|
|
804
|
-
memoryId: "<id>",
|
|
805
|
-
});
|
|
806
|
-
|
|
807
|
-
console.log(result);
|
|
808
|
-
}
|
|
809
|
-
|
|
810
|
-
run();
|
|
811
|
-
```
|
|
812
|
-
|
|
813
|
-
### Standalone function
|
|
814
|
-
|
|
815
|
-
The standalone function version of this method:
|
|
816
|
-
|
|
817
|
-
```typescript
|
|
818
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
819
|
-
import { memoryStoresListDocuments } from "@orq-ai/node/funcs/memoryStoresListDocuments.js";
|
|
820
|
-
|
|
821
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
822
|
-
// You can create one instance of it to use across an application.
|
|
823
|
-
const orq = new OrqCore({
|
|
824
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
825
|
-
});
|
|
826
|
-
|
|
827
|
-
async function run() {
|
|
828
|
-
const res = await memoryStoresListDocuments(orq, {
|
|
829
|
-
memoryStoreKey: "<value>",
|
|
830
|
-
memoryId: "<id>",
|
|
831
|
-
});
|
|
832
|
-
if (res.ok) {
|
|
833
|
-
const { value: result } = res;
|
|
834
|
-
console.log(result);
|
|
835
|
-
} else {
|
|
836
|
-
console.log("memoryStoresListDocuments failed:", res.error);
|
|
837
|
-
}
|
|
838
|
-
}
|
|
839
|
-
|
|
840
|
-
run();
|
|
841
|
-
```
|
|
842
|
-
|
|
843
|
-
### Parameters
|
|
844
|
-
|
|
845
|
-
| Parameter | Type | Required | Description |
|
|
846
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
847
|
-
| `request` | [operations.GetAllMemoryDocumentsRequest](../../models/operations/getallmemorydocumentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
848
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
849
|
-
| `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. |
|
|
850
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
851
|
-
|
|
852
|
-
### Response
|
|
853
|
-
|
|
854
|
-
**Promise\<[operations.GetAllMemoryDocumentsResponseBody](../../models/operations/getallmemorydocumentsresponsebody.md)\>**
|
|
855
|
-
|
|
856
|
-
### Errors
|
|
857
|
-
|
|
858
|
-
| Error Type | Status Code | Content Type |
|
|
859
|
-
| --------------- | --------------- | --------------- |
|
|
860
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
861
|
-
|
|
862
|
-
## createDocument
|
|
863
|
-
|
|
864
|
-
Creates a new document in the specified memory.
|
|
865
|
-
|
|
866
|
-
### Example Usage
|
|
867
|
-
|
|
868
|
-
<!-- UsageSnippet language="typescript" operationID="CreateMemoryDocument" method="post" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents" -->
|
|
869
|
-
```typescript
|
|
870
|
-
import { Orq } from "@orq-ai/node";
|
|
871
|
-
|
|
872
|
-
const orq = new Orq({
|
|
873
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
874
|
-
});
|
|
875
|
-
|
|
876
|
-
async function run() {
|
|
877
|
-
const result = await orq.memoryStores.createDocument({
|
|
878
|
-
memoryStoreKey: "<value>",
|
|
879
|
-
memoryId: "<id>",
|
|
880
|
-
});
|
|
881
|
-
|
|
882
|
-
console.log(result);
|
|
883
|
-
}
|
|
884
|
-
|
|
885
|
-
run();
|
|
886
|
-
```
|
|
887
|
-
|
|
888
|
-
### Standalone function
|
|
889
|
-
|
|
890
|
-
The standalone function version of this method:
|
|
891
|
-
|
|
892
|
-
```typescript
|
|
893
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
894
|
-
import { memoryStoresCreateDocument } from "@orq-ai/node/funcs/memoryStoresCreateDocument.js";
|
|
895
|
-
|
|
896
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
897
|
-
// You can create one instance of it to use across an application.
|
|
898
|
-
const orq = new OrqCore({
|
|
899
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
900
|
-
});
|
|
901
|
-
|
|
902
|
-
async function run() {
|
|
903
|
-
const res = await memoryStoresCreateDocument(orq, {
|
|
904
|
-
memoryStoreKey: "<value>",
|
|
905
|
-
memoryId: "<id>",
|
|
906
|
-
});
|
|
907
|
-
if (res.ok) {
|
|
908
|
-
const { value: result } = res;
|
|
909
|
-
console.log(result);
|
|
910
|
-
} else {
|
|
911
|
-
console.log("memoryStoresCreateDocument failed:", res.error);
|
|
912
|
-
}
|
|
913
|
-
}
|
|
914
|
-
|
|
915
|
-
run();
|
|
916
|
-
```
|
|
917
|
-
|
|
918
|
-
### Parameters
|
|
919
|
-
|
|
920
|
-
| Parameter | Type | Required | Description |
|
|
921
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
922
|
-
| `request` | [operations.CreateMemoryDocumentRequest](../../models/operations/creatememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
923
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
924
|
-
| `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. |
|
|
925
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
926
|
-
|
|
927
|
-
### Response
|
|
928
|
-
|
|
929
|
-
**Promise\<[operations.CreateMemoryDocumentResponseBody](../../models/operations/creatememorydocumentresponsebody.md)\>**
|
|
930
|
-
|
|
931
|
-
### Errors
|
|
932
|
-
|
|
933
|
-
| Error Type | Status Code | Content Type |
|
|
934
|
-
| --------------- | --------------- | --------------- |
|
|
935
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
936
|
-
|
|
937
|
-
## retrieveDocument
|
|
938
|
-
|
|
939
|
-
Retrieves details of a specific memory document by its ID.
|
|
940
|
-
|
|
941
|
-
### Example Usage
|
|
942
|
-
|
|
943
|
-
<!-- UsageSnippet language="typescript" operationID="RetrieveMemoryDocument" method="get" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents/{document_id}" -->
|
|
944
|
-
```typescript
|
|
945
|
-
import { Orq } from "@orq-ai/node";
|
|
946
|
-
|
|
947
|
-
const orq = new Orq({
|
|
948
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
949
|
-
});
|
|
950
|
-
|
|
951
|
-
async function run() {
|
|
952
|
-
const result = await orq.memoryStores.retrieveDocument({
|
|
953
|
-
memoryStoreKey: "<value>",
|
|
954
|
-
memoryId: "<id>",
|
|
955
|
-
documentId: "<id>",
|
|
956
|
-
});
|
|
957
|
-
|
|
958
|
-
console.log(result);
|
|
959
|
-
}
|
|
960
|
-
|
|
961
|
-
run();
|
|
962
|
-
```
|
|
963
|
-
|
|
964
|
-
### Standalone function
|
|
965
|
-
|
|
966
|
-
The standalone function version of this method:
|
|
967
|
-
|
|
968
|
-
```typescript
|
|
969
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
970
|
-
import { memoryStoresRetrieveDocument } from "@orq-ai/node/funcs/memoryStoresRetrieveDocument.js";
|
|
971
|
-
|
|
972
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
973
|
-
// You can create one instance of it to use across an application.
|
|
974
|
-
const orq = new OrqCore({
|
|
975
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
976
|
-
});
|
|
977
|
-
|
|
978
|
-
async function run() {
|
|
979
|
-
const res = await memoryStoresRetrieveDocument(orq, {
|
|
980
|
-
memoryStoreKey: "<value>",
|
|
981
|
-
memoryId: "<id>",
|
|
982
|
-
documentId: "<id>",
|
|
983
|
-
});
|
|
984
|
-
if (res.ok) {
|
|
985
|
-
const { value: result } = res;
|
|
986
|
-
console.log(result);
|
|
987
|
-
} else {
|
|
988
|
-
console.log("memoryStoresRetrieveDocument failed:", res.error);
|
|
989
|
-
}
|
|
990
|
-
}
|
|
991
|
-
|
|
992
|
-
run();
|
|
993
|
-
```
|
|
994
|
-
|
|
995
|
-
### Parameters
|
|
996
|
-
|
|
997
|
-
| Parameter | Type | Required | Description |
|
|
998
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
999
|
-
| `request` | [operations.RetrieveMemoryDocumentRequest](../../models/operations/retrievememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1000
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1001
|
-
| `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. |
|
|
1002
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1003
|
-
|
|
1004
|
-
### Response
|
|
1005
|
-
|
|
1006
|
-
**Promise\<[operations.RetrieveMemoryDocumentResponseBody](../../models/operations/retrievememorydocumentresponsebody.md)\>**
|
|
1007
|
-
|
|
1008
|
-
### Errors
|
|
1009
|
-
|
|
1010
|
-
| Error Type | Status Code | Content Type |
|
|
1011
|
-
| --------------- | --------------- | --------------- |
|
|
1012
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1013
|
-
|
|
1014
|
-
## updateDocument
|
|
1015
|
-
|
|
1016
|
-
Updates the details of a specific memory document.
|
|
1017
|
-
|
|
1018
|
-
### Example Usage
|
|
1019
|
-
|
|
1020
|
-
<!-- UsageSnippet language="typescript" operationID="UpdateMemoryDocument" method="patch" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents/{document_id}" -->
|
|
1021
|
-
```typescript
|
|
1022
|
-
import { Orq } from "@orq-ai/node";
|
|
1023
|
-
|
|
1024
|
-
const orq = new Orq({
|
|
1025
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1026
|
-
});
|
|
1027
|
-
|
|
1028
|
-
async function run() {
|
|
1029
|
-
const result = await orq.memoryStores.updateDocument({
|
|
1030
|
-
memoryStoreKey: "<value>",
|
|
1031
|
-
memoryId: "<id>",
|
|
1032
|
-
documentId: "<id>",
|
|
1033
|
-
});
|
|
1034
|
-
|
|
1035
|
-
console.log(result);
|
|
1036
|
-
}
|
|
1037
|
-
|
|
1038
|
-
run();
|
|
1039
|
-
```
|
|
1040
|
-
|
|
1041
|
-
### Standalone function
|
|
1042
|
-
|
|
1043
|
-
The standalone function version of this method:
|
|
1044
|
-
|
|
1045
|
-
```typescript
|
|
1046
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1047
|
-
import { memoryStoresUpdateDocument } from "@orq-ai/node/funcs/memoryStoresUpdateDocument.js";
|
|
1048
|
-
|
|
1049
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
1050
|
-
// You can create one instance of it to use across an application.
|
|
1051
|
-
const orq = new OrqCore({
|
|
1052
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1053
|
-
});
|
|
1054
|
-
|
|
1055
|
-
async function run() {
|
|
1056
|
-
const res = await memoryStoresUpdateDocument(orq, {
|
|
1057
|
-
memoryStoreKey: "<value>",
|
|
1058
|
-
memoryId: "<id>",
|
|
1059
|
-
documentId: "<id>",
|
|
1060
|
-
});
|
|
1061
|
-
if (res.ok) {
|
|
1062
|
-
const { value: result } = res;
|
|
1063
|
-
console.log(result);
|
|
1064
|
-
} else {
|
|
1065
|
-
console.log("memoryStoresUpdateDocument failed:", res.error);
|
|
1066
|
-
}
|
|
1067
|
-
}
|
|
1068
|
-
|
|
1069
|
-
run();
|
|
1070
|
-
```
|
|
1071
|
-
|
|
1072
|
-
### Parameters
|
|
1073
|
-
|
|
1074
|
-
| Parameter | Type | Required | Description |
|
|
1075
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1076
|
-
| `request` | [operations.UpdateMemoryDocumentRequest](../../models/operations/updatememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1077
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1078
|
-
| `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. |
|
|
1079
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1080
|
-
|
|
1081
|
-
### Response
|
|
1082
|
-
|
|
1083
|
-
**Promise\<[operations.UpdateMemoryDocumentResponseBody](../../models/operations/updatememorydocumentresponsebody.md)\>**
|
|
1084
|
-
|
|
1085
|
-
### Errors
|
|
1086
|
-
|
|
1087
|
-
| Error Type | Status Code | Content Type |
|
|
1088
|
-
| --------------- | --------------- | --------------- |
|
|
1089
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1090
|
-
|
|
1091
|
-
## deleteDocument
|
|
1092
|
-
|
|
1093
|
-
Permanently deletes a specific memory document.
|
|
1094
|
-
|
|
1095
|
-
Use this endpoint to:
|
|
1096
|
-
- Remove a document from a memory
|
|
1097
|
-
- Clean up unused documents
|
|
1098
|
-
- Manage document storage space
|
|
1099
|
-
|
|
1100
|
-
### Example Usage
|
|
1101
|
-
|
|
1102
|
-
<!-- UsageSnippet language="typescript" operationID="DeleteMemoryDocument" method="delete" path="/v2/memory-stores/{memory_store_key}/memories/{memory_id}/documents/{document_id}" -->
|
|
1103
|
-
```typescript
|
|
1104
|
-
import { Orq } from "@orq-ai/node";
|
|
1105
|
-
|
|
1106
|
-
const orq = new Orq({
|
|
1107
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1108
|
-
});
|
|
1109
|
-
|
|
1110
|
-
async function run() {
|
|
1111
|
-
await orq.memoryStores.deleteDocument({
|
|
1112
|
-
memoryStoreKey: "<value>",
|
|
1113
|
-
memoryId: "<id>",
|
|
1114
|
-
documentId: "<id>",
|
|
1115
|
-
});
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
}
|
|
1119
|
-
|
|
1120
|
-
run();
|
|
1121
|
-
```
|
|
1122
|
-
|
|
1123
|
-
### Standalone function
|
|
1124
|
-
|
|
1125
|
-
The standalone function version of this method:
|
|
1126
|
-
|
|
1127
|
-
```typescript
|
|
1128
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1129
|
-
import { memoryStoresDeleteDocument } from "@orq-ai/node/funcs/memoryStoresDeleteDocument.js";
|
|
1130
|
-
|
|
1131
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
1132
|
-
// You can create one instance of it to use across an application.
|
|
1133
|
-
const orq = new OrqCore({
|
|
1134
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1135
|
-
});
|
|
1136
|
-
|
|
1137
|
-
async function run() {
|
|
1138
|
-
const res = await memoryStoresDeleteDocument(orq, {
|
|
1139
|
-
memoryStoreKey: "<value>",
|
|
1140
|
-
memoryId: "<id>",
|
|
1141
|
-
documentId: "<id>",
|
|
1142
|
-
});
|
|
1143
|
-
if (res.ok) {
|
|
1144
|
-
const { value: result } = res;
|
|
1145
|
-
|
|
1146
|
-
} else {
|
|
1147
|
-
console.log("memoryStoresDeleteDocument failed:", res.error);
|
|
1148
|
-
}
|
|
1149
|
-
}
|
|
1150
|
-
|
|
1151
|
-
run();
|
|
1152
|
-
```
|
|
1153
|
-
|
|
1154
|
-
### Parameters
|
|
1155
|
-
|
|
1156
|
-
| Parameter | Type | Required | Description |
|
|
1157
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1158
|
-
| `request` | [operations.DeleteMemoryDocumentRequest](../../models/operations/deletememorydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1159
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1160
|
-
| `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. |
|
|
1161
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1162
|
-
|
|
1163
|
-
### Response
|
|
1164
|
-
|
|
1165
|
-
**Promise\<void\>**
|
|
1166
|
-
|
|
1167
|
-
### Errors
|
|
1168
|
-
|
|
1169
|
-
| Error Type | Status Code | Content Type |
|
|
1170
|
-
| --------------- | --------------- | --------------- |
|
|
1171
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|