Landing AI JS Library - v1.0.0

LandingLens JavaScript Library

The LandingLens JavaScript library contains the LandingLens development library and examples that show how to integrate your app with LandingLens in a variety of scenarios.

We've provided some examples in CodeSandbox to focus on ease of use.

Example Description Type
Poker Card Suit Identification This example shows how to use an Object Detection model from LandingLens to detect suits on playing cards. CodeSandbox

Install the libraries

npm install landingai landingai-react
# OR
yarn add landingai landingai-react

Quick Start

Prerequisites

This library needs to communicate with the LandingLens platform to perform certain functions. (For example, the getInferenceResult API calls the HTTP endpoint of your deployed model). To enable communication with LandingLens, you will need the following information:

  • The Endpoint ID of your deployed model in LandingLens. You can find this on the Deploy page in LandingLens.
  • The API Key for the LandingLens organization that has the model you want to deploy. To learn how to generate these credentials, go here.

Collect Images and Run Inference

Collect images and run inference using the endpoint you created in LandingLens:

  1. Install the JS libraries.
  2. Construct an apiInfo object and pass it to <InferenceContext.Provider>.
  3. Render the image collector to get image blob.
  4. Render the inference result component to visualize predictions.
import React from 'react';
import { useState } from "react";
import { InferenceContext, InferenceResult, PhotoCollector } from "landingai-react";

const apiInfo = {
endpoint: `https://predict.app.landing.ai/inference/v1/predict?endpoint_id=<FILL_YOUR_INFERENCE_ENDPOINT_ID>`,
key: "<FILL_YOUR_API_KEY>",
};

export default function App() {
const [image, setImage] = useState();

return (
<InferenceContext.Provider value={apiInfo}>
<PhotoCollector setImage={setImage} />
<InferenceResult image={image} />
</InferenceContext.Provider>
);
}

See a working example in here.

Documentation

Generated using TypeDoc