QVAC Logo
JS API

startQVACProvider( )

Starts a provider service that offers QVAC capabilities to remote peers. The provider's keypair can be controlled via the seed option or QVAC_HYPERSWARM_SEED environment variable.

function startQVACProvider(params: { firewall?: { mode: "allow" | "deny"; publicKeys: string[] }; topic: string }): Promise

Parameters

NameTypeRequired?Description
params`{ firewall?: { mode: "allow""deny"; publicKeys: string[] }; topic: string }`✓
FieldTypeRequired?Description
topicstring✓The Hyperswarm topic to join. Remote peers connecting to this topic can access the provider's capabilities
firewall\{ mode: "allow" | "deny"; publicKeys: string[] \}✗Access control firewall. In "allow" mode, only the listed public keys can connect. In "deny" mode, the listed keys are blocked and all others are allowed

Returns

Promise

Throws

ErrorWhen
When the response type is not "provide" or the request fails

ragSearch( )

Searches for similar documents in the RAG vector database. **Workspace lifecycle:** This operation requires an existing workspace. If the workspace doesn't exist, returns an empty array.

stopQVACProvider( )

Stops a running provider service and leaves the specified topic.

On this page

Parameters
Returns
Throws