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

    Class ConnectorsApi

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    configuration

    Methods

    addUserToSourceConnector addUserToSourceConnectorRaw createAIPlatformConnector createAIPlatformConnectorRaw createDestinationConnector createDestinationConnectorRaw createSourceConnector createSourceConnectorRaw deleteAIPlatform deleteAIPlatformRaw deleteDestinationConnector deleteDestinationConnectorRaw deleteSourceConnector deleteSourceConnectorRaw deleteUserFromSourceConnector deleteUserFromSourceConnectorRaw getAIPlatformConnector getAIPlatformConnectorRaw getAIPlatformConnectors getAIPlatformConnectorsRaw getDestinationConnector getDestinationConnectorRaw getDestinationConnectors getDestinationConnectorsRaw getSourceConnector getSourceConnectorRaw getSourceConnectors getSourceConnectorsRaw isJsonMime request updateAIPlatformConnector updateAIPlatformConnectorRaw updateDestinationConnector updateDestinationConnectorRaw updateSourceConnector updateSourceConnectorRaw updateUserInSourceConnector updateUserInSourceConnectorRaw withMiddleware withPostMiddleware withPreMiddleware

    Constructors

    Properties

    configuration: Configuration = DefaultConfig

    Methods

    • Create a new destination connector. Config values: Couchbase Capella (CAPELLA): Name (name): text, Cluster Access Name (username): text, Cluster Access Password (password): text, Connection String (connection-string): text) | DataStax Astra (DATASTAX): Name (name): text, API Endpoint (endpoint_secret): text, Application Token (token): text) | Elasticsearch (ELASTIC): Name (name): text, Host (host): text, Port (port): text, API Key (api-key): text) | Pinecone (PINECONE): Name (name): text, API Key (api-key): text) | SingleStore (SINGLESTORE): Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Milvus (MILVUS): Name (name): text, Public Endpoint (url): text, Token (token): text, Username (username): text, Password (password): text) | PostgreSQL (POSTGRESQL): Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Qdrant (QDRANT): Name (name): text, Host (host): text, API Key (api-key): text) | Supabase (SUPABASE): Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Weaviate (WEAVIATE): Name (name): text, Endpoint (host): text, API Key (api-key): text) | Azure AI Search (AZUREAISEARCH): Name (name): text, Azure AI Search Service Name (service-name): text, API Key (api-key): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Name (name): text, API Key (apiKey): text) | MongoDB (MONGODB): Name (name): text, API Key (apiKey): text)

      Parameters

      Returns Promise<CreateDestinationConnectorResponse>

    • Create a new destination connector. Config values: Couchbase Capella (CAPELLA): Name (name): text, Cluster Access Name (username): text, Cluster Access Password (password): text, Connection String (connection-string): text) | DataStax Astra (DATASTAX): Name (name): text, API Endpoint (endpoint_secret): text, Application Token (token): text) | Elasticsearch (ELASTIC): Name (name): text, Host (host): text, Port (port): text, API Key (api-key): text) | Pinecone (PINECONE): Name (name): text, API Key (api-key): text) | SingleStore (SINGLESTORE): Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Milvus (MILVUS): Name (name): text, Public Endpoint (url): text, Token (token): text, Username (username): text, Password (password): text) | PostgreSQL (POSTGRESQL): Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Qdrant (QDRANT): Name (name): text, Host (host): text, API Key (api-key): text) | Supabase (SUPABASE): Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Weaviate (WEAVIATE): Name (name): text, Endpoint (host): text, API Key (api-key): text) | Azure AI Search (AZUREAISEARCH): Name (name): text, Azure AI Search Service Name (service-name): text, API Key (api-key): text) | Built-in (VECTORIZE): ) | Chroma (CHROMA): Name (name): text, API Key (apiKey): text) | MongoDB (MONGODB): Name (name): text, API Key (apiKey): text)

      Parameters

      Returns Promise<ApiResponse<CreateDestinationConnectorResponse>>

    • Create a new source connector. Config values: Amazon S3 (AWS_S3): Name (name): text, Access Key (access-key): text, Secret Key (secret-key): text, Bucket Name (bucket-name): text, Endpoint (endpoint): url, Region (region): text, Allow as archive destination (archiver): boolean) | Azure Blob Storage (AZURE_BLOB): Name (name): text, Storage Account Name (storage-account-name): text, Storage Account Key (storage-account-key): text, Container (container): text, Endpoint (endpoint): url) | Confluence (CONFLUENCE): Name (name): text, Username (username): text, API Token (api-token): text, Domain (domain): text) | Discord (DISCORD): Name (name): text, Server ID (guild-id): text, Bot token (bot-token): text, Channel ID (channel-ids): array oftext) | Dropbox (DROPBOX): Name (name): text) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Name (name): text) | Google Drive (Service Account) (GOOGLE_DRIVE): Name (name): text, Service Account JSON (service-account-json): textarea) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Name (name): text) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Name (name): text, OAuth2 Client Id (oauth2-client-id): text, OAuth2 Client Secret (oauth2-client-secret): text) | Firecrawl (FIRECRAWL): Name (name): text, API Key (api-key): text) | GCP Cloud Storage (GCS): Name (name): text, Service Account JSON (service-account-json): textarea, Bucket (bucket-name): text) | Intercom (INTERCOM): Name (name): text, Access Token (intercomAccessToken): text) | OneDrive (ONE_DRIVE): Name (name): text, Client Id (ms-client-id): text, Tenant Id (ms-tenant-id): text, Client Secret (ms-client-secret): text, Users (users): array oftext) | SharePoint (SHAREPOINT): Name (name): text, Client Id (ms-client-id): text, Tenant Id (ms-tenant-id): text, Client Secret (ms-client-secret): text) | Web Crawler (WEB_CRAWLER): Name (name): text, Seed URL(s) (seed-urls): array ofurl) | File Upload (FILE_UPLOAD): Name (name): text)

      Parameters

      Returns Promise<CreateSourceConnectorResponse>

    • Create a new source connector. Config values: Amazon S3 (AWS_S3): Name (name): text, Access Key (access-key): text, Secret Key (secret-key): text, Bucket Name (bucket-name): text, Endpoint (endpoint): url, Region (region): text, Allow as archive destination (archiver): boolean) | Azure Blob Storage (AZURE_BLOB): Name (name): text, Storage Account Name (storage-account-name): text, Storage Account Key (storage-account-key): text, Container (container): text, Endpoint (endpoint): url) | Confluence (CONFLUENCE): Name (name): text, Username (username): text, API Token (api-token): text, Domain (domain): text) | Discord (DISCORD): Name (name): text, Server ID (guild-id): text, Bot token (bot-token): text, Channel ID (channel-ids): array oftext) | Dropbox (DROPBOX): Name (name): text) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH): Name (name): text) | Google Drive (Service Account) (GOOGLE_DRIVE): Name (name): text, Service Account JSON (service-account-json): textarea) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI): Name (name): text) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM): Name (name): text, OAuth2 Client Id (oauth2-client-id): text, OAuth2 Client Secret (oauth2-client-secret): text) | Firecrawl (FIRECRAWL): Name (name): text, API Key (api-key): text) | GCP Cloud Storage (GCS): Name (name): text, Service Account JSON (service-account-json): textarea, Bucket (bucket-name): text) | Intercom (INTERCOM): Name (name): text, Access Token (intercomAccessToken): text) | OneDrive (ONE_DRIVE): Name (name): text, Client Id (ms-client-id): text, Tenant Id (ms-tenant-id): text, Client Secret (ms-client-secret): text, Users (users): array oftext) | SharePoint (SHAREPOINT): Name (name): text, Client Id (ms-client-id): text, Tenant Id (ms-tenant-id): text, Client Secret (ms-client-secret): text) | Web Crawler (WEB_CRAWLER): Name (name): text, Seed URL(s) (seed-urls): array ofurl) | File Upload (FILE_UPLOAD): Name (name): text)

      Parameters

      Returns Promise<ApiResponse<CreateSourceConnectorResponse>>

    • 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.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    addUserToSourceConnectoraddUserToSourceConnectorRawcreateAIPlatformConnectorcreateAIPlatformConnectorRawcreateDestinationConnectorcreateDestinationConnectorRawcreateSourceConnectorcreateSourceConnectorRawdeleteAIPlatformdeleteAIPlatformRawdeleteDestinationConnectordeleteDestinationConnectorRawdeleteSourceConnectordeleteSourceConnectorRawdeleteUserFromSourceConnectordeleteUserFromSourceConnectorRawgetAIPlatformConnectorgetAIPlatformConnectorRawgetAIPlatformConnectorsgetAIPlatformConnectorsRawgetDestinationConnectorgetDestinationConnectorRawgetDestinationConnectorsgetDestinationConnectorsRawgetSourceConnectorgetSourceConnectorRawgetSourceConnectorsgetSourceConnectorsRawisJsonMimerequestupdateAIPlatformConnectorupdateAIPlatformConnectorRawupdateDestinationConnectorupdateDestinationConnectorRawupdateSourceConnectorupdateSourceConnectorRawupdateUserInSourceConnectorupdateUserInSourceConnectorRawwithMiddlewarewithPostMiddlewarewithPreMiddleware