@vectorize-io/vectorize-client
    Preparing search index...

    Class PipelinesApi

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    configuration: Configuration = DefaultConfig

    Methods

    • Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms:

      Parameters

      Returns Promise<CreatePipelineResponse>

    • Create a new source pipeline. Config fields for sources: Amazon S3 (AWS_S3): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Azure Blob Storage (AZURE_BLOB): Polling Interval (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Confluence (CONFLUENCE): Spaces (spaces): array oftext, Root Parents (root-parents): array oftext) | Discord (DISCORD): Emoji Filter (emoji): array oftext, Author Filter (author): array oftext, Ignore Author Filter (ignore-author): array oftext, Limit (limit): number) | Dropbox (DROPBOX): Read from these folders (optional) (path-prefix): array oftext) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Polling Interval (seconds) (idle-time): number) | Google Drive (Service Account) (GOOGLE_DRIVE): Restrict ingest to these folder URLs (optional) (root-parents): array oftext, Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Polling Interval (seconds) (idle-time): number) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Polling Interval (seconds) (idle-time): number) | Firecrawl (FIRECRAWL): ) | GCP Cloud Storage (GCS): Check for updates every (seconds) (idle-time): number, Path Prefix (path-prefix): text, Path Metadata Regex (path-metadata-regex): text, Path Regex Group Names (path-regex-group-names): array oftext) | Intercom (INTERCOM): Reindex Interval (seconds) (reindexIntervalSeconds): number, Limit (limit): number, Tags (tags): array oftext) | OneDrive (ONE_DRIVE): Read starting from this folder (optional) (path-prefix): text) | SharePoint (SHAREPOINT): Site Name(s) (sites): array oftext) | Web Crawler (WEB_CRAWLER): Additional Allowed URLs or prefix(es) (allowed-domains-opt): array ofurl, Forbidden Paths (forbidden-paths): array oftext, Throttle (ms) (min-time-between-requests): number, Max Error Count (max-error-count): number, Max URLs (max-urls): number, Max Depth (max-depth): number, Reindex Interval (seconds) (reindex-interval-seconds): number) | File Upload (FILE_UPLOAD): ). Config fields for destinations: Couchbase Capella (CAPELLA): Bucket Name (bucket): text, Scope Name (scope): text, Collection Name (collection): text, Search Index Name (index): text) | DataStax Astra (DATASTAX): Collection Name (collection): text) | Elasticsearch (ELASTIC): Index Name (index): text) | Pinecone (PINECONE): Index Name (index): text, Namespace (namespace): text) | SingleStore (SINGLESTORE): Table Name (table): text) | Milvus (MILVUS): Collection Name (collection): text) | PostgreSQL (POSTGRESQL): Table Name (table): text) | Qdrant (QDRANT): Collection Name (collection): text) | Supabase (SUPABASE): Table Name (table): text) | Weaviate (WEAVIATE): Collection Name (collection): text) | Azure AI Search (AZUREAISEARCH): Index Name (index): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Index Name (index): text) | MongoDB (MONGODB): Index Name (index): text). Config fields for AI platforms:

      Parameters

      Returns Promise<ApiResponse<CreatePipelineResponse>>

    • Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

      Parameters

      • mime: string

        MIME (Multipurpose Internet Mail Extensions)

      Returns boolean

      True if the given MIME is JSON, false otherwise.