@orq-ai/node 4.4.0-rc.9 → 4.4.1

package/packages/orq-rc/src/funcs/agentsResponsesCreate.ts

@@ -0,0 +1,183 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { OrqError } from "../models/errors/orqerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export enum CreateAcceptEnum {
+  applicationJson = "application/json",
+  textEventStream = "text/event-stream",
+}
+
+/**
+ * Create response
+ *
+ * @remarks
+ * Initiates an agent conversation and returns a complete response. This endpoint manages the full lifecycle of an agent interaction, from receiving the initial message through all processing steps until completion. Supports synchronous execution (waits for completion) and asynchronous execution (returns immediately with task ID). The response includes all messages exchanged, tool calls made, and token usage statistics. Ideal for request-response patterns where you need the complete interaction result.
+ */
+export function agentsResponsesCreate(
+  client: OrqCore,
+  requestBody: operations.CreateAgentResponseRequestRequestBody,
+  agentKey: string,
+  options?: RequestOptions & { acceptHeaderOverride?: CreateAcceptEnum },
+): APIPromise<
+  Result<
+    operations.CreateAgentResponseRequestResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    requestBody,
+    agentKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  requestBody: operations.CreateAgentResponseRequestRequestBody,
+  agentKey: string,
+  options?: RequestOptions & { acceptHeaderOverride?: CreateAcceptEnum },
+): Promise<
+  [
+    Result<
+      operations.CreateAgentResponseRequestResponse,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.CreateAgentResponseRequestRequest = {
+    requestBody: requestBody,
+    agentKey: agentKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.CreateAgentResponseRequestRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+
+  const pathParams = {
+    agent_key: encodeSimple("agent_key", payload.agent_key, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/agents/{agent_key}/responses")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: options?.acceptHeaderOverride
+      || "application/json;q=1, text/event-stream;q=0",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "CreateAgentResponseRequest",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    operations.CreateAgentResponseRequestResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.CreateAgentResponseRequestResponse$inboundSchema),
+    M.sse(200, operations.CreateAgentResponseRequestResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/packages/orq-rc/src/funcs/agentsRetrieve.ts

@@ -0,0 +1,180 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { OrqError } from "../models/errors/orqerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Retrieve agent
+ *
+ * @remarks
+ * Retrieves detailed information about a specific agent identified by its unique key or identifier. Returns the complete agent manifest including configuration settings, model assignments (primary and fallback), tools, knowledge bases, memory stores, instructions, and execution parameters. Use this endpoint to fetch the current state and configuration of an individual agent.
+ */
+export function agentsRetrieve(
+  client: OrqCore,
+  agentKey: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.RetrieveAgentRequestResponseBody,
+    | errors.RetrieveAgentRequestResponseBody
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    agentKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  agentKey: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.RetrieveAgentRequestResponseBody,
+      | errors.RetrieveAgentRequestResponseBody
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.RetrieveAgentRequestRequest = {
+    agentKey: agentKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.RetrieveAgentRequestRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    agent_key: encodeSimple("agent_key", payload.agent_key, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/agents/{agent_key}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "RetrieveAgentRequest",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["404", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.RetrieveAgentRequestResponseBody,
+    | errors.RetrieveAgentRequestResponseBody
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.RetrieveAgentRequestResponseBody$inboundSchema),
+    M.jsonErr(404, errors.RetrieveAgentRequestResponseBody$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/packages/orq-rc/src/funcs/agentsRun.ts

@@ -0,0 +1,162 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { OrqError } from "../models/errors/orqerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Run an agent with configuration
+ *
+ * @remarks
+ * Executes an agent using inline configuration or references an existing agent. Supports dynamic agent creation where the system automatically manages agent versioning - reusing existing agents with matching configurations or creating new versions when configurations differ. Ideal for programmatic agent execution with flexible configuration management. The agent processes messages in A2A format with support for memory context, tool execution, and automatic model fallback on failure.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export function agentsRun(
+  client: OrqCore,
+  request: operations.RunAgentRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.RunAgentA2ATaskResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: operations.RunAgentRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.RunAgentA2ATaskResponse,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.RunAgentRequestBody$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/agents/run")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "RunAgent",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    operations.RunAgentA2ATaskResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.RunAgentA2ATaskResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/{src/funcs/conversationsGenerateName.ts → packages/orq-rc/src/funcs/agentsStream.ts}

@@ -2,8 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import * as z from "zod/v3";
 import { OrqCore } from "../core.js";
 import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { EventStream } from "../lib/event-streams.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -26,21 +28,22 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Generate conversation name
+ * Stream agent execution in real-time
  *
  * @remarks
- * Generates a display name for a conversation using AI based on the provided context. Updates the conversation with the generated name and sets generatingTitle to false.
+ * Executes an agent and streams the interaction in real-time using Server-Sent Events (SSE). Provides live updates as the agent processes the request, including message chunks, tool calls, and execution status. Perfect for building responsive chat interfaces and monitoring agent progress. The stream continues until the agent completes its task, encounters an error, or reaches the configured timeout (default 30 minutes, configurable 1-3600 seconds).
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
-export function conversationsGenerateName(
+export function agentsStream(
   client: OrqCore,
-  requestBody: operations.GenerateConversationNameRequestBody,
-  conversationId: string,
+  requestBody: operations.StreamAgentRequestBody,
+  key: string,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GenerateConversationNameResponseBody,
-    | errors.GenerateConversationNameResponseBody
-    | errors.GenerateConversationNameConversationsResponseBody
+    EventStream<operations.StreamAgentResponseBody>,
+    | errors.StreamAgentResponseBody
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -54,22 +57,21 @@ export function conversationsGenerateName(
   return new APIPromise($do(
     client,
     requestBody,
-    conversationId,
+    key,
     options,
   ));
 }
 
 async function $do(
   client: OrqCore,
-  requestBody: operations.GenerateConversationNameRequestBody,
-  conversationId: string,
+  requestBody: operations.StreamAgentRequestBody,
+  key: string,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.GenerateConversationNameResponseBody,
-      | errors.GenerateConversationNameResponseBody
-      | errors.GenerateConversationNameConversationsResponseBody
+      EventStream<operations.StreamAgentResponseBody>,
+      | errors.StreamAgentResponseBody
       | OrqError
       | ResponseValidationError
       | ConnectionError
@@ -82,15 +84,14 @@ async function $do(
     APICall,
   ]
 > {
-  const input: operations.GenerateConversationNameRequest = {
+  const input: operations.StreamAgentRequest = {
     requestBody: requestBody,
-    conversationId: conversationId,
+    key: key,
   };
 
   const parsed = safeParse(
     input,
-    (value) =>
-      operations.GenerateConversationNameRequest$outboundSchema.parse(value),
+    (value) => operations.StreamAgentRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -100,19 +101,17 @@ async function $do(
   const body = encodeJSON("body", payload.RequestBody, { explode: true });
 
   const pathParams = {
-    conversation_id: encodeSimple("conversation_id", payload.conversation_id, {
+    key: encodeSimple("key", payload.key, {
       explode: false,
       charEncoding: "percent",
     }),
   };
 
-  const path = pathToFunc("/v2/conversations/{conversation_id}/generate-name")(
-    pathParams,
-  );
+  const path = pathToFunc("/v2/agents/{key}/stream-task")(pathParams);
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
-    Accept: "application/json",
+    Accept: "text/event-stream",
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -122,7 +121,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "GenerateConversationName",
+    operationID: "StreamAgent",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -151,7 +150,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["400", "404", "4XX", "5XX"],
+    errorCodes: ["404", "4XX", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -165,9 +164,8 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.GenerateConversationNameResponseBody,
-    | errors.GenerateConversationNameResponseBody
-    | errors.GenerateConversationNameConversationsResponseBody
+    EventStream<operations.StreamAgentResponseBody>,
+    | errors.StreamAgentResponseBody
     | OrqError
     | ResponseValidationError
     | ConnectionError
@@ -177,12 +175,21 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GenerateConversationNameResponseBody$inboundSchema),
-    M.jsonErr(400, errors.GenerateConversationNameResponseBody$inboundSchema),
-    M.jsonErr(
-      404,
-      errors.GenerateConversationNameConversationsResponseBody$inboundSchema,
+    M.sse(
+      200,
+      z.instanceof(ReadableStream<Uint8Array>)
+        .transform(stream => {
+          return new EventStream(stream, rawEvent => {
+            if (rawEvent.data === "[DONE]") return { done: true };
+            return {
+              value: operations.StreamAgentResponseBody$inboundSchema.parse(
+                rawEvent,
+              ),
+            };
+          });
+        }),
     ),
+    M.jsonErr(404, errors.StreamAgentResponseBody$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });