ParameterTypeDescriptionDefault
bucket_namestrName of the Couchbase bucketRequired
scope_namestrName of the scope within the bucketRequired
collection_namestrName of the collection within the scopeRequired
couchbase_connection_stringstrCouchbase cluster connection stringRequired
cluster_optionsClusterOptionsOptions for configuring the Couchbase cluster connectionRequired
search_indexUnion[str, SearchIndex]Search index configuration, either as index name or SearchIndex definitionRequired
embedderEmbedderEmbedder instance for generating embeddingsOpenAIEmbedder()
overwriteboolWhether to overwrite existing collectionFalse
is_global_level_indexboolWhether the search index is at global levelFalse
wait_until_index_readyOptional[float]Time in seconds to wait until the index is readyNone
batch_limitintMaximum number of documents to process in a single batch (applies to both sync and async operations)500