Interface ISDKOptions

Options to configure the SDK.

interface ISDKOptions {
    audioContext?: AudioContext;
    disableIntervalHack?: boolean;
    documentParserConnector?: DocumentParserConnectorConstructor;
    externalStorageConnectors?: Map<SharePoint, ExternalStorageConnectionConnectorConstructor>;
    generativeAIWorkerConnectors?: GenerativeAIWorkerConnectorConstructor[];
    graphDatabaseConnector?: GraphDatabaseConnectorConstructor;
    keyValueDatabaseConnector?: KeyValueDatabaseConnectorConstructor;
    loggingConnectors?: ILoggingConnector[];
    loggingDatabaseConnector?: KeyValueDatabaseConnectorConstructor;
    maxBpp?: number;
    maxConnections?: number;
    maxDistance?: number;
    maxFps?: number;
    maxOutgoingSubscriptions?: number;
    minConnections?: number;
    nlpLibraryConnector?: NLPLibraryConnectorConstructor;
    objectStoreConnector?: ObjectStoreConnectorConstructor;
    peerConnectionConnector?: PeerConnectionConnectorConstructor;
    searchConnector?: SearchConnectorConstructor;
    vectorDatabaseConnector?: VectorDatabaseConnectorConstructor;
}

Properties

audioContext? disableIntervalHack? documentParserConnector? externalStorageConnectors? generativeAIWorkerConnectors? graphDatabaseConnector? keyValueDatabaseConnector? loggingConnectors? loggingDatabaseConnector? maxBpp? maxConnections? maxDistance? maxFps? maxOutgoingSubscriptions? minConnections? nlpLibraryConnector? objectStoreConnector? peerConnectionConnector? searchConnector? vectorDatabaseConnector?

Properties

OptionalaudioContext

audioContext?: AudioContext

The audio context to use for audio processing.

OptionaldisableIntervalHack

disableIntervalHack?: boolean

The flag to disable the interval hack that ensures the intervals run at the correct time.

OptionaldocumentParserConnector

documentParserConnector?: DocumentParserConnectorConstructor

The custom document parser connector to use for parsing documents.

OptionalexternalStorageConnectors

externalStorageConnectors?: Map<SharePoint, ExternalStorageConnectionConnectorConstructor>

The custom external storage connectors.

OptionalgenerativeAIWorkerConnectors

generativeAIWorkerConnectors?: GenerativeAIWorkerConnectorConstructor[]

The custom generative AI worker connectors to use for generative AI tasks.

OptionalgraphDatabaseConnector

graphDatabaseConnector?: GraphDatabaseConnectorConstructor

The custom graph database connector to use for graph database tasks.

OptionalkeyValueDatabaseConnector

keyValueDatabaseConnector?: KeyValueDatabaseConnectorConstructor

The custom key-value database connector to use for storing key-value pairs. If not provided, the default key-value database connector is IndexedDB.

OptionalloggingConnectors

loggingConnectors?: ILoggingConnector[]

The custom logging connector to use for logging events.

OptionalloggingDatabaseConnector

loggingDatabaseConnector?: KeyValueDatabaseConnectorConstructor

The custom logging database connector to use for storing Job logs.

OptionalmaxBpp

maxBpp?: number

The maximum bits per pixel to use for video.

OptionalmaxConnections

maxConnections?: number

The maximum number of connections a node can have.

OptionalmaxDistance

maxDistance?: number

The maximum distance allowed between two nodes in the network.

OptionalmaxFps

maxFps?: number

The maximum frame rate to use for video.

OptionalmaxOutgoingSubscriptions

maxOutgoingSubscriptions?: number

The maximum number of outgoing subscriptions.

OptionalminConnections

minConnections?: number

The minimum number of initial connections.

OptionalnlpLibraryConnector

nlpLibraryConnector?: NLPLibraryConnectorConstructor

The custom natural language processing connector to use for natural language processing tasks.

OptionalobjectStoreConnector

objectStoreConnector?: ObjectStoreConnectorConstructor

The custom object store connector to use for storing objects. If not provided, the default object store connector is OPFS.

OptionalpeerConnectionConnector

peerConnectionConnector?: PeerConnectionConnectorConstructor

The custom peer connection connector to use for creating peer connections. If not provided, the default peer connection connector is WebRTC in browser.

OptionalsearchConnector

searchConnector?: SearchConnectorConstructor

The custom search connector to use for searching the web.

OptionalvectorDatabaseConnector

vectorDatabaseConnector?: VectorDatabaseConnectorConstructor

The custom vector database connector to use for vector database tasks.

Settings

Member Visibility

On This Page

Properties