Справочник по соединителю Elastic Notion

Этот управляемый коннектор был представлен в Elastic 8.14.0 в качестве управляемой службы в Elastic Cloud.

Чтобы использовать этот коннектор напрямую в Elastic Cloud, выполните все требования к управляемым коннекторам.

Чтобы использовать этот коннектор в пользовательском интерфейсе, выберите плитку Notion при создании нового коннектора в разделе Поиск → Коннекторы.

Если вы уже знакомы с принципом работы коннекторов, вы также можете использовать API коннекторов.

Для дополнительных операций см. Пользовательский интерфейс коннекторов в Kibana.

Чтобы создать новый коннектор Notion:

Для дополнительных операций см. Пользовательский интерфейс коннекторов в Kibana.

Вы можете использовать Elasticsearch API создания коннекторов для создания нового нативного коннектора Notion.

Например:

resp = client.connector.put(
    connector_id="my-{service-name-stub}-connector",
    index_name="my-elasticsearch-index",
    name="Content synced from {service-name}",
    service_type="{service-name-stub}",
    is_native=True,
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-{service-name-stub}-connector",
  index_name: "my-elasticsearch-index",
  name: "Content synced from {service-name}",
  service_type: "{service-name-stub}",
  is_native: true,
});
console.log(response);

PUT _connector/my-notion-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Notion",
  "service_type": "notion",
  "is_native": true
}

Подробные сведения обо всех доступных API коннекторов см. в документации по API Elasticsearch.

Для подключения к Notion пользователю необходимо создать внутреннюю интеграцию для своего рабочего пространства Notion, которая может получать доступ к ресурсам с помощью внутреннего секретного токена интеграции. Настройте интеграцию со следующими параметрами:

Обратите внимание на следующие поля настройки:

См. извлечение контента.

Коннектор синхронизирует следующие объекты и сущности:

Основные правила синхронизации одинаковы для всех коннекторов и доступны по умолчанию.

В данном разделе описаны расширенные правила синхронизации для этого коннектора, чтобы отфильтровать данные в Notion *перед* индексированием в Elasticsearch. Расширенные правила синхронизации определяются с помощью JSON-фрагмента DSL, специфичного для источника.

Расширенные правила синхронизации для Notion принимают следующие параметры:

Пример 1

Индексирование каждой страницы, где название содержит Demo Page:

  {
    "searches": [
      {
        "filter": {
          "value": "page"
        },
        "query": "Demo Page"
      }
    ]
  }

Пример 2

Индексирование каждой базы данных, где название содержит Demo Database:

{
  "searches": [
    {
      "filter": {
        "value": "database"
      },
      "query": "Demo Database"
    }
  ]
}

Пример 3

Индексация каждой базы данных, где заголовок содержит Demo Database, и каждой страницы, где заголовок содержит Demo Page:

{
  "searches": [
    {
      "filter": {
        "value": "database"
      },
      "query": "Demo Database"
    },
    {
      "filter": {
        "value": "page"
      },
      "query": "Demo Page"
    }
  ]
}

Пример 4

Индексация всех страниц в рабочей области:

{
  "searches": [
    {
      "filter": {
        "value": "page"
      },
      "query": ""
    }
  ]
}

Пример 5

Индексация всех страниц и баз данных, связанных с рабочей областью:

{
  "searches":[
    {
      "query":""
    }
  ]
}

Пример 6

Индексация всех строк базы данных, где запись является true для столбца Task completed и её тип (тип данных) – флажок:

{
  "database_query_filters": [
    {
      "filter": {
          "property": "Task completed",
          "checkbox": {
            "equals": true
          }
      },
      "database_id": "database_id"
    }
  ]
}

Пример 7

Индексация всех строк конкретной базы данных:

{
  "database_query_filters": [
    {
      "database_id": "database_id"
    }
  ]
}

Пример 8

Индексация всех блоков, определённых в searches и database_query_filters:

{
  "searches":[
    {
      "query":"External tasks",
      "filter":{
        "value":"database"
      }
    },
    {
      "query":"External tasks",
      "filter":{
        "value":"page"
      }
    }
  ],
  "database_query_filters":[
    {
      "database_id":"notion_database_id1",
      "filter":{
        "property":"Task completed",
        "checkbox":{
          "equals":true
        }
      }
    }
  ]
}

Обратитесь к Известным проблемам для списка известных проблем для всех коннекторов.

См. Устранение неполадок.

См. Безопасность.

Этот коннектор был представлен в Elastic 8.13.0 в виде самостоятельно управляемого коннектора.

Чтобы использовать этот коннектор, выполните все предварительные требования к самостоятельно управляемым коннекторам. Важно, что вы должны развернуть службу коннекторов на собственной инфраструктуре. У вас есть два варианта развертывания:

Чтобы использовать этот коннектор в пользовательском интерфейсе, выберите плитку Notion при создании нового коннектора в разделе Поиск → Коннекторы.

Дополнительные операции см. в Пользовательском интерфейсе коннекторов в Kibana.

Чтобы создать новый коннектор Notion:

Вы можете использовать Elasticsearch API для создания коннекторов, чтобы создать новый самостоятельно управляемый коннектор Notion.

Например:

resp = client.connector.put(
    connector_id="my-{service-name-stub}-connector",
    index_name="my-elasticsearch-index",
    name="Content synced from {service-name}",
    service_type="{service-name-stub}",
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-{service-name-stub}-connector",
  index_name: "my-elasticsearch-index",
  name: "Content synced from {service-name}",
  service_type: "{service-name-stub}",
});
console.log(response);

PUT _connector/my-notion-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Notion",
  "service_type": "notion"
}

Подробную информацию обо всех доступных API коннекторов см. в документации API Elasticsearch.

Для подключения к Notion пользователю необходимо создать внутреннюю интеграцию для своего рабочего пространства Notion, которая может получать доступ к ресурсам с помощью внутреннего токена секрета интеграции. Настройте интеграцию со следующими настройками:

Вы можете развернуть коннектор Notion как самостоятельно управляемый коннектор с помощью Docker. Следуйте этим инструкциям.

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml

# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>

connectors:
  -
    connector_id: <CONNECTOR_ID_FROM_KIBANA>
    service_type: notion
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA> # Optional. If not provided, the connector will use the elasticsearch.api_key instead

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.17.3 \
/app/bin/elastic-ingest \
-c /config/config.yml

Дополнительные сведения см. в DOCKER.md в репозитории elastic/connectors.

Найдите все доступные Docker-образы в официальном реестре.

Обратите внимание на следующие поля конфигурации:

См. извлечение содержимого.

Коннектор синхронизирует следующие объекты и сущности:

Основные правила синхронизации идентичны для всех соединителей и доступны по умолчанию.

В следующем разделе описываются расширенные правила синхронизации для данного соединителя, для фильтрации данных в Notion перед индексированием в Elasticsearch. Расширенные правила синхронизации определяются через JSON-фрагмент DSL, специфичный для источника.

Расширенные правила синхронизации для Notion принимают следующие параметры:

Пример 1

Индексирование каждой страницы, где заголовок содержит Demo Page:

  {
    "searches": [
      {
        "filter": {
          "value": "page"
        },
        "query": "Demo Page"
      }
    ]
  }

Пример 2

Индексирование каждой базы данных, где заголовок содержит Demo Database:

{
  "searches": [
    {
      "filter": {
        "value": "database"
      },
      "query": "Demo Database"
    }
  ]
}

Пример 3

Индексирование каждой базы данных, где заголовок содержит Demo Database, и каждой страницы, где заголовок содержит Demo Page:

{
  "searches": [
    {
      "filter": {
        "value": "database"
      },
      "query": "Demo Database"
    },
    {
      "filter": {
        "value": "page"
      },
      "query": "Demo Page"
    }
  ]
}

Пример 4

Индексирование всех страниц в рабочем пространстве:

{
  "searches": [
    {
      "filter": {
        "value": "page"
      },
      "query": ""
    }
  ]
}

Пример 5

Индексирование всех страниц и баз данных, связанных с рабочим пространством:

{
  "searches":[
    {
      "query":""
    }
  ]
}

Пример 6

Индексирование всех строк базы данных, где запись является true для столбца Task completed, а её свойство (тип данных) — флажок:

{
  "database_query_filters": [
    {
      "filter": {
          "property": "Task completed",
          "checkbox": {
            "equals": true
          }
      },
      "database_id": "database_id"
    }
  ]
}

Пример 7

Индексирование всех строк определённой базы данных:

{
  "database_query_filters": [
    {
      "database_id": "database_id"
    }
  ]
}

Пример 8

Индексирование всех блоков, определённых в searches и database_query_filters:

{
  "searches":[
    {
      "query":"External tasks",
      "filter":{
        "value":"database"
      }
    },
    {
      "query":"External tasks",
      "filter":{
        "value":"page"
      }
    }
  ],
  "database_query_filters":[
    {
      "database_id":"notion_database_id1",
      "filter":{
        "property":"Task completed",
        "checkbox":{
          "equals":true
        }
      }
    }
  ]
}

Фреймворк соединителя позволяет операторам запускать функциональные тесты на реальном источнике данных, используя Docker Compose. Для выполнения этого теста вам не нужен запущенный Elasticsearch или Notion источник.

См. тестирование соединителя для получения дополнительной информации.

Для выполнения E2E-тестирования для соединителя Notion выполните следующую команду:

$ make ftest NAME=notion

Для ускорения тестов добавьте флаг DATA_SIZE=small:

make ftest NAME=notion DATA_SIZE=small

По умолчанию, DATA_SIZE=MEDIUM.

См. Известные проблемы для получения списка известных проблем для всех соединителей.

См. Устранение неполадок.

См. Безопасность.