Interface: PageEmbedderOptions

Defined in: web-embed/src/provider.ts:5

Properties

autoLoad?

optional autoLoad?: boolean

Defined in: web-embed/src/provider.ts:15

Download without asking, on the first embed. Default false.

---

id?

optional id?: string

Defined in: web-embed/src/provider.ts:6

---

label?

optional label?: string

Defined in: web-embed/src/provider.ts:7

---

model?

optional model?: string

Defined in: web-embed/src/provider.ts:9

A Transformers.js feature-extraction model. Default Xenova/bge-small-en-v1.5 (384 dimensions, English, made for search).

---

queryPrefix?

optional queryPrefix?: string

Defined in: web-embed/src/provider.ts:13

Put before each query (models trained for search want one). Default: the one from the model card for BGE and mxbai models, none otherwise.

---

remoteHost?

optional remoteHost?: string

Defined in: web-embed/src/provider.ts:17

Where the model files come from. Default Hugging Face (https://huggingface.co/); host them yourself to keep every request on your site.

---

size?

optional size?: string

Defined in: web-embed/src/provider.ts:11

Rough download size, said to the visitor before they agree. Default "about 40 MB".