1.21.5 • Published 1 year ago
@elastic/search-ui-engines-connector v1.21.5
search-ui-engines-connector
Part of the Search UI project.
This Connector is used to connect Search UI to Elasticsearch Engines.
Usage
npm install --save @elastic/search-ui-engines-connectorimport EnginesConnector from "@elastic/search-ui-engines-connector";
const connector = new EnginesConnector({
host: "https://my-engines-demo.ent.us-east4.gcp.elastic-cloud.com/",
engineName: "puggles",
apiKey: "QTJDMHhJVUJENHg5WETWcXlrWVQ6dXFlcF9QRWdRWHl2Rm9iSndka1Rndw=="
});EnginesConnector
Kind: global class
new ElasticsearchAPIConnector(options)
| Param | Type |
|---|---|
| options | Options |
Options
Kind: global typedef
| Param | Type | Default | Description |
|---|---|---|---|
| host | string | Engines Host. | |
| engineName | string | The name of the engine to search | |
| apiKey | string | API Key for the engine. Can be found within the Engine view UI. |
Query Configuration Requirements
search_fieldsobject is required with all fields you want to search by.