@orq-ai/node 4.3.1-rc.0 → 4.3.2

package/packages/orq-rc/src/models/operations/listchunks.ts

@@ -0,0 +1,260 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Filter datasources by status.
+ */
+export type QueryParamStatus = Array<string> | string;
+
+export type ListChunksRequest = {
+  /**
+   * The unique identifier of the knowledge base
+   */
+  knowledgeId: string;
+  /**
+   * The unique identifier of the datasource.
+   */
+  datasourceId: string;
+  /**
+   * A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10
+   */
+  limit?: number | undefined;
+  /**
+   * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `after=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the next page of the list.
+   */
+  startingAfter?: string | undefined;
+  /**
+   * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `before=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the previous page of the list.
+   */
+  endingBefore?: string | undefined;
+  /**
+   * Search query to find datasources by name.
+   */
+  q?: string | undefined;
+  /**
+   * Filter datasources by status.
+   */
+  status?: Array<string> | string | undefined;
+};
+
+export const ListChunksObject = {
+  List: "list",
+} as const;
+export type ListChunksObject = ClosedEnum<typeof ListChunksObject>;
+
+export type ListChunksMetadata = string | number | boolean;
+
+/**
+ * The status of the chunk
+ */
+export const ListChunksStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Completed: "completed",
+  Failed: "failed",
+  Queued: "queued",
+} as const;
+/**
+ * The status of the chunk
+ */
+export type ListChunksStatus = ClosedEnum<typeof ListChunksStatus>;
+
+export type ListChunksData = {
+  /**
+   * The unique identifier of the chunk
+   */
+  id: string;
+  /**
+   * The text content of the chunk
+   */
+  text: string;
+  /**
+   * Metadata of the chunk. Can include `page_number` or any other key-value pairs
+   */
+  metadata?: { [k: string]: string | number | boolean } | undefined;
+  /**
+   * Whether the chunk is enabled
+   */
+  enabled: boolean;
+  /**
+   * The status of the chunk
+   */
+  status: ListChunksStatus;
+  /**
+   * The date and time the chunk was created
+   */
+  created: string;
+  /**
+   * The date and time the chunk was updated
+   */
+  updated: string;
+  /**
+   * The unique identifier of the user who created the chunk
+   */
+  createdById?: string | null | undefined;
+  /**
+   * The unique identifier of the user who updated the chunk
+   */
+  updateById?: string | null | undefined;
+};
+
+/**
+ * Chunks successfully retrieved
+ */
+export type ListChunksResponseBody = {
+  object: ListChunksObject;
+  data: Array<ListChunksData>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export type QueryParamStatus$Outbound = Array<string> | string;
+
+/** @internal */
+export const QueryParamStatus$outboundSchema: z.ZodType<
+  QueryParamStatus$Outbound,
+  z.ZodTypeDef,
+  QueryParamStatus
+> = z.union([z.array(z.string()), z.string()]);
+
+export function queryParamStatusToJSON(
+  queryParamStatus: QueryParamStatus,
+): string {
+  return JSON.stringify(
+    QueryParamStatus$outboundSchema.parse(queryParamStatus),
+  );
+}
+
+/** @internal */
+export type ListChunksRequest$Outbound = {
+  knowledge_id: string;
+  datasource_id: string;
+  limit: number;
+  starting_after?: string | undefined;
+  ending_before?: string | undefined;
+  q?: string | undefined;
+  status?: Array<string> | string | undefined;
+};
+
+/** @internal */
+export const ListChunksRequest$outboundSchema: z.ZodType<
+  ListChunksRequest$Outbound,
+  z.ZodTypeDef,
+  ListChunksRequest
+> = z.object({
+  knowledgeId: z.string(),
+  datasourceId: z.string(),
+  limit: z.number().int().default(10),
+  startingAfter: z.string().optional(),
+  endingBefore: z.string().optional(),
+  q: z.string().optional(),
+  status: z.union([z.array(z.string()), z.string()]).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    knowledgeId: "knowledge_id",
+    datasourceId: "datasource_id",
+    startingAfter: "starting_after",
+    endingBefore: "ending_before",
+  });
+});
+
+export function listChunksRequestToJSON(
+  listChunksRequest: ListChunksRequest,
+): string {
+  return JSON.stringify(
+    ListChunksRequest$outboundSchema.parse(listChunksRequest),
+  );
+}
+
+/** @internal */
+export const ListChunksObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListChunksObject
+> = z.nativeEnum(ListChunksObject);
+
+/** @internal */
+export const ListChunksMetadata$inboundSchema: z.ZodType<
+  ListChunksMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+export function listChunksMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<ListChunksMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListChunksMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListChunksMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListChunksStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ListChunksStatus
+> = z.nativeEnum(ListChunksStatus);
+
+/** @internal */
+export const ListChunksData$inboundSchema: z.ZodType<
+  ListChunksData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  text: z.string(),
+  metadata: z.record(z.union([z.string(), z.number(), z.boolean()])).optional(),
+  enabled: z.boolean(),
+  status: ListChunksStatus$inboundSchema,
+  created: z.string(),
+  updated: z.string(),
+  created_by_id: z.nullable(z.string()).optional(),
+  update_by_id: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "created_by_id": "createdById",
+    "update_by_id": "updateById",
+  });
+});
+
+export function listChunksDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ListChunksData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListChunksData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListChunksData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListChunksResponseBody$inboundSchema: z.ZodType<
+  ListChunksResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListChunksObject$inboundSchema,
+  data: z.array(z.lazy(() => ListChunksData$inboundSchema)),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listChunksResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListChunksResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListChunksResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListChunksResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/listchunkspaginated.ts

@@ -0,0 +1,263 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListChunksPaginatedRequestBody = {
+  /**
+   * Search query to find chunks by text content
+   */
+  q?: string | undefined;
+  /**
+   * Filter chunks by enabled status
+   */
+  enabled?: boolean | undefined;
+  /**
+   * Filter chunks by processing status
+   */
+  status?: string | undefined;
+  limit?: number | undefined;
+  page?: number | undefined;
+};
+
+export type ListChunksPaginatedRequest = {
+  /**
+   * The unique identifier of the knowledge base
+   */
+  knowledgeId: string;
+  /**
+   * The unique identifier of the datasource.
+   */
+  datasourceId: string;
+  requestBody?: ListChunksPaginatedRequestBody | undefined;
+};
+
+export const ListChunksPaginatedObject = {
+  List: "list",
+} as const;
+export type ListChunksPaginatedObject = ClosedEnum<
+  typeof ListChunksPaginatedObject
+>;
+
+export type ListChunksPaginatedMetadata = string | number | boolean;
+
+/**
+ * The status of the chunk
+ */
+export const ListChunksPaginatedStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Completed: "completed",
+  Failed: "failed",
+  Queued: "queued",
+} as const;
+/**
+ * The status of the chunk
+ */
+export type ListChunksPaginatedStatus = ClosedEnum<
+  typeof ListChunksPaginatedStatus
+>;
+
+export type ListChunksPaginatedData = {
+  /**
+   * The unique identifier of the chunk
+   */
+  id: string;
+  /**
+   * The text content of the chunk
+   */
+  text: string;
+  /**
+   * Metadata of the chunk. Can include `page_number` or any other key-value pairs
+   */
+  metadata?: { [k: string]: string | number | boolean } | undefined;
+  /**
+   * Whether the chunk is enabled
+   */
+  enabled: boolean;
+  /**
+   * The status of the chunk
+   */
+  status: ListChunksPaginatedStatus;
+  /**
+   * The date and time the chunk was created
+   */
+  created: string;
+  /**
+   * The date and time the chunk was updated
+   */
+  updated: string;
+  /**
+   * The unique identifier of the user who created the chunk
+   */
+  createdById?: string | null | undefined;
+  /**
+   * The unique identifier of the user who updated the chunk
+   */
+  updateById?: string | null | undefined;
+};
+
+/**
+ * Chunks successfully retrieved
+ */
+export type ListChunksPaginatedResponseBody = {
+  object: ListChunksPaginatedObject;
+  data: Array<ListChunksPaginatedData>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export type ListChunksPaginatedRequestBody$Outbound = {
+  q: string;
+  enabled?: boolean | undefined;
+  status?: string | undefined;
+  limit: number;
+  page: number;
+};
+
+/** @internal */
+export const ListChunksPaginatedRequestBody$outboundSchema: z.ZodType<
+  ListChunksPaginatedRequestBody$Outbound,
+  z.ZodTypeDef,
+  ListChunksPaginatedRequestBody
+> = z.object({
+  q: z.string().default(""),
+  enabled: z.boolean().optional(),
+  status: z.string().optional(),
+  limit: z.number().int().default(100),
+  page: z.number().int().default(1),
+});
+
+export function listChunksPaginatedRequestBodyToJSON(
+  listChunksPaginatedRequestBody: ListChunksPaginatedRequestBody,
+): string {
+  return JSON.stringify(
+    ListChunksPaginatedRequestBody$outboundSchema.parse(
+      listChunksPaginatedRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type ListChunksPaginatedRequest$Outbound = {
+  knowledge_id: string;
+  datasource_id: string;
+  RequestBody?: ListChunksPaginatedRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const ListChunksPaginatedRequest$outboundSchema: z.ZodType<
+  ListChunksPaginatedRequest$Outbound,
+  z.ZodTypeDef,
+  ListChunksPaginatedRequest
+> = z.object({
+  knowledgeId: z.string(),
+  datasourceId: z.string(),
+  requestBody: z.lazy(() => ListChunksPaginatedRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    knowledgeId: "knowledge_id",
+    datasourceId: "datasource_id",
+    requestBody: "RequestBody",
+  });
+});
+
+export function listChunksPaginatedRequestToJSON(
+  listChunksPaginatedRequest: ListChunksPaginatedRequest,
+): string {
+  return JSON.stringify(
+    ListChunksPaginatedRequest$outboundSchema.parse(listChunksPaginatedRequest),
+  );
+}
+
+/** @internal */
+export const ListChunksPaginatedObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListChunksPaginatedObject
+> = z.nativeEnum(ListChunksPaginatedObject);
+
+/** @internal */
+export const ListChunksPaginatedMetadata$inboundSchema: z.ZodType<
+  ListChunksPaginatedMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+export function listChunksPaginatedMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<ListChunksPaginatedMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListChunksPaginatedMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListChunksPaginatedMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListChunksPaginatedStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ListChunksPaginatedStatus
+> = z.nativeEnum(ListChunksPaginatedStatus);
+
+/** @internal */
+export const ListChunksPaginatedData$inboundSchema: z.ZodType<
+  ListChunksPaginatedData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  text: z.string(),
+  metadata: z.record(z.union([z.string(), z.number(), z.boolean()])).optional(),
+  enabled: z.boolean(),
+  status: ListChunksPaginatedStatus$inboundSchema,
+  created: z.string(),
+  updated: z.string(),
+  created_by_id: z.nullable(z.string()).optional(),
+  update_by_id: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "created_by_id": "createdById",
+    "update_by_id": "updateById",
+  });
+});
+
+export function listChunksPaginatedDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ListChunksPaginatedData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListChunksPaginatedData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListChunksPaginatedData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListChunksPaginatedResponseBody$inboundSchema: z.ZodType<
+  ListChunksPaginatedResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListChunksPaginatedObject$inboundSchema,
+  data: z.array(z.lazy(() => ListChunksPaginatedData$inboundSchema)),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listChunksPaginatedResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListChunksPaginatedResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListChunksPaginatedResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListChunksPaginatedResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/listconversations.ts

@@ -0,0 +1,104 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListConversationsRequest = {
+  /**
+   * Maximum number of conversations to return. Range: 1-100. Default: 10.
+   */
+  limit?: number | undefined;
+  /**
+   * Pagination cursor. Returns conversations created after the specified conversation ID.
+   */
+  startingAfter?: string | undefined;
+  /**
+   * Pagination cursor. Returns conversations created before the specified conversation ID.
+   */
+  endingBefore?: string | undefined;
+  /**
+   * Filter by parent entity. When specified, returns only conversations associated with this entity. When omitted, returns standalone conversations.
+   */
+  entityId?: string | undefined;
+};
+
+export const ListConversationsObject = {
+  List: "list",
+} as const;
+export type ListConversationsObject = ClosedEnum<
+  typeof ListConversationsObject
+>;
+
+/**
+ * Successfully retrieved the list of conversations. Returns a paginated response containing conversation objects.
+ */
+export type ListConversationsResponseBody = {
+  object: ListConversationsObject;
+  data: Array<components.ConversationResponse>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export type ListConversationsRequest$Outbound = {
+  limit?: number | undefined;
+  startingAfter?: string | undefined;
+  endingBefore?: string | undefined;
+  entityId?: string | undefined;
+};
+
+/** @internal */
+export const ListConversationsRequest$outboundSchema: z.ZodType<
+  ListConversationsRequest$Outbound,
+  z.ZodTypeDef,
+  ListConversationsRequest
+> = z.object({
+  limit: z.number().int().optional(),
+  startingAfter: z.string().optional(),
+  endingBefore: z.string().optional(),
+  entityId: z.string().optional(),
+});
+
+export function listConversationsRequestToJSON(
+  listConversationsRequest: ListConversationsRequest,
+): string {
+  return JSON.stringify(
+    ListConversationsRequest$outboundSchema.parse(listConversationsRequest),
+  );
+}
+
+/** @internal */
+export const ListConversationsObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListConversationsObject
+> = z.nativeEnum(ListConversationsObject);
+
+/** @internal */
+export const ListConversationsResponseBody$inboundSchema: z.ZodType<
+  ListConversationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListConversationsObject$inboundSchema,
+  data: z.array(components.ConversationResponse$inboundSchema),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listConversationsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListConversationsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListConversationsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListConversationsResponseBody' from JSON`,
+  );
+}