app search node

️ Este cliente está obsoleto ️

A partir da versão 8.3.2 do Enterprise Search, estamos direcionando os usuários para o novo Enterprise Search Node Client e descontinuando esse cliente.

Nosso esforço de desenvolvimento neste projeto será limitado a correções de bugs. Todas as melhorias futuras serão focadas no Enterprise Search Node Client.

Obrigado! - Elástico

Um cliente Node.JS próprio para criar experiências de pesquisa excelentes e relevantes com o Elastic App Search.

Conteúdo

• Começando
• Versionamento
• Uso
• Executando testes
• Perguntas frequentes
• Contribuir
• Licença

---

Começando ?

Para instalar este pacote, execute:

npm install @elastic/app-search-node

Versionamento

Este cliente é versionado e lançado junto com o App Search.

Para garantir a compatibilidade, use a versão mais recente desta biblioteca na versão principal da implementação correspondente do App Search.

Por exemplo, para App Search 7.3 , use 7.3 desta biblioteca ou superior, mas não 8.0 .

Se você estiver usando a versão SaaS disponível em swifttype.com do App Search, deverá usar a versão 7.5.x do cliente.

Uso

Configuração: Configurando o cliente e a autenticação

O uso desse cliente pressupõe que você já tenha uma instância do Elastic App Search instalada e em execução.

O cliente é configurado usando os parâmetros baseUrlFn e apiKey .

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

Observação:

O [apiKey] autentica solicitações para a API. Você pode usar qualquer tipo de chave com o cliente, porém cada uma tem um escopo diferente. Para mais informações sobre chaves, confira a documentação.

Usuários do Swiftype.com App Search:

Ao usar a versão SaaS disponível em swiftype.com do App Search, você pode configurar o cliente usando seu hostIdentifier em vez do parâmetro baseUrlFn . O hostIdentifier pode ser encontrado no menu Credenciais.

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

Métodos de API

Indexação: Criando ou Substituindo 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 ) )

Observe que esta API não gerará um erro de indexação. Os erros são incorporados no corpo da resposta por documento:

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

Indexação: Atualização de Documentos (Atualizações Parciais)

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

Recuperando Documentos

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

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

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

Destruindo Documentos

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

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

Listagem de mecanismos

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

Criando motores

 const engineName = 'favorite-videos'

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

Destruindo motores

 const engineName = 'favorite-videos'

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

Procurando

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

Pesquisa múltipla

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

Sugestão 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 ) ) 

Listando Curadorias

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

Recuperando Curadorias

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

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

Criando Curadorias

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

Atualizando Curadorias

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

Excluindo curadorias

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

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

Recuperando Esquemas

 const engineName = 'favorite-videos'

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

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

Crie uma chave de pesquisa assinada

Criando uma chave de pesquisa que retornará apenas o 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' ) 

Crie um metamecanismo

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

Adicionar um mecanismo de origem a um metamotor

 const engineName = 'my-meta-engine'

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

Remover um mecanismo de origem de um metamotor

 const engineName = 'my-meta-engine'

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

Criando 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 APIs do App Search não disponíveis neste cliente

Tentamos manter este cliente atualizado com todos os endpoints de API disponíveis no App Search.

Existem algumas APIs que podem não estar disponíveis ainda. Para essas APIs, use o cliente de baixo nível para se conectar e atingir qualquer endpoint do 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 ) 

Executando testes

npm test

As especificações neste projeto usam node-replay para capturar fixtures.

Novos fixtures devem ser capturados de uma instância em execução do App Search.

Para capturar novos fixtures, execute um comando como o seguinte:

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

Para quebrar um pouco isso...

• HOST_IDENTIFIER - Use isto para substituir o valor falso usado em testes por um valor real válido para sua instância do App Search registrar
• API_KEY - Use isto para substituir o valor falso usado em testes por um valor real válido para sua instância do App Search registrar
• REPLAY=record - Diz ao replay para gravar uma nova resposta se ainda não existir
• npm run test – Execute os testes
• -- -g 'should create a meta engine' - Limite os testes para executar SOMENTE o novo teste que você criou, 'deveria criar um meta-mecanismo' por exemplo

Isso criará um novo fixture, certifique-se de editar manualmente esse fixture para substituir o identificador do host e a chave da API registrada naquele fixture pelos valores que os testes usam.

Você também precisará ter certeza de que o fixture está localizado no diretório nomeado corretamente em fixtures de acordo com o host que foi usado.

Você saberá se algo não está certo porque ocorrerá um erro ao executar npm run test com um erro como:

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

PERGUNTAS FREQUENTES ?

Onde posso relatar problemas com o cliente?

Se algo não estiver funcionando conforme o esperado, abra um problema.

Onde posso aprender mais sobre o App Search?

Sua melhor aposta é ler a documentação.

Onde mais posso ir para obter ajuda?

Você pode conferir os fóruns de discussão da comunidade do Elastic App Search.

Contribuir

Congratulamo-nos com colaboradores do projeto. Antes de começar, algumas notas...

• Antes de abrir uma solicitação pull, crie um problema para discutir o escopo de sua proposta.
• Escreva código simples e documentação concisa, quando apropriado.

Licença?

Apache 2.0 © Elástico

Obrigado a todos os colaboradores!