Загрузка app search node - app search node Загрузка исходного кода

️ Этот клиент устарел ️
Начиная с версии Enterprise Search 8.3.2, мы направляем пользователей на новый клиент узла корпоративного поиска и объявляем его устаревшим.
Наши усилия по разработке этого проекта будут ограничены исправлением ошибок. Все будущие улучшения будут сосредоточены на клиенте Enterprise Search Node.
Спасибо! - Эластичный

Логотип Elastic App Search

Первичный клиент Node.JS для создания отличных и релевантных возможностей поиска с помощью Elastic App Search.

Содержание

Начиная
Управление версиями
Использование
Запуск тестов
Часто задаваемые вопросы
Способствовать
Лицензия

Начиная ?

Чтобы установить этот пакет, запустите:

npm install @elastic/app-search-node

Управление версиями

Этот клиент разрабатывается и выпускается вместе с App Search.

Чтобы гарантировать совместимость, используйте самую последнюю версию этой библиотеки в основной версии соответствующей реализации поиска приложений.

Например, для App Search 7.3 используйте 7.3 этой библиотеки или более позднюю, но не 8.0 .

Если вы используете версию SaaS, доступную на сайте Swiftype.com для поиска приложений, вам следует использовать версию клиента 7.5.x.

Использование

Настройка: настройка клиента и аутентификация

Использование этого клиента предполагает, что у вас уже есть запущенный экземпляр Elastic App Search.

Клиент настраивается с использованием параметров baseUrlFn и apiKey .

 const apiKey = 'private-mu75psc5egt9ppzuycnc2mc3'
const baseUrlFn = ( ) => 'http://localhost:3002/api/as/v1/'
const client = new AppSearchClient ( undefined , apiKey , baseUrlFn )

Примечание:

[apiKey] аутентифицирует запросы к API. С клиентом можно использовать любой тип ключа, однако каждый из них имеет разную область действия. Для получения дополнительной информации о ключах ознакомьтесь с документацией.

Пользователи поиска приложений Swiftype.com:

При использовании версии SaaS, доступной на сайте Swiftype.com для поиска приложений, вы можете настроить клиент, используя свой hostIdentifier вместо параметра baseUrlFn . hostIdentifier можно найти в меню «Учетные данные».

 const AppSearchClient = require ( '@elastic/app-search-node' )
const hostIdentifier = 'host-c5s2mj'
const apiKey = 'private-mu75psc5egt9ppzuycnc2mc3'
const client = new AppSearchClient ( hostIdentifier , apiKey )

Методы API

Индексирование: создание или замена документов

 const engineName = 'favorite-videos'
const documents = [
  {
    id : 'INscMGmhmX4' ,
    url : 'https://www.youtube.com/watch?v=INscMGmhmX4' ,
    title : 'The Original Grumpy Cat' ,
    body : 'A wonderful video of a magnificent cat.'
  } ,
  {
    id : 'JNDFojsd02' ,
    url : 'https://www.youtube.com/watch?v=dQw4w9WgXcQ' ,
    title : 'Another Grumpy Cat' ,
    body : 'A great video of another cool cat.'
  }
]

client
  . indexDocuments ( engineName , documents )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error ) )

Обратите внимание, что этот API не выдает ошибку индексации. Ошибки встроены в тело ответа для каждого документа:

[
  { "id" : " park_rocky-mountain " , "errors" : [] },
  {
    "id" : " park_saguaro " ,
    "errors" : [ " Invalid field value: Value 'foo' cannot be parsed as a float " ]
  }
]

Индексирование: обновление документов (частичные обновления)

 const engineName = 'favorite-videos'
const documents = [
  {
    id : 'INscMGmhmX4' ,
    title : 'Updated title'
  }
]

client
  . updateDocuments ( engineName , documents )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error ) )

Получение документов

 const engineName = 'favorite-videos'
const documentIds = [ 'INscMGmhmX4' , 'JNDFojsd02' ]

client
  . getDocuments ( engineName , documentIds )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Листинговые документы

 const engineName = 'favorite-videos'

// Without paging
client
  . listDocuments ( engineName )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

// With paging
client
  . listDocuments ( engineName , { page : { size : 10 , current : 1 } } )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Уничтожение документов

 const engineName = 'favorite-videos'
const documentIds = [ 'INscMGmhmX4' , 'JNDFojsd02' ]

client
  . destroyDocuments ( engineName , documentIds )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Листинговые системы

 client
  . listEngines ( { page : { size : 10 , current : 1 } } )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Получение двигателей

 const engineName = 'favorite-videos'

client
  . getEngine ( engineName )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Создание движков

 const engineName = 'favorite-videos'

client
  . createEngine ( engineName , { language : 'en' } )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Уничтожение двигателей

 const engineName = 'favorite-videos'

client
  . destroyEngine ( engineName )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Идет поиск

 const engineName = 'favorite-videos'
const query = 'cat'
const searchFields = { title : { } }
const resultFields = { title : { raw : { } } }
const options = { search_fields : searchFields , result_fields : resultFields }

client
  . search ( engineName , query , options )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Мультипоиск

 const engineName = 'favorite-videos'
const searches = [
  { query : 'cat' , options : {
      search_fields : { title : { } } ,
      result_fields : { title : { raw : { } } }
  } } ,
  { query : 'grumpy' , options : { } }
]

client
  . multiSearch ( engineName , searches )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Запрос Предложение

 const engineName = 'favorite-videos'
const options = {
  size : 3 ,
  types : {
    documents : {
      fields : [ 'title' ]
    }
  }
}

client
  . querySuggestion ( engineName , 'cat' , options )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Список кураторов

 const engineName = 'favorite-videos'

client
  . listCurations ( engineName )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

// Pagination details are optional
const paginationDetails = {
        page : {
          current : 2 ,
          size : 10
        }
      }

client
  . listCurations ( engineName , paginationDetails )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Получение кураций

 const engineName = 'favorite-videos'
const curationId = 'cur-7438290'

client
  . getCuration ( engineName , curationId )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Создание кураций

 const engineName = 'favorite-videos'
const newCuration = {
  queries : [ 'cat blop' ] ,
  promoted : [ 'Jdas78932' ] ,
  hidden : [ 'INscMGmhmX4' , 'JNDFojsd02' ]
}

client
  . createCuration ( engineName , newCuration )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Обновление кураций

 const engineName = 'favorite-videos'
const curationId = 'cur-7438290'
// "queries" is required, either "promoted" or "hidden" is required.
// Values sent for all fields will overwrite existing values.
const newDetails = {
  queries : [ 'cat blop' ] ,
  promoted : [ 'Jdas78932' , 'JFayf782' ]
}

client
  . updateCuration ( engineName , curationId , newDetails )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Удаление кураций

 const engineName = 'favorite-videos'
const curationId = 'cur-7438290'

client
  . destroyCuration ( engineName , curationId )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Получение схем

 const engineName = 'favorite-videos'

client
  . getSchema ( engineName )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Обновление схем

 const engineName = 'favorite-videos'
const schema = {
  views : 'number' ,
  created_at : 'date'
}

client
  . updateSchema ( engineName , schema )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Создайте подписанный ключ поиска

Создание ключа поиска, который будет возвращать только поле заголовка.

 const publicSearchKey = 'search-xxxxxxxxxxxxxxxxxxxxxxxx'
// This name must match the name of the key above from your App Search dashboard
const publicSearchKeyName = 'search-key'
const enforcedOptions = {
  result_fields : { title : { raw : { } } } ,
  filters : { world_heritage_site : 'true' }
}

// Optional. See https://github.com/auth0/node-jsonwebtoken#usage for all options
const signOptions = {
  expiresIn : '5 minutes'
}

const signedSearchKey = AppSearchClient . createSignedSearchKey (
  publicSearchKey ,
  publicSearchKeyName ,
  enforcedOptions ,
  signOptions
)

const baseUrlFn = ( ) => 'http://localhost:3002/api/as/v1/'
const client = new AppSearchClient ( undefined , signedSearchKey , baseUrlFn )

client . search ( 'sample-engine' , 'everglade' )

Создайте мета-движок

 const engineName = 'my-meta-engine'

client
  . createMetaEngine ( engineName , [ 'source-engine-1' , 'source-engine-2' ] )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Добавьте исходный движок в мета-движок

 const engineName = 'my-meta-engine'

client
  . addMetaEngineSources ( engineName , [ 'source-engine-3' ] )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Удаление исходного движка из мета-движка

 const engineName = 'my-meta-engine'

client
  . deleteMetaEngineSources ( engineName , [ 'source-engine-3' ] )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Создание двигателей

 const engineName = 'my-meta-engine'

client
  . createEngine ( engineName , {
    type : 'meta' ,
    source_engines : [ 'source-engine-1' , 'source-engine-2' ]
  } )
  . then ( response => console . log ( response ) )
  . catch ( error => console . log ( error . errorMessages ) )

Для API поиска приложений, недоступных в этом клиенте

Мы стараемся поддерживать этот клиент в курсе всех доступных конечных точек API, доступных из поиска приложений.

Есть несколько API, которые могут быть еще недоступны. Для этих API используйте низкоуровневый клиент для подключения к любой конечной точке поиска приложений.

 const engineName = 'favorite-videos'
const options = {
  query : 'cats'
}

const Client = require ( '@elastic/app-search-node/lib/client' )
const client = new Client ( 'private-mu75psc5egt9ppzuycnc2mc3' , 'http://localhost:3002/api/as/v1/' )
client . post ( `engines/ ${ encodeURIComponent ( engineName ) } /search` , options ) . then ( console . log )

Запуск тестов

npm test

В спецификациях этого проекта используется node-replay для захвата приборов.

Новые приборы должны быть получены из работающего экземпляра App Search.

Чтобы захватить новые приборы, запустите команду, подобную следующей:

 nvm use
HOST_IDENTIFIER=host-c5s2mj API_KEY=private-b94wtaoaym2ovdk5dohj3hrz REPLAY=record npm run test -- -g 'should create a meta engine'

Чтобы немного сломать это...

HOST_IDENTIFIER — используйте это, чтобы переопределить поддельное значение, используемое в тестах, с фактическим действительным значением для вашего экземпляра поиска приложений для записи.
API_KEY — используйте это, чтобы переопределить поддельное значение, используемое в тестах, с фактическим действительным значением для вашего экземпляра поиска приложений для записи.
REPLAY=record — указывает воспроизведению записать новый ответ, если он еще не существует.
npm run test — запустить тесты
-- -g 'should create a meta engine' - Ограничить тесты запуском ТОЛЬКО нового теста, который вы создали, например, 'должен создать мета-движок'

Это создаст новое приспособление. Обязательно отредактируйте это приспособление вручную, чтобы заменить идентификатор хоста и ключ API, записанные в этом приспособлении, значениями, которые используют тесты.

Вам также необходимо убедиться, что приспособление находится в правильно названном каталоге в разделе fixtures в соответствии с используемым хостом.

Вы узнаете, если что-то не так, потому что при запуске npm run test произойдет ошибка, например:

 Error: POST https://host-c5s2mj.api.swiftype.com:443/api/as/v1/engines refused: not recording and no network access

ЧАСТО ЗАДАВАЕМЫЕ ВОПРОСЫ ?

Куда я могу сообщить о проблемах с клиентом?

Если что-то не работает должным образом, пожалуйста, откройте проблему.

Где я могу узнать больше о поиске приложений?

Лучше всего прочитать документацию.

Куда еще я могу обратиться за помощью?

Вы можете посетить форумы обсуждения сообщества Elastic App Search.

Способствовать

Мы приветствуем участников проекта. Прежде чем начать, пара замечаний...

Прежде чем открывать запрос на включение, создайте задачу, чтобы обсудить объем вашего предложения.
Пожалуйста, пишите простой код и краткую документацию, если это необходимо.

Лицензия?

Спасибо всем участникам!

Расширять