LogoLogo
Developer HubGitHubContact Us
  • Welcome!
  • Olive Helps
    • Platform
      • How Olive Helps Works
      • Installation
      • Account Creation
      • Distributing Olive Helps
    • FAQs
      • General Loop FAQs
      • Loop Development FAQs
      • Olive Helps User FAQs
      • Security / IT FAQs
    • Data Security
      • User Data
      • Antivirus and Firewalls
  • Loop Development Kit
    • Your First Loop
      • Become a Loop Author
      • Creating a Loop
      • Build Your Loop
      • Local Loop Installation
      • Restarting Local Loops
    • Troubleshooting
    • Loop Security
      • Permissions
      • Environment Permissions
    • Loop Publication
      • Loop Approval Checklist
    • Loop Analytics Library
    • Examples
  • Documentation
  • Interfaces
  • Type Alias
  • Enumerations
  • Whisper Components
    • Base Attributes
    • Autocomplete
    • Box
    • Breadcrumb
    • Button
    • Chart
    • CollapseBox
    • Grid
    • Checkbox
    • Date Time
    • Divider
    • DropZone
    • Email
    • Icon
    • List Pair
    • Link
    • Pagination
    • Number
    • Markdown
    • Message
    • Password
    • Progress
    • Radio
    • Rating
    • RichTextEditor
    • Section Title
    • Select
    • Text Input
    • Telephone
    • Typography
  • APTITUDES
    • What are Aptitudes?
    • Browser
    • Clipboard
    • Config
    • Cursor
      • Screen Scaling Behavior
    • Document
    • Filesystem
    • Keyboard
    • Network
    • Process
    • Screen
    • Search
      • Index
    • System
    • UI
      • Loop UI Handlers
    • User
      • JWT
    • Vault
    • Whisper
      • Whisper Updates
      • JSX Whispers
    • Window
      • Screen Scaling Behavior
  • Release Notes
    • What's New
      • Olive Helps v0.55.0
      • Olive Helps v0.54.1
      • Olive Helps v0.53.1
      • Olive Helps v0.51.2
      • LDK v4.0.0
      • Olive Helps v0.50.3
      • Olive Helps v0.49.5
      • LDK v 3.18.0
      • Olive Helps v0.47.2
      • Olive Helps v0.46.2
      • LDK v 3.17.0
      • Olive Helps v0.45.4
      • Olive Helps v0.44.2
      • Olive Helps v0.43.1
      • Olive Helps v0.42.1
      • Olive Helps v0.41.4
      • Olive Helps v0.40.2
      • Olive Helps v0.39.4 & LDK v3.16.0
      • Olive Helps v0.38.8 & LDK v3.15.0
      • Olive Helps v0.36.5
      • Olive Helps v0.36.4
    • Archive
      • Olive Helps v0.36.3 & LDK v3.14.0
      • Olive Helps v0.34.4
      • LDK v3.13.0
      • Olive Helps v0.32.2 & LDK v3.12.0
      • Olive Helps v0.31.2 & LDK v3.11.0
      • Olive Helps v0.30.2 & LDK v3.10.0
      • Olive Helps v0.29.4
      • Olive Helps v0.29.3 & LDK v3.9.0
      • Olive Helps v0.28.3 & LDK v3.8.0
      • Olive Helps v0.27.7
      • Olive Helps v0.27.5
      • Olive Helps v.027.4
      • Olive Helps v0.27.2 & LDK v3.7.0
      • Olive Helps v0.25.3 & LDK v3.5.1
      • Olive Helps v0.24.6 & LDK v3.4.0
      • Olive Helps v0.23.2 & LDK v3.3.0
      • Olive Helps v0.22.3 & LDK v3.2.0
Powered by GitBook
On this page
  • search
  • queryStringSearch
  • update
  • delete

Was this helpful?

  1. APTITUDES
  2. Search

Index

An index is the main object in which searching is done. After creating an index via the search Aptitude, a Loop author can query the indexed documents or modify the indices through this interface.

search

Searches anywhere in the documents for the specified term.

import { search } from '@oliveai/ldk';

// See the main search page for opening and creating an index
// We'll be using the index created in the createIndex example

const indexName = "myIndex";

const config = {
    sortBy: ['-lastName', 'firstName'], 
    searchSize: 10,
    exactMatchThreshold: 4,
    beginWithSearch: true,
};

search.openIndex(indexName, config).then( index => {
  myIndex.search("geo").then( result => {
    console.log(JSON.stringify(result));
  });
});

/*
  {
    "data": [
      {
        "_documentName": "George Smith",
        "_type": "George Smith",
        "firstName": "George",
        "lastName": "Smith"
      },
      {
        "_type": "Geoffrey McPerson",
        "firstName": "Geoffrey",
        "lastName": "McPerson",
        "_documentName": "Geoffrey McPerson"
      },
      {
        "firstName": "George",
        "lastName": "Jones",
        "_documentName": "George Jones",
        "_type": "George Jones"
      }
    ],
    "total": 3
  }
*/

queryStringSearch

import { search } from '@oliveai/ldk';

// See the main search page for opening and creating an index
// We'll be using the index created in the createIndex example

const indexName = "myIndex";

const config = {
    sortBy: ['-lastName', 'firstName'], 
    searchSize: 10,
    exactMatchThreshold: 4,
    beginWithSearch: true,
};

search.openIndex(indexName, config).then( index => {
  myIndex.queryStringSearch("lastName:Jones").then( result => {
    console.log(JSON.stringify(result));
  });
});

/*
{
  "data": [
    {
      "_documentName": "George Jones",
      "_type": "George Jones",
      "firstName": "George",
      "lastName": "Jones"
    }
  ],
  "total": 1
}
*/

update

Updates the index to point to a new set of documents and a new configuration.

import { search } from '@oliveai/ldk';

// See the main search page for opening and creating an index
// as well as an example on documents and configuration objecs
const index = await search.openIndex(indexName, config);

const newDocuments = getUpdatedDocuments();
const newConfig = getUpdatedConfig();

index.update(newDocuments, newConfig);

delete

Deletes the specified index. Attempting to use the index after it has been deleted will result in an error being thrown.

import { search } from '@oliveai/ldk';

// See the main search page for opening and creating an index

search.openIndex(indexName, config).then( index => {
    index.delete();
});
PreviousSearchNextSystem

Last updated 3 years ago

Was this helpful?

Provides the capability to do a more advance search allowing the loop author to search on specific fields (<fieldname>:<search value>) as well as regex (*.+?, etc..). You can see more of what we support .

here