Интеграция в проект

Эта страница поможет вам быстро интегрировать AACSearch в ваш проект. Вы узнаете, как получить API-ключи, настроить клиентскую библиотеку и отправить первый поисковый запрос.

Шаг 1: Создайте аккаунт и организацию

1. Зарегистрируйтесь на AACSearch Cloud
2. Создайте организацию — это ваше рабочее пространство для проектов
3. Перейдите в раздел Поиск и создайте первый поисковый индекс

Шаг 2: Получите API-ключи

API-ключи управляются на уровне индекса или проекта. Есть два типа ключей:

Чтобы создать ключ:

1. Перейдите в API-ключи внутри вашего индекса
2. Нажмите Создать ключ
3. Выберите тип ключа и права доступа
4. Скопируйте ключ — он будет показан только один раз

Шаг 3: Выберите SDK

AACSearch предоставляет официальные SDK для популярных языков:

Шаг 4: Отправьте первый запрос

JavaScript / TypeScript

import { AACSearch } from "@aacsearch/client";

const client = new AACSearch({
  host: "search.aacsearch.com",
  port: 443,
  protocol: "https",
  apiKey: "ваш-scoped-ключ",
});

// Индексация документа
await client.collections("товары").documents().upsert({
  id: "1",
  name: "Беспроводные наушники Pro",
  description: "Шумоподавление, 30 часов работы",
  price: 12990,
  category: "Электроника",
});

// Поиск
const result = await client.collections("товары").documents().search({
  q: "наушники",
  query_by: "name,description",
  filter_by: "category:Электроника",
  sort_by: "price:asc",
});

console.log(`Найдено: ${result.found}`);
result.hits.forEach((hit) => {
  console.log(`- ${hit.document.name} (${hit.document.price} ₽)`);
});

Python

from aacsearch import Client

client = Client(
    host="search.aacsearch.com",
    port=443,
    protocol="https",
    api_key="ваш-scoped-ключ",
)

# Индексация документа
client.collections("товары").documents.upsert({
    "id": "1",
    "name": "Беспроводные наушники Pro",
    "description": "Шумоподавление, 30 часов работы",
    "price": 12990,
    "category": "Электроника",
})

# Поиск
result = client.collections("товары").documents.search({
    "q": "наушники",
    "query_by": "name,description",
    "filter_by": "category:Электроника",
    "sort_by": "price:asc",
})

print(f"Найдено: {result['found']}")
for hit in result["hits"]:
    print(f"- {hit['document']['name']} ({hit['document']['price']} ₽)")

Шаг 5: Проверьте результаты

После отправки запроса убедитесь, что:

• Поле found содержит ожидаемое количество результатов
• Поле hits содержит релевантные документы на первых позициях
• Фильтры и сортировка работают корректно

Если результаты не соответствуют ожиданиям, проверьте:

• Правильность названий полей в query_by, filter_by и sort_by
• Корректность типов данных (числа не должны быть в кавычках)
• Наличие индексированных документов

Шаг 6: Настройте поиск под ваш продукт

AACSearch предоставляет множество инструментов для улучшения релевантности:

• Синонимы — задайте альтернативные названия товаров и категорий
• Правила ранжирования — настройте веса полей и бусты для определённых условий
• Курирование — закрепите определённые товары в выдаче по конкретным запросам
• AI Поиск — включите семантический поиск и AI-ответы на естественном языке

Как протестировать поиск

Тестовый запрос через API

Самый простой способ проверить поиск — использовать curl:

curl -X GET "https://search.aacsearch.com/collections/товары/documents/search?q=наушники&query_by=name" \
  -H "X-TYPESENSE-API-KEY: ваш-scoped-ключ"

Веб-интерфейс

Панель управления AACSearch включает встроенный Preview — интерактивный поисковый интерфейс, где можно тестировать запросы, фильтры и сортировку без написания кода.

Виджет для быстрой интеграции

Для максимально быстрого старта используйте готовый поисковый виджет:

<!-- Подключите виджет -->
<script src="https://cdn.aacsearch.com/widget/v1/aacsearch-widget.js"></script>

<!-- Добавьте контейнер -->
<div id="aacsearch-widget"></div>

<script>
  AACSearchWidget.init({
    container: "#aacsearch-widget",
    host: "search.aacsearch.com",
    apiKey: "ваш-scoped-ключ",
    collection: "товары",
    language: "ru",
  });
</script>

Виджет поддерживает автодополнение, фасеты, бесконечную прокрут ку и адаптивный дизайн.

Что дальше?

• Поисковый API — полная документация поисковых эндпоинтов
• AI Поиск — семантический поиск, AI-ответы и подсказки
• SDK — подробные руководства по всем SDK
• Рекомендации — похожие товары, персонализация, тренды
• Аналитика — отслеживание поисковых запросов и конверсий

Нужна помощь?

• Документация API
• Сообщество разработчиков
• Техническая поддержка