Descarga app search node - Descarga del código fuente app search node

️ Este cliente está en desuso ️
A partir de la versión 8.3.2 de Enterprise Search, dirigiremos a los usuarios al nuevo cliente de nodo de Enterprise Search y dejaremos de utilizar este cliente.
Nuestro esfuerzo de desarrollo en este proyecto se limitará a corregir errores. Todas las mejoras futuras se centrarán en Enterprise Search Node Client.
¡Gracias! - Elástico

Logotipo de búsqueda de aplicaciones elásticas

Un cliente Node.JS propio para crear experiencias de búsqueda excelentes y relevantes con Elastic App Search.

Contenido

Empezando
Versionado
Uso
Ejecución de pruebas
Preguntas frecuentes
Contribuir
Licencia

Empezando ?

Para instalar este paquete, ejecute:

npm install @elastic/app-search-node

Versionado

Este cliente tiene una versión y se lanza junto con App Search.

Para garantizar la compatibilidad, utilice la versión más reciente de esta biblioteca dentro de la versión principal de la implementación de App Search correspondiente.

Por ejemplo, para App Search 7.3 , use 7.3 de esta biblioteca o superior, pero no 8.0 .

Si está utilizando la versión SaaS disponible en swiftype.com de App Search, debe utilizar la versión 7.5.x del cliente.

Uso

Configuración: configuración del cliente y autenticación

El uso de este cliente supone que ya tiene una instancia de Elastic App Search en funcionamiento.

El cliente se configura utilizando los parámetros baseUrlFn y apiKey .

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

Nota:

La [apiKey] autentica las solicitudes a la API. Puede utilizar cualquier tipo de clave con el cliente, sin embargo, cada una tiene un alcance diferente. Para obtener más información sobre las claves, consulte la documentación.

Usuarios de búsqueda de la aplicación Swifttype.com:

Cuando utilice la versión SaaS disponible en swiftype.com de App Search, puede configurar el cliente utilizando su hostIdentifier en lugar del parámetro baseUrlFn . El hostIdentifier se puede encontrar en el menú Credenciales.

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

Métodos API

Indexación: creación o reemplazo de documentos

 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 ) )

Tenga en cuenta que esta API no generará un error de indexación. Los errores están incluidos en el cuerpo de la respuesta por documento:

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

Indexación: Actualización de documentos (Actualizaciones parciales)

 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 ) )

Recuperar documentos

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

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

Listado de documentos

 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 ) )

Destruyendo documentos

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

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

Listado de motores

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

Recuperando motores

 const engineName = 'favorite-videos'

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

Creando motores

 const engineName = 'favorite-videos'

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

Destruyendo motores

 const engineName = 'favorite-videos'

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

Búsqueda

 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 ) )

Búsqueda múltiple

 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 ) )

Sugerencia de consulta

 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 ) )

Listado de curaciones

 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 ) )

Recuperar curaciones

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

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

Creando curaciones

 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 ) )

Actualizando curaciones

 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 ) )

Eliminar curaciones

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

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

Recuperar esquemas

 const engineName = 'favorite-videos'

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

Actualizando esquemas

 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 ) )

Crear una clave de búsqueda firmada

Crear una clave de búsqueda que solo devolverá el campo de título.

 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' )

Crear un metamotor

 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 ) )

Agregar un motor de origen a un metamotor

 const engineName = 'my-meta-engine'

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

Eliminar un motor de origen de un metamotor

 const engineName = 'my-meta-engine'

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

Creando motores

 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 ) )

Para las API de App Search no disponibles en este cliente

Intentamos mantener este cliente actualizado con todos los puntos finales API disponibles en App Search.

Hay algunas API que es posible que aún no estén disponibles. Para esas API, utilice el cliente de bajo nivel para conectarse y acceder a cualquier punto final de App Search.

 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 )

Ejecución de pruebas

npm test

Las especificaciones de este proyecto utilizan node-replay para capturar luminarias.

Los nuevos dispositivos deben capturarse desde una instancia en ejecución de App Search.

Para capturar nuevos dispositivos, ejecute un comando como el siguiente:

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

Para desmenuzar eso un poco...

HOST_IDENTIFIER : use esto para anular el valor falso usado en las pruebas con un valor válido real para que su instancia de App Search registre
API_KEY : use esto para anular el valor falso usado en las pruebas con un valor válido real para que su instancia de App Search registre.
REPLAY=record - Le dice a la repetición que registre una nueva respuesta si aún no existe una.
npm run test : ejecuta las pruebas
-- -g 'should create a meta engine' - Limite las pruebas para ejecutar SÓLO la nueva prueba que ha creado, 'debería crear un metamotor', por ejemplo

Esto creará un nuevo dispositivo, asegúrese de editarlo manualmente para reemplazar el identificador de host y la clave API registrados en ese dispositivo con los valores que utilizan las pruebas.

También deberá asegurarse de que el dispositivo esté ubicado en el directorio con el nombre correcto en fixtures según el host que se utilizó.

Sabrá si algo no está bien porque se producirá un error cuando ejecute npm run test con un error como:

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

¿Preguntas frecuentes?

¿Dónde informo problemas con el cliente?

Si algo no funciona como se esperaba, abra un problema.

¿Dónde puedo obtener más información sobre la búsqueda de aplicaciones?

Lo mejor que puede hacer es leer la documentación.

¿Dónde más puedo acudir para obtener ayuda?

Puede consultar los foros de discusión de la comunidad Elastic App Search.

Contribuir

Damos la bienvenida a los contribuyentes al proyecto. Antes de comenzar, un par de notas...

Antes de abrir una solicitud de extracción, cree un problema para analizar el alcance de su propuesta.
Escriba código simple y documentación concisa, cuando sea apropiado.

¿Licencia?

¡Gracias a todos los contribuyentes!

Expandir