{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Intuition APIs V3 — Developer Guide","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"intuition-apis-v3--developer-guide","__idx":0},"children":["Intuition APIs V3 — Developer Guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies to:"]}," Sprinklr Intuition APIs (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition"]},")"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":1},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sprinklr Intuition APIs run machine-learning predictions and classifications against text or publicly accessible resources. The APIs support single-item and batch requests for text classification, location insights, product insights, intent detection, and visual detection."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A single prediction request is an object containing an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]}," and the input required by that engine. A batch request is an array of the same request objects."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"11-supported-operations","__idx":2},"children":["1.1 Supported operations"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text prediction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition/text/predict"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch text prediction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition/text/batch-predict"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Location Insights prediction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition/location-insights/predict"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch Location Insights prediction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition/location-insights/batch-predict"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Product Insights prediction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition/product-insights/predict"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch Product Insights prediction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition/product-insights/batch-predict"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Intent prediction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition/intent/predict"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch Intent prediction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition/intent/batch-predict"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Visual prediction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition/visual/predict"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch Visual prediction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/intuition/visual/batch-predict"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"12-single-and-batch-request-model","__idx":3},"children":["1.2 Single and batch request model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Single endpoints accept one request object. Batch endpoints accept an array of request objects. Each request identifies the model or task through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]}," and supplies ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resourceURL"]},", or other engine-specific input."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-url","__idx":4},"children":["2. Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All documented endpoints use the following base URL:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/api/v3\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Intuition resource is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/api/v3/intuition\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":5},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Include a valid API V3 bearer token. The selected ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]}," must identify an available Intuition engine."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required on"},"children":["Required on"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer <accessToken>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the caller."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates a JSON request body."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All documented ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requests a JSON response."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommended"]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not publish, commit, or log real access tokens."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-common-request-model","__idx":6},"children":["4. Common request model"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-single-request-fields","__idx":7},"children":["4.1 Single-request fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Root object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Input text to classify or analyze. Required for text-based engines."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Root object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["language"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Language of the input text. Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Root object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Engine key identifying the machine-learning model or task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Root object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resourceURL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Publicly accessible resource URL. Required for engines that use a URL instead of inline content."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Root object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object<String, String>"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional key-value metadata passed to the engine."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dynamic key-value pair"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Engine-specific metadata."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-batch-request-fields","__idx":8},"children":["4.2 Batch-request fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Root"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collection of prediction request objects."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Input text to classify or analyze. Required for text-based engines."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["language"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Language of the input text. Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Engine key identifying the machine-learning model or task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resourceURL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Publicly accessible resource URL. Required for URL-based engines."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object<String, String>"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional key-value metadata passed to the engine."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-text-prediction-apis","__idx":9},"children":["5. Text Prediction APIs"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-predict-text","__idx":10},"children":["5.1 Predict text"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v3/intuition/text/predict\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submits text or another supported resource for machine-learning prediction or classification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body","__idx":11},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#41-single-request-fields"},"children":["common single-request fields"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request","__idx":12},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/api/v3/intuition/text/predict' \\\n  --header 'Authorization: Bearer <accessToken>' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '{\n    \"engineKey\": \"sentiment-en\",\n    \"text\": \"I love this product!\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response","__idx":13},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"HTTP/1.1 204 No Content\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The source document records ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}," for this operation and provides no response body or response-parameter schema."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"52-batch-predict-text","__idx":14},"children":["5.2 Batch predict text"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v3/intuition/text/batch-predict\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Runs text predictions for multiple request objects in one API call. Each array item follows the Text Predict request model."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-1","__idx":15},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#42-batch-request-fields"},"children":["common batch-request fields"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-batch-sentiment-prediction","__idx":16},"children":["Example request: batch sentiment prediction"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/api/v3/intuition/text/batch-predict' \\\n  --header 'Authorization: Bearer <accessToken>' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '[\n    { \"engineKey\": \"sentiment-en\", \"text\": \"Great service!\" },\n    { \"engineKey\": \"sentiment-en\", \"text\": \"Terrible experience.\" }\n  ]'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-mixed-engine-keys","__idx":17},"children":["Example request: mixed engine keys"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"engineKey\": \"sentiment-en\",\n    \"text\": \"Love it\",\n    \"language\": \"en\"\n  },\n  {\n    \"engineKey\": \"topic-classifier\",\n    \"text\": \"Shipping delay\",\n    \"details\": {\n      \"channel\": \"twitter\"\n    }\n  }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters","__idx":18},"children":["Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameters"},"children":["Sub-parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of text-prediction result objects."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].input"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].response"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].input"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Echo of the corresponding request element."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request-specific fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].response"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text-prediction response."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["classDetails"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].response.classDetails"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detected classification details."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detected category label."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prediction confidence between 0 and 1."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object<String, String>"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Engine-specific metadata."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dynamic key-value pairs"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-1","__idx":19},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"input\": {\n        \"engineKey\": \"sentiment-en\",\n        \"text\": \"Great service!\"\n      },\n      \"response\": {\n        \"classDetails\": [\n          { \"label\": \"Positive\", \"confidence\": 0.91 }\n        ]\n      }\n    },\n    {\n      \"input\": {\n        \"engineKey\": \"sentiment-en\",\n        \"text\": \"Terrible experience.\"\n      },\n      \"response\": {\n        \"classDetails\": [\n          { \"label\": \"Negative\", \"confidence\": 0.88 }\n        ]\n      }\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"http-status-codes","__idx":20},"children":["HTTP status codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Condition"},"children":["Condition"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns an array of text-prediction result objects."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Null body, null array element, validation failure, or invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal classification or downstream-service failure."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"behavior-notes","__idx":21},"children":["Behavior notes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Each request element is validated independently."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A null element at any array index returns HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Results are correlated with inputs through server-assigned internal IDs."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-location-insights-apis","__idx":22},"children":["6. Location Insights APIs"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-predict-location-insights","__idx":23},"children":["6.1 Predict location insights"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v3/intuition/location-insights/predict\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Analyzes unstructured text and returns detected location categories, subjects, sentiments, and phrase-level details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters","__idx":24},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters","__idx":25},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-2","__idx":26},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#41-single-request-fields"},"children":["common single-request fields"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-minimal","__idx":27},"children":["Example request: minimal"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/api/v3/intuition/location-insights/predict' \\\n  --header 'Authorization: Bearer <accessToken>' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '{\n    \"engineKey\": \"location-insights-en\",\n    \"text\": \"The store in downtown Chicago was amazing.\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-language-specified","__idx":28},"children":["Example request: language specified"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"engineKey\": \"location-insights-en\",\n  \"text\": \"Visited the Paris flagship store.\",\n  \"language\": \"en\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters-1","__idx":29},"children":["Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameters"},"children":["Sub-parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Single location-insight result."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["input"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.input"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Echo of the request input. The server assigns an internal ID."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["language"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resourceURL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.response"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array<Object>"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detected location-insight phrase details."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subject"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentiment"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detected location-category phrase."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phrase"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subject"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detected location-subject phrase."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phrase"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentiment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detected sentiment phrase."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phrase"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object<String, String>"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Engine-specific metadata."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dynamic key-value pairs"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Category name for the detected phrase."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Starting character position."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ending character position."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phrase"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detected phrase text."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prediction confidence between 0 and 1."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-2","__idx":30},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"input\": {\n      \"engineKey\": \"location-insights-en\",\n      \"text\": \"The store in downtown Chicago was amazing.\",\n      \"language\": \"en\"\n    },\n    \"response\": [\n      {\n        \"category\": {\n          \"name\": \"Location Experience\",\n          \"start\": 4,\n          \"end\": 29,\n          \"phrase\": \"store in downtown Chicago\",\n          \"confidence\": 0.91\n        },\n        \"sentiment\": {\n          \"name\": \"Positive\",\n          \"start\": 34,\n          \"end\": 41,\n          \"phrase\": \"amazing\",\n          \"confidence\": 0.95\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"http-status-codes-1","__idx":31},"children":["HTTP status codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Condition"},"children":["Condition"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns one location-insight result object."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Null body, null list element, validation failure, or invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal classification or downstream-service failure."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-batch-predict-location-insights","__idx":32},"children":["6.2 Batch predict location insights"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v3/intuition/location-insights/batch-predict\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Runs Location Insights predictions for multiple request objects in one API call."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-3","__idx":33},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#42-batch-request-fields"},"children":["common batch-request fields"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-1","__idx":34},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/api/v3/intuition/location-insights/batch-predict' \\\n  --header 'Authorization: Bearer <accessToken>' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '[\n    { \"engineKey\": \"location-insights-en\", \"text\": \"Great store in NYC.\" },\n    { \"engineKey\": \"location-insights-en\", \"text\": \"Poor service in London.\" }\n  ]'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters-2","__idx":35},"children":["Response parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The batch response uses the same phrase-detail objects as the single response, but ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," is an array."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameters"},"children":["Sub-parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of location-insight result objects."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].input"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].response"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].input"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Echo of the request input."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Common request fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].response"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array<Object>"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detected phrase details."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subject"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentiment"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Location-category phrase."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phrase"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subject"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Location-subject phrase."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phrase"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentiment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sentiment phrase."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phrase"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-3","__idx":36},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"input\": {\n        \"engineKey\": \"location-insights-en\",\n        \"text\": \"Great store in NYC.\"\n      },\n      \"response\": [\n        {\n          \"category\": {\n            \"name\": \"Location Experience\",\n            \"phrase\": \"store in NYC\"\n          },\n          \"sentiment\": {\n            \"name\": \"Positive\",\n            \"phrase\": \"Great\"\n          }\n        }\n      ]\n    },\n    {\n      \"input\": {\n        \"engineKey\": \"location-insights-en\",\n        \"text\": \"Poor service in London.\"\n      },\n      \"response\": [\n        {\n          \"subject\": {\n            \"name\": \"Service\",\n            \"phrase\": \"service\"\n          },\n          \"sentiment\": {\n            \"name\": \"Negative\",\n            \"phrase\": \"Poor\"\n          }\n        }\n      ]\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"http-status-codes-2","__idx":37},"children":["HTTP status codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Condition"},"children":["Condition"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns an array of location-insight results."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Null body, null list element, validation failure, or invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal classification or downstream-service failure."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-product-insights-apis","__idx":38},"children":["7. Product Insights APIs"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"71-predict-product-insights","__idx":39},"children":["7.1 Predict product insights"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v3/intuition/product-insights/predict\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies product categories, brands, sentiment, and phrase-level insight details, including hierarchical product categorization."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-4","__idx":40},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#41-single-request-fields"},"children":["common single-request fields"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-2","__idx":41},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/api/v3/intuition/product-insights/predict' \\\n  --header 'Authorization: Bearer <accessToken>' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '{\n    \"engineKey\": \"product-insights-en\",\n    \"text\": \"The new iPhone camera is incredible but battery life is poor.\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters-3","__idx":42},"children":["Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameters"},"children":["Sub-parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Single product-insight result."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["input"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["input"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Echo of the request input."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Common request fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prediction output."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brand"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentiment"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Product-category phrase with hierarchy."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phrase"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l1"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l3"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brand"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detected brand phrase."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phrase"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentiment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detected sentiment phrase."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phrase"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Engine-specific metadata."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dynamic key-value pairs"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Level-1 product category."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Level-2 product category."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l3"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Level-3 product category."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-4","__idx":43},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"input\": {\n      \"engineKey\": \"product-insights-en\"\n    },\n    \"response\": [\n      {\n        \"category\": {\n          \"name\": \"Smartphones\",\n          \"l1\": \"Electronics\"\n        },\n        \"brand\": {\n          \"name\": \"Apple\"\n        },\n        \"sentiment\": {\n          \"name\": \"Mixed\"\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"http-status-codes-3","__idx":44},"children":["HTTP status codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Condition"},"children":["Condition"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns a product-insight result object."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Null request body or invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal classification or downstream-service failure."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"72-batch-predict-product-insights","__idx":45},"children":["7.2 Batch predict product insights"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v3/intuition/product-insights/batch-predict\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Runs Product Insights predictions for multiple text inputs in one API call."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-5","__idx":46},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#42-batch-request-fields"},"children":["common batch-request fields"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-3","__idx":47},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/api/v3/intuition/product-insights/batch-predict' \\\n  --header 'Authorization: Bearer <accessToken>' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '[\n    { \"engineKey\": \"product-insights-en\", \"text\": \"Love the Nike shoes.\" },\n    { \"engineKey\": \"product-insights-en\", \"text\": \"Samsung TV has great picture.\" }\n  ]'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-5","__idx":48},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"HTTP/1.1 200 Success\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The source document specifies a successful HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response but does not provide the response body or a response-parameter table for this operation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-intent-prediction-apis","__idx":49},"children":["8. Intent Prediction APIs"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"81-predict-intent","__idx":50},"children":["8.1 Predict intent"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v3/intuition/intent/predict\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies user intent, categorization details, and phrase-level insights using the selected intent-classification engine."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-6","__idx":51},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#41-single-request-fields"},"children":["common single-request fields"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-4","__idx":52},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/api/v3/intuition/intent/predict' \\\n  --header 'Authorization: Bearer <accessToken>' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '{\n    \"engineKey\": \"intent-classifier\",\n    \"text\": \"I want to cancel my subscription\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-6","__idx":53},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"HTTP/1.1 200 Success\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The source document specifies a successful HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response but does not provide the response body or a response-parameter table for this operation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"82-batch-predict-intent","__idx":54},"children":["8.2 Batch predict intent"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v3/intuition/intent/batch-predict\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Runs intent predictions for multiple text inputs in one request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-7","__idx":55},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#42-batch-request-fields"},"children":["common batch-request fields"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-5","__idx":56},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/api/v3/intuition/intent/batch-predict' \\\n  --header 'Authorization: Bearer <accessToken>' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '[\n    {\n      \"engineKey\": \"intent-classifier\",\n      \"text\": \"I want to cancel my subscription\"\n    },\n    {\n      \"engineKey\": \"intent-classifier\",\n      \"text\": \"How do I update my billing information?\"\n    }\n  ]'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-7","__idx":57},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"HTTP/1.1 200 Success\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The source document specifies a successful HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response but does not provide the response body or a response-parameter table for this operation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-visual-prediction-apis","__idx":58},"children":["9. Visual Prediction APIs"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"91-predict-visual-content","__idx":59},"children":["9.1 Predict visual content"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v3/intuition/visual/predict\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Runs image-based prediction using a public resource URL and an engine key. The operation is described as returning detected visual entities, confidence scores, and bounding-box information."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-8","__idx":60},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#41-single-request-fields"},"children":["common single-request fields"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resourceURL"]}," is required for image or visual engines that operate on a resource URL."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-6","__idx":61},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/api/v3/intuition/visual/predict' \\\n  --header 'Authorization: Bearer <accessToken>' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '{\n    \"engineKey\": \"logo-detection\",\n    \"resourceURL\": \"https://example.com/banner.jpg\",\n    \"language\": \"en\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-8","__idx":62},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"HTTP/1.1 200 Success\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The source document specifies a successful HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response but does not provide the response body or response-parameter table."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"92-batch-predict-visual-content","__idx":63},"children":["9.2 Batch predict visual content"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v3/intuition/visual/batch-predict\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Runs visual predictions for multiple image inputs in one request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-9","__idx":64},"children":["Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#42-batch-request-fields"},"children":["common batch-request fields"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resourceURL"]}," is required for visual engines that operate on images."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-7","__idx":65},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/api/v3/intuition/visual/batch-predict' \\\n  --header 'Authorization: Bearer <accessToken>' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '[\n    {\n      \"engineKey\": \"logo-detection\",\n      \"resourceURL\": \"https://example.com/img1.jpg\"\n    },\n    {\n      \"engineKey\": \"logo-detection\",\n      \"resourceURL\": \"https://example.com/img2.jpg\"\n    }\n  ]'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-9","__idx":66},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"HTTP/1.1 200 Success\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The source document specifies a successful HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response but does not provide the response body or response-parameter table."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"10-response-formats","__idx":67},"children":["10. Response formats"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"101-single-result-envelope","__idx":68},"children":["10.1 Single-result envelope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The documented Location Insights and Product Insights single operations use a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," object containing the echoed input and prediction response."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"input\": {},\n    \"response\": []\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"102-batch-result-envelope","__idx":69},"children":["10.2 Batch-result envelope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The documented Text and Location Insights batch operations return a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," array."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"input\": {},\n      \"response\": {}\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The exact shape of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response"]}," is engine-specific. Text prediction uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["classDetails"]},"; Location Insights uses phrase-detail objects; Product Insights uses category, brand, and sentiment objects."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"11-http-status-codes","__idx":70},"children":["11. HTTP status codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following codes are explicitly documented for the APIs that include status-code tables."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP code"},"children":["HTTP code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scenario"},"children":["Scenario"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the documented prediction result or result array."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text Predict source example"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request succeeds without a response body."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Null body or list element, validation failure, or invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]},", depending on the operation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500 Internal Server Error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal classification or downstream-service failure."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The source does not provide an error payload schema. Do not add one without confirming it against the service contract or OpenAPI specification."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"12-behavior-and-implementation-notes","__idx":71},"children":["12. Behavior and implementation notes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use a supported ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]}," for the prediction task."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Supply ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text"]}," for text-based engines."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Supply a publicly accessible ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resourceURL"]}," for URL-based visual engines."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Batch payloads must be arrays of request objects."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For Batch Text Predict, each array element is validated independently, and a null element returns HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Batch Text Predict results are correlated with inputs through server-assigned internal IDs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confidence"]}," values documented in Text and Location Insights responses range from 0 to 1."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Character offsets are represented by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]}," in phrase-level results."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Product categories may include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l1"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l2"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l3"]}," hierarchy fields."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"13-use-cases","__idx":72},"children":["13. Use cases"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"131-classify-sentiment-or-topics-in-text","__idx":73},"children":["13.1 Classify sentiment or topics in text"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Text Predict for one input or Batch Text Predict for multiple inputs. Select an engine such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentiment-en"]}," or another available text-classification engine."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"132-extract-location-level-insights","__idx":74},"children":["13.2 Extract location-level insights"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Location Insights to identify location-related categories, subjects, sentiments, phrases, positions, and confidence values."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"133-extract-product-and-brand-insights","__idx":75},"children":["13.3 Extract product and brand insights"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Product Insights to identify product categories, category hierarchy, brands, and sentiment from customer text."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"134-detect-customer-intent","__idx":76},"children":["13.4 Detect customer intent"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Intent Predict to classify the purpose of a customer statement, such as cancellation or billing-information requests."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"135-detect-visual-entities","__idx":77},"children":["13.5 Detect visual entities"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Visual Predict with a publicly accessible image URL and an available visual engine such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["logo-detection"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"136-process-multiple-inputs","__idx":78},"children":["13.6 Process multiple inputs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the corresponding batch endpoint when you need to submit multiple text or image inputs in one request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"14-publishing-checklist","__idx":79},"children":["14. Publishing checklist"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm that every ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engineKey"]}," used in an example is available in the target environment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}," behavior documented for Text Predict against the service contract."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add missing response bodies and response schemas for Product Insights Batch, Intent, and Visual APIs only after validating them against the OpenAPI specification or an observed production-safe response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm whether the production base URL requires an environment segment for the target deployment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keep access tokens and other credentials out of published examples."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replace example resource URLs with safe, publicly accessible samples where needed."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Validate all cURL examples before publication."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["All payloads in this guide are illustrative. Credentials and identifiers are placeholders and must not be committed or logged."]}]}]},"headings":[{"value":"Intuition APIs V3 — Developer Guide","id":"intuition-apis-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"1.1 Supported operations","id":"11-supported-operations","depth":3},{"value":"1.2 Single and batch request model","id":"12-single-and-batch-request-model","depth":3},{"value":"2. Base URL","id":"2-base-url","depth":2},{"value":"3. Authentication and common headers","id":"3-authentication-and-common-headers","depth":2},{"value":"4. Common request model","id":"4-common-request-model","depth":2},{"value":"4.1 Single-request fields","id":"41-single-request-fields","depth":3},{"value":"4.2 Batch-request fields","id":"42-batch-request-fields","depth":3},{"value":"5. Text Prediction APIs","id":"5-text-prediction-apis","depth":2},{"value":"5.1 Predict text","id":"51-predict-text","depth":3},{"value":"Request body","id":"request-body","depth":4},{"value":"Example request","id":"example-request","depth":4},{"value":"Example response","id":"example-response","depth":4},{"value":"5.2 Batch predict text","id":"52-batch-predict-text","depth":3},{"value":"Request body","id":"request-body-1","depth":4},{"value":"Example request: batch sentiment prediction","id":"example-request-batch-sentiment-prediction","depth":4},{"value":"Example request: mixed engine keys","id":"example-request-mixed-engine-keys","depth":4},{"value":"Response parameters","id":"response-parameters","depth":4},{"value":"Example response","id":"example-response-1","depth":4},{"value":"HTTP status codes","id":"http-status-codes","depth":4},{"value":"Behavior notes","id":"behavior-notes","depth":4},{"value":"6. Location Insights APIs","id":"6-location-insights-apis","depth":2},{"value":"6.1 Predict location insights","id":"61-predict-location-insights","depth":3},{"value":"Path parameters","id":"path-parameters","depth":4},{"value":"Query parameters","id":"query-parameters","depth":4},{"value":"Request body","id":"request-body-2","depth":4},{"value":"Example request: minimal","id":"example-request-minimal","depth":4},{"value":"Example request: language specified","id":"example-request-language-specified","depth":4},{"value":"Response parameters","id":"response-parameters-1","depth":4},{"value":"Example response","id":"example-response-2","depth":4},{"value":"HTTP status codes","id":"http-status-codes-1","depth":4},{"value":"6.2 Batch predict location insights","id":"62-batch-predict-location-insights","depth":3},{"value":"Request body","id":"request-body-3","depth":4},{"value":"Example request","id":"example-request-1","depth":4},{"value":"Response parameters","id":"response-parameters-2","depth":4},{"value":"Example response","id":"example-response-3","depth":4},{"value":"HTTP status codes","id":"http-status-codes-2","depth":4},{"value":"7. Product Insights APIs","id":"7-product-insights-apis","depth":2},{"value":"7.1 Predict product insights","id":"71-predict-product-insights","depth":3},{"value":"Request body","id":"request-body-4","depth":4},{"value":"Example request","id":"example-request-2","depth":4},{"value":"Response parameters","id":"response-parameters-3","depth":4},{"value":"Example response","id":"example-response-4","depth":4},{"value":"HTTP status codes","id":"http-status-codes-3","depth":4},{"value":"7.2 Batch predict product insights","id":"72-batch-predict-product-insights","depth":3},{"value":"Request body","id":"request-body-5","depth":4},{"value":"Example request","id":"example-request-3","depth":4},{"value":"Example response","id":"example-response-5","depth":4},{"value":"8. Intent Prediction APIs","id":"8-intent-prediction-apis","depth":2},{"value":"8.1 Predict intent","id":"81-predict-intent","depth":3},{"value":"Request body","id":"request-body-6","depth":4},{"value":"Example request","id":"example-request-4","depth":4},{"value":"Example response","id":"example-response-6","depth":4},{"value":"8.2 Batch predict intent","id":"82-batch-predict-intent","depth":3},{"value":"Request body","id":"request-body-7","depth":4},{"value":"Example request","id":"example-request-5","depth":4},{"value":"Example response","id":"example-response-7","depth":4},{"value":"9. Visual Prediction APIs","id":"9-visual-prediction-apis","depth":2},{"value":"9.1 Predict visual content","id":"91-predict-visual-content","depth":3},{"value":"Request body","id":"request-body-8","depth":4},{"value":"Example request","id":"example-request-6","depth":4},{"value":"Example response","id":"example-response-8","depth":4},{"value":"9.2 Batch predict visual content","id":"92-batch-predict-visual-content","depth":3},{"value":"Request body","id":"request-body-9","depth":4},{"value":"Example request","id":"example-request-7","depth":4},{"value":"Example response","id":"example-response-9","depth":4},{"value":"10. Response formats","id":"10-response-formats","depth":2},{"value":"10.1 Single-result envelope","id":"101-single-result-envelope","depth":3},{"value":"10.2 Batch-result envelope","id":"102-batch-result-envelope","depth":3},{"value":"11. HTTP status codes","id":"11-http-status-codes","depth":2},{"value":"12. Behavior and implementation notes","id":"12-behavior-and-implementation-notes","depth":2},{"value":"13. Use cases","id":"13-use-cases","depth":2},{"value":"13.1 Classify sentiment or topics in text","id":"131-classify-sentiment-or-topics-in-text","depth":3},{"value":"13.2 Extract location-level insights","id":"132-extract-location-level-insights","depth":3},{"value":"13.3 Extract product and brand insights","id":"133-extract-product-and-brand-insights","depth":3},{"value":"13.4 Detect customer intent","id":"134-detect-customer-intent","depth":3},{"value":"13.5 Detect visual entities","id":"135-detect-visual-entities","depth":3},{"value":"13.6 Process multiple inputs","id":"136-process-multiple-inputs","depth":3},{"value":"14. Publishing checklist","id":"14-publishing-checklist","depth":2}],"frontmatter":{"seo":{"title":"Intuition APIs V3 — Developer Guide"}},"lastModified":"2026-10-22T18:13:07.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/intuition-apis-v3","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}