aidaptive-sdk
TypeScript icon, indicating that this package has built-in type declarations

1.1.5 • Public • Published

Getting Started

Integrate Aidaptive Predictive Recommendations and Search in your React, React Native, Next JS, Angular or other client side npm frameworks.

Installation Steps

  • Install aidaptive-sdk with npm
npm install aidaptive-sdk
  • Add the Jarvis ML CDN Script in your project's index.html file
<script src=“https://cdn.jarvisml.com/jarvisml-id.min.js”></script>
  • For running locally, provide debug_source
<script src=“https://cdn.jarvisml.com/jarvisml-id.min.js?debug_source={{SITE_URL}}”></script>

Usage

Recommendations

import { Component } from '@angular/core';
import { getRecommendations } from 'aidaptive-sdk';


export class AppComponent{
  result: any;
  constructor() {
    this.getResults();
  }

  async getResults() {
    this.result = await getRecommendations({
      recommendationsCount: 4,    // Recommendations Count 
      pageType: "home",           // Source of the Request (Home, PropertyDetails, ect...)
      locationFilter: "paris".    // Location Name
      });
  }
}

Search Results

import { Component } from '@angular/core';
import { getSearchResults } from 'aidaptive-sdk';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
export class AppComponent{
  title = 'aidaptive-angular-sample';
  result: any;
  
  searchFilters = {
    distanceToBeach: [ 
      "Oceanfront",
      "More than 500 Feet",
      "More than 1000 Feet",
      "Semi-Oceanfront",
      "Less than 500 Feet",
      "Canal Front",
      "Oceanside"
    ],
    date : "start date of the reservation [type: datetime.date, i.e 2018-12-19] (optional)",
    days: "Number of days of the stay [int] (optional)",
    min_price: "Min price rate [int] (optional)",
    max_price: "Max price rate [int] (optional)",
    min_bedrooms: "Minimum number of bedrooms [int](optional)",
    max_bedrooms: "Maximum number of bedrooms [int](optional)",
    min_master_bedrooms: "Minimum number of master bedrooms [int](optional)",
    max_master_bedrooms: "Maximum number of master bedrooms [int](optional)",
    min_bathrooms: "Minimum number of bathrooms [int](optional)",
    max_bathrooms: "Maximum number of bathrooms [int](optional)",
    city: "list with names of the cities [List(str)](optional)",
    hard_filters: "list of hard- filters for search[List(str)](optional)",
    soft_filters : "list of soft - filters for relevancy ranking[List(str)]",
  }

  constructor() {
    this.getResults();
  }

  async getResults() {
    this.result = await getSearchResults({
      value: "beach",                      // Search Keyword
      pageSize: 10,                        // Records Per Page
      pageToken: ""                        // Pagination Token
      totalRecords: 100,                   // Results Count
      searchFilters: this.searchFilters    // Filter Object
    });
    console.log(this.result)
  }
}

Contact Us

For more information, email us: support@aidaptive.com

Readme

Keywords

none

Package Sidebar

Install

npm i aidaptive-sdk

Weekly Downloads

17

Version

1.1.5

License

ISC

Unpacked Size

64.6 kB

Total Files

9

Last publish

Collaborators

  • aidaptive