IRBIS API Reference
  • IRBIS API Reference
  • Disclaimer for IRBIS Search Portal and Services
  • Introduction
  • Authenticate
  • Requests Endpoints
  • LookupId-List API Endpoint
  • Retrieve the API Results for all requests.
    • GET Multiple Results
    • Search Response Schema
  • Delete Record API
    • Headers and Body Request for Delete Record
  • Retrieve Credits Status API
    • Search Response Schema
  • BreachScan
    • Headers and Body Request by deepweb values
    • GET Get lookup data for a request by deepweb values
    • Search Response Schema
  • Phone Lookup
    • Headers and Body Request by Phone
    • GET Get lookup data for a request by Phone
    • Search Response Schema
  • Phone Verification (Real Phone)
    • Headers and Body Request by Phone
    • GET Get lookup data for a request by Phone
    • Search Response Schema
  • Phone Validation Request (Optional)
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Phone Vs Name Validator
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • E-mail Lookup
    • Headers and Body Request by E-mail Lookup
    • GET Get lookup data for a request by E-mail Lookup
    • Search Response Schema
  • Name SocialScan
    • Headers and Body Request by Name Lookup
    • GET Get lookup data for a request by Name Lookup
    • Search Response Schema
  • Name WebScan
    • Headers and Body Request by Telescope
    • GET Get lookup data for a request by Name Lookup
    • Search Response Schema
  • Leads Search
    • Headers and Body Request by Topick
    • GET Get lookup data for a request by Post
    • Search Response Schema
  • Face WebScan
    • Headers and Body Request by Face WebScan
    • GET Get lookup data for a request by Face WebScan
    • Search Response Schema
  • AI Sentiment Analysis
    • Headers and Body Request by Text body
    • GET Get lookup data for a request by Text body
    • Search Response Schema
  • KYC Validator
    • Headers and Body Request by KYC Validator
    • Request KYC Validator results
    • Search Response Schema
  • WEB Scraper
    • Headers and Body Request
    • Request Response Data
    • Search Response Schema
  • IP Geolocation
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Phone Vs IP Validator
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Psychological Portrait
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Psycho Profile and Summary by Text & Name (Optional)
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Compliance Screening
    • SSN Trace (US only)
    • National Criminal Screening (US only)
    • Watchlists and Politically Exposed Persons (International)
    • Court Records (US only)
Powered by GitBook
On this page
  1. AI Sentiment Analysis

Search Response Schema

Search Response Schema for Sentiment Analysis

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "criteria": {
      "type": "string",
      "description": "The criteria or content for sentiment analysis."
    },
    "type": {
      "type": "string",
      "description": "The type of analysis being performed.",
      "enum": ["sentiment_analysys"]
    },
    "status": {
      "type": "string",
      "description": "The status of the sentiment analysis.",
      "enum": ["progress", "finished"]
    },
    "sources": {
      "type": "array",
      "description": "List of sources used for the sentiment analysis.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the source."
          }
        },
        "required": ["name"]
      }
    },
    "data": {
      "type": "array",
      "description": "List of data objects containing sentiment analysis results.",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "description": "The original text that was analyzed."
          },
          "sentiment": {
            "type": "string",
            "description": "The sentiment result of the analysis.",
            "enum": ["POSSITIVE", "NEGATIVE", "NEUTRAL"]
          },
          "topic": {
            "type": "string",
            "description": "The topic or subject of the text."
          },
          "summary": {
            "type": "string",
            "description": "A brief summary of the text."
          },
          "entity": {
            "type": "string",
            "description": "The main entity or location mentioned in the text."
          },
          "status": {
            "type": "string",
            "description": "The status of the individual data item's analysis.",
            "enum": ["COMPLETED"]
          },
          "null": {
            "type": "boolean",
            "description": "Indicates if the data item is null or not."
          }
        },
        "required": ["text", "sentiment", "topic", "summary", "entity", "status", "null"]
      }
    }
  },
  "required": ["criteria", "type", "status", "sources", "data"]
}
PreviousGET Get lookup data for a request by Text bodyNextKYC Validator

Last updated 11 months ago