Skip to main content

opensearch

Workspace API

Workspace API / services/opensearch

services/opensearch

Classes​

OpenSearchClient​

Defined in: services/opensearch.ts:119

Constructors​

Constructor​

new OpenSearchClient(indexPrefix?): OpenSearchClient

Defined in: services/opensearch.ts:123

Parameters​
indexPrefix?​

string

Returns​

OpenSearchClient

Methods​

ensureIndex()​

ensureIndex(indexName?): Promise<void>

Defined in: services/opensearch.ts:140

Create index with mappings if it doesn't exist

Parameters​
indexName?​

string

Returns​

Promise<void>

insertDocument()​

insertDocument(document, indexName?): Promise<void>

Defined in: services/opensearch.ts:219

Insert a single document

Parameters​
document​

Record<string, any>

indexName?​

string

Returns​

Promise<void>

insertDocuments()​

insertDocuments(documents, indexName?): Promise<void>

Defined in: services/opensearch.ts:248

Insert multiple documents (bulk insert)

Parameters​
documents​

Record<string, any>[]

indexName?​

string

Returns​

Promise<void>

search(query, indexName?): Promise<any[]>

Defined in: services/opensearch.ts:310

Search documents

Parameters​
query​

any

indexName?​

string

Returns​

Promise<any[]>

getClient()​

getClient(): Client

Defined in: services/opensearch.ts:342

Get the underlying OpenSearch client (for advanced operations)

Returns​

Client