ContextCreateContextsOptions
Defined in: packages/synapse-sdk/src/types.ts:324
Extends
Section titled “Extends”Properties
Section titled “Properties”callbacks?
Section titled “callbacks?”
optionalcallbacks:StorageContextCallbacks
Defined in: packages/synapse-sdk/src/types.ts:319
Callbacks for creation process (will need to change to handle multiples)
Inherited from
Section titled “Inherited from”CreateContextsOptions.callbacks
count?
Section titled “count?”
optionalcount:number
Defined in: packages/synapse-sdk/src/types.ts:297
Number of contexts to create (optional, defaults to 2)
Inherited from
Section titled “Inherited from”dataSetIds?
Section titled “dataSetIds?”
optionaldataSetIds:bigint[]
Defined in: packages/synapse-sdk/src/types.ts:301
Specific data set IDs to use
Inherited from
Section titled “Inherited from”CreateContextsOptions.dataSetIds
excludeProviderIds?
Section titled “excludeProviderIds?”
optionalexcludeProviderIds:bigint[]
Defined in: packages/synapse-sdk/src/types.ts:307
Do not select any of these providers
Inherited from
Section titled “Inherited from”CreateContextsOptions.excludeProviderIds
forceCreateDataSets?
Section titled “forceCreateDataSets?”
optionalforceCreateDataSets:boolean
Defined in: packages/synapse-sdk/src/types.ts:317
Create new data sets, even if candidates exist
Inherited from
Section titled “Inherited from”CreateContextsOptions.forceCreateDataSets
metadata?
Section titled “metadata?”
optionalmetadata:Record<string,string>
Defined in: packages/synapse-sdk/src/types.ts:315
Custom metadata for the data sets (key-value pairs) When smart-selecting data sets, this metadata will be used to match.
Inherited from
Section titled “Inherited from”CreateContextsOptions.metadata
providerIds?
Section titled “providerIds?”
optionalproviderIds:bigint[]
Defined in: packages/synapse-sdk/src/types.ts:305
Specific provider IDs to use
Inherited from
Section titled “Inherited from”CreateContextsOptions.providerIds
synapse
Section titled “synapse”synapse:
Synapse
Defined in: packages/synapse-sdk/src/types.ts:326
The Synapse instance
uploadBatchSize?
Section titled “uploadBatchSize?”
optionaluploadBatchSize:number
Defined in: packages/synapse-sdk/src/types.ts:321
Maximum number of uploads to process in a single batch (default: 32, minimum: 1)
Inherited from
Section titled “Inherited from”CreateContextsOptions.uploadBatchSize
warmStorageService
Section titled “warmStorageService”warmStorageService:
WarmStorageService
Defined in: packages/synapse-sdk/src/types.ts:328
The WarmStorageService instance
withCDN?
Section titled “withCDN?”
optionalwithCDN:boolean
Defined in: packages/synapse-sdk/src/types.ts:309
Whether to enable CDN services
Inherited from
Section titled “Inherited from”withIpni?
Section titled “withIpni?”
optionalwithIpni:boolean
Defined in: packages/synapse-sdk/src/types.ts:310