@functional-systems/lambdadb 0.4.1 → 0.4.3

package/src/client.ts

@@ -23,6 +23,7 @@ import { collectionsDocsDelete } from "./funcs/collectionsDocsDelete.js";
 import { collectionsDocsFetch } from "./funcs/collectionsDocsFetch.js";
 import { collectionsDocsGetBulkUpsert } from "./funcs/collectionsDocsGetBulkUpsert.js";
 import { collectionsDocsListDocs } from "./funcs/collectionsDocsListDocs.js";
+import { collectionsDocsListDocsExtended } from "./funcs/collectionsDocsListDocsExtended.js";
 import { collectionsDocsUpdate } from "./funcs/collectionsDocsUpdate.js";
 import { collectionsDocsUpsert } from "./funcs/collectionsDocsUpsert.js";
 import type { RequestOptions } from "./lib/sdks.js";
@@ -438,12 +439,36 @@ class CollectionDocs {
     params?: ListDocsInput,
     options?: RequestOptions,
   ) {
+    const useExtendedList = params?.filter != null
+      || params?.partitionFilter != null
+      || params?.fields != null;
     const result = await unwrapAsync(
-      collectionsDocsListDocs(
-        this.client,
-        { collectionName: this.collectionName, ...params },
-        options,
-      ),
+      useExtendedList
+        ? collectionsDocsListDocsExtended(
+          this.client,
+          {
+            collectionName: this.collectionName,
+            requestBody: {
+              size: params?.size,
+              pageToken: params?.pageToken,
+              filter: params?.filter,
+              partitionFilter: params?.partitionFilter,
+              fields: params?.fields,
+              includeVectors: params?.includeVectors,
+            },
+          },
+          options,
+        )
+        : collectionsDocsListDocs(
+          this.client,
+          {
+            collectionName: this.collectionName,
+            size: params?.size,
+            pageToken: params?.pageToken,
+            includeVectors: params?.includeVectors,
+          },
+          options,
+        ),
     );
     if (!result.isDocsInline && result.docsUrl) {
       const docs = await fetchDocsFromUrl<ListDocsDoc>(result.docsUrl);
@@ -460,11 +485,35 @@ class CollectionDocs {
     params?: ListDocsInput,
     options?: RequestOptions,
   ): Promise<Result<ListDocsResponse, ListDocsError>> {
-    const result = await collectionsDocsListDocs(
-      this.client,
-      { collectionName: this.collectionName, ...params },
-      options,
-    );
+    const useExtendedList = params?.filter != null
+      || params?.partitionFilter != null
+      || params?.fields != null;
+    const result = useExtendedList
+      ? await collectionsDocsListDocsExtended(
+        this.client,
+        {
+          collectionName: this.collectionName,
+          requestBody: {
+            size: params?.size,
+            pageToken: params?.pageToken,
+            filter: params?.filter,
+            partitionFilter: params?.partitionFilter,
+            fields: params?.fields,
+            includeVectors: params?.includeVectors,
+          },
+        },
+        options,
+      )
+      : await collectionsDocsListDocs(
+        this.client,
+        {
+          collectionName: this.collectionName,
+          size: params?.size,
+          pageToken: params?.pageToken,
+          includeVectors: params?.includeVectors,
+        },
+        options,
+      );
     if (!result.ok) return result;
     if (!result.value.isDocsInline && result.value.docsUrl) {
       try {
@@ -494,7 +543,14 @@ class CollectionDocs {
     options?: RequestOptions,
   ): AsyncGenerator<ListDocsResponse> {
     let pageToken: string | undefined = params?.pageToken;
-    const baseParams: ListDocsInput = { size: params?.size, pageToken };
+    const baseParams: ListDocsInput = {
+      size: params?.size,
+      pageToken,
+      filter: params?.filter,
+      partitionFilter: params?.partitionFilter,
+      fields: params?.fields,
+      includeVectors: params?.includeVectors,
+    };
     while (true) {
       const page = await this.list({ ...baseParams, pageToken }, options);
       yield page;

package/src/compat/qdrant/client.ts

@@ -1,6 +1,6 @@
 import { LambdaDBClient, type LambdaDBClientOptions } from "../../client.js";
 import { ResourceNotFoundError } from "../../models/errors/index.js";
-import type { CreateCollectionInput } from "../../types/public.js";
+import type { CreateCollectionInput, ListDocsInput } from "../../types/public.js";
 import {
   ORIGINAL_ID_FIELD,
   mergeIndexConfigs,
@@ -24,6 +24,7 @@ import {
 } from "./errors.js";
 
 type JsonObject = { [key: string]: unknown };
+type ListDocsBody = ListDocsInput;
 
 type CollectionLike = {
   get(): Promise<{ collection: JsonObject }>;
@@ -34,7 +35,7 @@ type CollectionLike = {
     upsert(body: { docs: JsonObject[] }): Promise<unknown>;
     fetch(body: JsonObject): Promise<{ docs: unknown[] }>;
     delete(body: { ids?: string[]; filter?: JsonObject }): Promise<unknown>;
-    list(body?: { size?: number; pageToken?: string }): Promise<{
+    list(body?: ListDocsBody): Promise<{
       docs: unknown[];
       nextPageToken?: string | undefined;
     }>;
@@ -615,6 +616,7 @@ export class QdrantCompatClient {
     options: {
       scrollFilter?: models.Filter | JsonObject | null;
       scroll_filter?: models.Filter | JsonObject | null;
+      offset?: string | number | undefined;
       limit?: number | undefined;
       withPayload?: PayloadSelector | undefined;
       with_payload?: PayloadSelector | undefined;
@@ -626,6 +628,7 @@ export class QdrantCompatClient {
     const {
       scrollFilter,
       scroll_filter: scrollFilterSnake,
+      offset,
       limit = 10,
       withPayload,
       with_payload: withPayloadSnake,
@@ -634,19 +637,27 @@ export class QdrantCompatClient {
       ...rest
     } = options;
     warnIgnored(rest);
-    if (scrollFilter !== undefined || scrollFilterSnake !== undefined) {
-      throw new UnsupportedQdrantFeatureError("Filtered scroll is not supported in v1");
+    if (offset !== undefined && typeof offset !== "string") {
+      throw new UnsupportedQdrantFeatureError(
+        "Qdrant point-id scroll offsets are not supported; use the returned LambdaDB page-token offset",
+      );
     }
     const payloadSelector = normalizePayloadSelector(withPayload ?? withPayloadSnake ?? true);
     const vectorSelector = normalizeVectorSelector(withVectors ?? withVectorsSnake ?? false);
-    if (vectorSelector !== false) {
-      throw new UnsupportedQdrantFeatureError("Scroll with vectors is not supported in v1");
-    }
-    const response = await this.client.collection(collectionName).docs.list({ size: limit });
+    const fields = fieldsForSelectors(payloadSelector, vectorSelector);
+    const convertedFilter = filterToLambdaDB(scrollFilter ?? scrollFilterSnake);
+    const listBody: ListDocsBody = {
+      size: limit,
+      includeVectors: vectorSelector !== false,
+    };
+    if (offset !== undefined) listBody.pageToken = offset;
+    if (Object.keys(convertedFilter).length > 0) listBody.filter = convertedFilter;
+    if (fields !== undefined) listBody.fields = fields;
+    const response = await this.client.collection(collectionName).docs.list(listBody);
     return [
       response.docs.map((doc) => docToRecord(doc, {
         withPayload: payloadSelector,
-        withVectors: false,
+        withVectors: vectorSelector,
       })),
       response.nextPageToken,
     ];

package/src/compat/qdrant/filters.ts

@@ -92,9 +92,11 @@ function matchQueries(field: string, rawMatch: unknown): LambdaDBQuery[] {
     return match.except.map((value) => queryString(`${field}:${formatScalar(value)}`));
   }
   if (match instanceof MatchText) {
-    throw new UnsupportedQdrantFeatureError(
-      "MatchText is not supported in the v1 Qdrant compatibility filter",
-    );
+    const terms = match.text.split(/\s+/).filter(Boolean);
+    if (terms.length === 0) {
+      throw new QdrantCompatValidationError("MatchText text must not be empty");
+    }
+    return terms.map((term) => queryString(`${field}:${formatScalar(term)}`));
   }
 
   throw new UnsupportedQdrantFeatureError(

package/src/funcs/collectionsDocsListDocs.ts

@@ -103,6 +103,7 @@ async function $do(
   const path = pathToFunc("/collections/{collectionName}/docs")(pathParams);
 
   const query = encodeFormQuery({
+    "includeVectors": payload.includeVectors,
     "pageToken": payload.pageToken,
     "size": payload.size,
   });

package/src/funcs/collectionsDocsListDocsExtended.ts

@@ -0,0 +1,201 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { LambdaDBCore } 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 * as errors from "../models/errors/index.js";
+import { LambdaDBError } from "../models/errors/lambdadberror.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";
+
+/**
+ * List documents in a collection with optional filters, field selection, and vector inclusion.
+ */
+export function collectionsDocsListDocsExtended(
+  client: LambdaDBCore,
+  request: operations.ListDocsExtendedRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListDocsResponse,
+    | errors.BadRequestError
+    | errors.UnauthenticatedError
+    | errors.ResourceNotFoundError
+    | errors.TooManyRequestsError
+    | errors.InternalServerError
+    | LambdaDBError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: LambdaDBCore,
+  request: operations.ListDocsExtendedRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ListDocsResponse,
+      | errors.BadRequestError
+      | errors.UnauthenticatedError
+      | errors.ResourceNotFoundError
+      | errors.TooManyRequestsError
+      | errors.InternalServerError
+      | LambdaDBError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ListDocsExtendedRequest$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 = {
+    collectionName: encodeSimple("collectionName", payload.collectionName, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/collections/{collectionName}/docs/list")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.projectApiKey);
+  const securityInput = secConfig == null ? {} : { projectApiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listDocsExtended",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.projectApiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "5XX"],
+  };
+
+  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 || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "404", "429", "4XX", "500", "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.ListDocsResponse,
+    | errors.BadRequestError
+    | errors.UnauthenticatedError
+    | errors.ResourceNotFoundError
+    | errors.TooManyRequestsError
+    | errors.InternalServerError
+    | LambdaDBError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListDocsResponse$inboundSchema),
+    M.jsonErr(400, errors.BadRequestError$inboundSchema),
+    M.jsonErr(401, errors.UnauthenticatedError$inboundSchema),
+    M.jsonErr(404, errors.ResourceNotFoundError$inboundSchema),
+    M.jsonErr(429, errors.TooManyRequestsError$inboundSchema),
+    M.jsonErr(500, errors.InternalServerError$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/src/lib/config.ts

@@ -73,8 +73,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.1.1",
-  sdkVersion: "0.2.1",
+  sdkVersion: "0.4.3",
   genVersion: "2.798.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.2.1 2.798.0 1.1.1 @functional-systems/lambdadb",
+    "speakeasy-sdk/typescript 0.4.3 2.798.0 1.1.1 @functional-systems/lambdadb",
 } as const;

package/src/models/operations/listdocs.ts

@@ -3,9 +3,11 @@
  */
 
 import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
 import { nullToUndefined, safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as models from "../index.js";
 
 export type ListDocsRequest = {
   /**
@@ -20,6 +22,10 @@ export type ListDocsRequest = {
    * Next page token.
    */
   pageToken?: string | undefined;
+  /**
+   * Set to true to include vector values in the response. Defaults to false.
+   */
+  includeVectors?: boolean | undefined;
 };
 
 export type ListDocsDoc = {
@@ -52,6 +58,7 @@ export type ListDocsRequest$Outbound = {
   collectionName: string;
   size?: number | undefined;
   pageToken?: string | undefined;
+  includeVectors: boolean;
 };
 
 /** @internal */
@@ -63,6 +70,7 @@ export const ListDocsRequest$outboundSchema: z.ZodType<
   collectionName: z.string(),
   size: z.number().int().optional(),
   pageToken: z.string().optional(),
+  includeVectors: z.boolean().default(false),
 });
 
 export function listDocsRequestToJSON(
@@ -71,6 +79,98 @@ export function listDocsRequestToJSON(
   return JSON.stringify(ListDocsRequest$outboundSchema.parse(listDocsRequest));
 }
 
+export type ListDocsExtendedRequestBody = {
+  /**
+   * Max number of documents to return at once.
+   */
+  size?: number | undefined;
+  /**
+   * Next page token.
+   */
+  pageToken?: string | undefined;
+  /**
+   * Filter applied before pagination.
+   */
+  filter?: { [k: string]: any } | undefined;
+  partitionFilter?: models.PartitionFilter | undefined;
+  /**
+   * An object to specify a list of field names to include and/or exclude in the result.
+   */
+  fields?: models.FieldsSelectorUnion | undefined;
+  /**
+   * Set to true to include vector values in the response. Defaults to false.
+   */
+  includeVectors?: boolean | undefined;
+};
+
+export type ListDocsExtendedRequest = {
+  /**
+   * Collection name.
+   */
+  collectionName: string;
+  requestBody: ListDocsExtendedRequestBody;
+};
+
+/** @internal */
+export type ListDocsExtendedRequestBody$Outbound = {
+  size?: number | undefined;
+  pageToken?: string | undefined;
+  filter?: { [k: string]: any } | undefined;
+  partitionFilter?: models.PartitionFilter$Outbound | undefined;
+  fields?: models.FieldsSelectorUnion$Outbound | undefined;
+  includeVectors: boolean;
+};
+
+/** @internal */
+export const ListDocsExtendedRequestBody$outboundSchema: z.ZodType<
+  ListDocsExtendedRequestBody$Outbound,
+  z.ZodTypeDef,
+  ListDocsExtendedRequestBody
+> = z.object({
+  size: z.number().int().optional(),
+  pageToken: z.string().optional(),
+  filter: z.record(z.any()).optional(),
+  partitionFilter: models.PartitionFilter$outboundSchema.optional(),
+  fields: models.FieldsSelectorUnion$outboundSchema.optional(),
+  includeVectors: z.boolean().default(false),
+});
+
+export function listDocsExtendedRequestBodyToJSON(
+  listDocsExtendedRequestBody: ListDocsExtendedRequestBody,
+): string {
+  return JSON.stringify(
+    ListDocsExtendedRequestBody$outboundSchema.parse(listDocsExtendedRequestBody),
+  );
+}
+
+/** @internal */
+export type ListDocsExtendedRequest$Outbound = {
+  collectionName: string;
+  RequestBody: ListDocsExtendedRequestBody$Outbound;
+};
+
+/** @internal */
+export const ListDocsExtendedRequest$outboundSchema: z.ZodType<
+  ListDocsExtendedRequest$Outbound,
+  z.ZodTypeDef,
+  ListDocsExtendedRequest
+> = z.object({
+  collectionName: z.string(),
+  requestBody: z.lazy(() => ListDocsExtendedRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function listDocsExtendedRequestToJSON(
+  listDocsExtendedRequest: ListDocsExtendedRequest,
+): string {
+  return JSON.stringify(
+    ListDocsExtendedRequest$outboundSchema.parse(listDocsExtendedRequest),
+  );
+}
+
 /** @internal */
 export const ListDocsDoc$inboundSchema: z.ZodType<
   ListDocsDoc,

package/src/types/public.ts

@@ -16,8 +16,15 @@ export type { BulkUpsertDocsRequestBody as BulkUpsertInput } from "../models/ope
 import type { ListDocsRequest } from "../models/operations/listdocs.js";
 import type { ListCollectionsRequest } from "../models/operations/listcollections.js";
 
-/** Parameters for listing documents (size, pageToken). */
-export type ListDocsInput = Pick<ListDocsRequest, "size" | "pageToken">;
+/** Parameters for listing documents, including extended list options. */
+export type ListDocsInput = Pick<
+  ListDocsRequest,
+  "size" | "pageToken" | "includeVectors"
+> & {
+  filter?: Record<string, unknown> | undefined;
+  partitionFilter?: import("../models/index.js").PartitionFilter | undefined;
+  fields?: import("../models/index.js").FieldsSelectorUnion | undefined;
+};
 
 /** Parameters for listing collections (size, pageToken). */
 export type ListCollectionsInput = Pick<

package/test/public-api.test.mjs

@@ -391,6 +391,7 @@ test("collection docs helpers paginate through the user-facing scoped API", asyn
   const { calls, client } = createClient((call, index) => {
     assert.equal(call.method, "GET");
     assert.equal(call.url.pathname, "/projects/project-one/collections/items/docs");
+    assert.equal(call.url.searchParams.get("includeVectors"), "false");
 
     if (index === 0) {
       return jsonResponse({
@@ -422,6 +423,56 @@ test("collection docs helpers paginate through the user-facing scoped API", asyn
   ]);
 });
 
+test("collection docs list supports includeVectors and extended list options", async () => {
+  const { calls, client } = createClient((call, index) => {
+    if (index === 0) {
+      assert.equal(call.method, "GET");
+      assert.equal(call.url.pathname, "/projects/project-one/collections/items/docs");
+      assert.equal(call.url.searchParams.get("size"), "10");
+      assert.equal(call.url.searchParams.get("includeVectors"), "true");
+      return jsonResponse({
+        total: 1,
+        docs: [{ collection: "items", doc: { id: "a", embedding: [0.1, 0.2] } }],
+        nextPageToken: null,
+        isDocsInline: true,
+        docsUrl: null,
+      });
+    }
+
+    assert.equal(call.method, "POST");
+    assert.equal(call.url.pathname, "/projects/project-one/collections/items/docs/list");
+    assert.deepEqual(JSON.parse(call.body), {
+      size: 10,
+      filter: { queryString: { query: "category:docs" } },
+      partitionFilter: { field: "tenant", in: ["acme"] },
+      fields: { include: ["id", "title"] },
+      includeVectors: false,
+    });
+    return jsonResponse({
+      total: 1,
+      docs: [{ collection: "items", doc: { id: "a", title: "LambdaDB" } }],
+      nextPageToken: null,
+      isDocsInline: true,
+      docsUrl: null,
+    });
+  });
+
+  const listResult = await client.collection("items").docs.list({
+    size: 10,
+    includeVectors: true,
+  });
+  const extendedResult = await client.collection("items").docs.list({
+    size: 10,
+    filter: { queryString: { query: "category:docs" } },
+    partitionFilter: { field: "tenant", in: ["acme"] },
+    fields: { include: ["id", "title"] },
+  });
+
+  assert.equal(calls.length, 2);
+  assert.deepEqual(listResult.docs[0].doc.embedding, [0.1, 0.2]);
+  assert.deepEqual(extendedResult.docs[0].doc, { id: "a", title: "LambdaDB" });
+});
+
 test("collection query fetches docsUrl and returns inline docs through the public API", async () => {
   const originalFetch = globalThis.fetch;
   const docsUrlCalls = [];