API Reference

Overview

JavaScript SDK Setup

Install SDK from npm

npm install view-sdk

Initialize Configuration Sdk

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);

Python setup

Install SDK from pip

pip install view-sdk

Initialize Configuration Sdk

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

Check server health

To check server health, call HEAD <endpoint> 

curl --location --head 'http://view.homedns.org:8000/' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);

const checkSwitchboardHealth = async () => {
  try {
    const response = await check.checkSwitchboardHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking switchboard health:", err);
  }
};

checkSwitchboardHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkServer():
    result = health_check.SwitchBoard.check()
    print(result)

checkServer()

Check config health

To check config server health, call HEAD /healthcheck/config 

curl --location --head 'http://view.homedns.org:8000/healthcheck/config' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);

const checkConfigHealth = async () => {
  try {
    const response = await check.checkConfigHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking config health:", err);
  }
};

checkConfigHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkConfiguration():
    result = health_check.HealthCheck.configuration()
    print(result)

checkConfiguration()

Check storage health

To check storage server health, call HEAD /healthcheck/config 

curl --location --head 'http://view.homedns.org:8000/healthcheck/storage-rest' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);


const checkStorageHealth = async () => {
  try {
    const response = await check.checkStorageHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking storage health:", err);
  }
};
checkStorageHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkStorage():
    result = health_check.HealthCheck.storage()
    print(result)

checkStorage()

Check vector health

To check vector server health, call HEAD /healthcheck/config 

curl --location --head 'http://view.homedns.org:8000/healthcheck/vector' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);

const checkVectorHealth = async () => {
  try {
    const response = await check.checkVectorHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking vector store health:", err);
  }
};
checkVectorHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkVector():
    result = health_check.HealthCheck.vector()
    print(result)

checkVector()

Check processor health

To check processor server health, call HEAD /healthcheck/config 

curl --location --head 'http://view.homedns.org:8000/healthcheck/processor' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);


const checkProcessorHealth = async () => {
  try {
    const response = await check.checkProcessorHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking processor health:", err);
  }
};
checkProcessorHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkProcessor():
    result = health_check.HealthCheck.processor()
    print(result)

checkProcessor()

Check assistant health

To check assistant server health, call HEAD /healthcheck/config 

curl --location --head 'http://view.homedns.org:8000/healthcheck/assistant' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);

const checkAssistantHealth = async () => {
  try {
    const response = await check.checkAssistantHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking assistant health:", err);
  }
};
checkAssistantHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkAssistant():
    result = health_check.HealthCheck.assistant()
    print(result)

checkAssistant()

Check orchestrator health

To check orchestrator server health, call HEAD /healthcheck/config 

curl --location --head 'http://view.homedns.org:8000/healthcheck/orchestrator' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);

const checkOrchestratorHealth = async () => {
  try {
    const response = await check.checkOrchestratorHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking orchestrator health:", err);
  }
};
checkOrchestratorHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkOrchestrator():
    result = health_check.HealthCheck.orchestrator()
    print(result)

checkOrchestrator()

Check crawler health

To check crawler server health, call HEAD /healthcheck/config 

curl --location --head 'http://view.homedns.org:8000/healthcheck/crawler' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);

const checkCrawlHealth = async () => {
  try {
    const response = await check.checkCrawlerHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking crawl health:", err);
  }
};
checkCrawlHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkCrawler():
    result = health_check.HealthCheck.crawler()
    print(result)

checkCrawler()

Check lexi health

To check lexi server health, call HEAD /healthcheck/config 

curl --location --head 'http://view.homedns.org:8000/healthcheck/lexi' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);

const checkLexiconHealth = async () => {
  try {
    const response = await check.checkLexiHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking lexicon health:", err);
  }
};
checkLexiconHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkLexi():
    result = health_check.HealthCheck.lexi()
    print(result)

checkLexi()

Check embeddings health

To check embeddings server health, call HEAD /healthcheck/config 

curl --location --head 'http://view.homedns.org:8000/healthcheck/embeddings' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);


const checkEmbeddingHealth = async () => {
  try {
    const response = await check.checkEmbeddingHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking embedding health:", err);
  }
};
checkEmbeddingHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkEmbedding():
    result = health_check.HealthCheck.embeddings()
    print(result)

checkEmbedding()

Check director health

To check director server health, call HEAD /healthcheck/config 

curl --location --head 'http://view.homedns.org:8000/healthcheck/director' \
--header 'Authorization: ••••••'

import { ViewHealthcheckSdk } from "view-sdk";

const check = new ViewHealthcheckSdk(
  "00000000-0000-0000-0000-000000000000", //tenant Id
  "default", //access token
  "http://localhost:8501/" //endpoint
);

const checkDirectorHealth = async () => {
  try {
    const response = await check.checkDirectorHealth();
    console.log(response);
  } catch (err) {
    console.log("Error checking directory health:", err);
  }
};
checkDirectorHealth();

import view_sdk
from view_sdk import health_check

sdk = view_sdk.configure( access_key="default",base_url="localhost", tenant_guid= "00000000-0000-0000-0000-000000000000")

def checkDirector():
    result = health_check.HealthCheck.director()
    print(result)

checkDirector()