# OpenSearch

{% hint style="info" %}
The following documentation is for **OpenSearch v2.0.1**.
{% endhint %}

## Overview

OpenSearch is a distributed, open-source search and analytics suite used for a broad set of use cases like real-time application monitoring, log analytics, and website search. This integration enables automated index management, document indexing, search operations, and data analytics workflows. Leverage powerful search capabilities and streamline data discovery processes.

## Setup

The following integrations need to be connected to your Kognitos workspace:

* **OpenSearch**

### Steps

Follow these steps to connect the integration in Kognitos:

{% stepper %}
{% step %}
**Navigate**

Using the left navigation menu, go to **Integrations** → **Explore Integrations**.
{% endstep %}

{% step %}
**Find**

Search for the integration and click on it.
{% endstep %}

{% step %}
**Connect**

Click on <kbd>**Connect**</kbd> to add a connection to the integration.
{% endstep %}

{% step %}
**Configure**

Add a name for the connection. You'll be prompted for [**authentication**](#authentication) details if needed. Then, click on <kbd>**Connect**</kbd>.
{% endstep %}
{% endstepper %}

## Authentication

Use one of the following authentication methods to connect this integration in Kognitos. Each method has its own configuration requirements.

### Connect using Hosts, Username and Password

Connect via http credentials

| Label    | Description                | Type        |
| -------- | -------------------------- | ----------- |
| Hosts    | comma-separated hosts      | `text`      |
| Username | the username for http auth | `text`      |
| Password | The password for http auth | `sensitive` |

## Actions

The following actions are available in the **OpenSearch** integration:

### 1. Create a document in opensearch

Create a document in opensearch

### 2. Delete a document from opensearch

Delete a document from opensearch

### 3. Get a document from opensearch

Get a document from opensearch by its ID

### 4. Query some documents from opensearch

Query documents from Opensearch

### 5. Update a document in opensearch

Update a document in opensearch

## Concepts

### Opensearch document

Represents an Document in Opensearch.

| Field Name   | Description                                    | Type   |
| ------------ | ---------------------------------------------- | ------ |
| `id`         | The ID of the document.                        | `text` |
| `index_name` | The name of the index the document belongs to. | `text` |
| `source`     | The document values.                           | `json` |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.kognitos.com/guides/platform/integrations/opensearch.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.