@or-sdk/agents 4.21.8-beta.4275.0 → 4.21.8-beta.4276.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.
Files changed (2) hide show
  1. package/README.md +34 -0
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -357,3 +357,37 @@ Delete a template by its ID.
357
357
  ```typescript
358
358
  await agents.deleteTemplate('template-id');
359
359
  ```
360
+
361
+
362
+ ## Additional API reference
363
+
364
+ Methods below were missing from the package guide. Signatures and return types are taken directly from the exported source API.
365
+
366
+ ### `Agents`
367
+
368
+ | Method | Returns | Purpose |
369
+ |---|---|---|
370
+ | `parseError(err: unknown)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
371
+ | `getAgentVersions(agentId: string, options: CallOptions = {})` | `Promise<AgentVersion[]>` | Get an agent by its ID. |
372
+ | `releaseAgent(agentId: string, data: ReleaseVersion, options: CallOptions = {})` | `Promise<void>` | Releases agent's development version by ID. |
373
+ | `getAgentExecutionList(agentId: string, params: { size?: number; from?: number; orderBy?: string; order?: 'ASC' \| 'DESC'; query?: string; flowIds?: string[]; dateRange?: { field: 'updatedAt' \| 'createdAt'; from?: Date; to?: Date; }; } = {}, options: CallOptions = {})` | `Promise<ExecutionList>` | Retrieves a list of agent executions for a given agent. |
374
+ | `patchAgentExecution(agentId: string, executionId: string, patch: { summary?: string; }, options: CallOptions = {})` | `Promise<void>` | Partially updates an execution belonging to an agent. |
375
+ | `setSessionId(sessionId: string)` | `string` | Set the session ID. |
376
+ | `htmlToPassages(url: string, question: string, options: CallOptions = {})` | `Promise<string[]>` | Get markdown for passed url |
377
+ | `createAgentTestCase(cases: CreateTestCase \| CreateTestCase[])` | `Promise<void>` | Creates one or multiple agent test cases by sending a POST request to the 'agents/testing' endpoint. |
378
+ | `updateAgentTestCase(testCaseId: string, params: Partial<CreateTestCase>, options: CallOptions = {})` | `Promise<TestCase>` | Updates an existing agent test case with the specified parameters. |
379
+ | `deleteAgentTestCase(testCaseId: string, options: CallOptions = {})` | `Promise<TestCase>` | Deletes a specific agent test case by its ID. |
380
+ | `fetchAgentTestCases(params: { agentId: string; agentVersionId: string; }, options: CallOptions = {})` | `Promise<TestCase[]>` | Fetches the test cases for a specific agent version. |
381
+ | `runAgentTestCase(data: { agentId: string; agentVersionId: string; testCaseIds: string[]; })` | `Promise<void>` | Executes a set of test cases for a specific agent and its version. |
382
+ | `terminateAgentTestCase(data: { agentId: string; agentVersionId: string; testCaseIds: string[]; })` | `Promise<void>` | Terminates one or more agent test cases for a specific agent and version. |
383
+ | `configureAgent(agentId: string, agentVersionId: string, executionId: string, flowId: string, overrides: Partial<Agent>, options: CallOptions = {})` | `Promise<Agent>` | See the exported TypeScript signature for behavior and constraints. |
384
+ | `createResponse(requestBody: OpenAI.Responses.ResponseCreateParamsNonStreaming & Record<string, unknown>)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
385
+
386
+
387
+ ## Exported utility reference
388
+
389
+ | Function | Returns | Purpose |
390
+ |---|---|---|
391
+ | `createErrorParser(...processors: ErrorProcessor<E>[])` | `unknown` | Exported utility; see its TypeScript signature for behavior. |
392
+ | `parseAxiosError(e: AxiosError)` | `Error` | Exported utility; see its TypeScript signature for behavior. |
393
+ | `isOrNetworkError(err: unknown)` | `err is OrNetworkError` | Exported utility; see its TypeScript signature for behavior. |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/agents",
3
- "version": "4.21.8-beta.4275.0",
3
+ "version": "4.21.8-beta.4276.0",
4
4
  "description": "OneReach SDK client for Agents",
5
5
  "license": "Apache-2.0",
6
6
  "main": "dist/cjs/index.js",
@@ -29,8 +29,8 @@
29
29
  "@graphql-tools/merge": "^9.0.7",
30
30
  "@graphql-tools/schema": "^10.0.6",
31
31
  "@or-sdk/base": "^0.44.7",
32
- "@or-sdk/bots": "^1.7.6-beta.4275.0",
33
- "@or-sdk/deployer": "^1.7.9-beta.4275.0",
32
+ "@or-sdk/bots": "^1.7.6-beta.4276.0",
33
+ "@or-sdk/deployer": "^1.7.9-beta.4276.0",
34
34
  "dedent": "^1.5.1",
35
35
  "graphql": "^16.8.1",
36
36
  "graphql-tag": "^2.12.6",