@cpod/sdk - v0.2.7
    Preparing search index...

    Function getEntities

    • Get extracted entities from indexed documents

      Retrieves named entities (persons, organizations, locations, etc.) extracted from documents with pagination and filtering support.

      Parameters

      • Optionaloptions: GetEntitiesOptions

        Optional filtering parameters

        Request parameters for getting entities

        • Optionalpage?: number

          Page number (1-indexed)

        • Optionalsources?: string[]

          Optional: Filter by specific sources

        • OptionalfileHashes?: string[]

          Optional: Filter by specific file hashes

        • Search entities by name

        • OptionalsortBy?: "name" | "count"

          Sort by field

        • OptionalsortOrder?: "asc" | "desc"

          Sort order

        • Optionallimit?: number

          Maximum number of entities to return (1-50)

        • OptionalnoCache?: boolean

          Bypass cache if true

        • OptionalforceDirectQuery?: boolean

          Force direct database query if true

      Returns Promise<EntitiesResponse>

      Promise resolving to EntitiesResponse:

      • entities - Array of Entity objects
      • total - Total number of entities
      • page - Current page number
      • limit - Entities per page
      • totalPages - Total number of pages

      401 - Not authenticated

      422 - Validation error

      import { getEntities } from "@cpod/sdk";

      // Get all entities with pagination
      const { entities, total, totalPages } = await getEntities();
      console.log(`Found ${total} entities (${totalPages} pages)`);

      // Filter by source with search
      const contractEntities = await getEntities({
        sources: ["contracts"],
        search: "Corp",
        sortBy: "count",
        sortOrder: "desc",
        limit: 50,
      });

      for (const entity of contractEntities.entities) {
        console.log(`${entity.name} (${entity.type}): ${entity.count} occurrences`);
      }

    Settings

    Member Visibility