> ## Documentation Index
> Fetch the complete documentation index at: https://docs.varios-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenSearch

> The OpenSearch connector enables integration with OpenSearch clusters and the execution of search queries. With this connector, you can quickly search through large amounts of data and find relevant information.

## Options

<ParamField body="apiUrl" type="string" required>
  The URL to the OpenSearch API.
</ParamField>

<ParamField body="indexName" type="string" required>
  The name of the index to search.
</ParamField>

<ParamField body="resultFields" type="string" required>
  Comma-separated list of fields to extract from the search results.
</ParamField>

<ParamField body="query" type="string" required>
  The query template in JSON format. Placeholders: `###SEARCHTERM###` and
  `###COUNT###`.
</ParamField>

<ParamField body="username" type="string">
  Username for authentication.
</ParamField>

<ParamField body="password" type="string">
  Password for authentication.
</ParamField>

<ParamField body="certificate" type="string">
  Base64-encoded certificate for the connection.
</ParamField>

## Arguments

<ParamField body="searchterm" type="string" required>
  The search term for the OpenSearch search.

  Example:

  ```
  The searchterm for the opensearch index
  ```
</ParamField>

<ParamField body="resultCount" type="integer" required>
  The number of desired search results.

  Example:

  ```
  The result count. Default: 10
  ```
</ParamField>