Guided Help

Start a Guided Help Search

POST
/knowledge/portalmgr/v4/portals/{portalID}/gh/search

Overview

The Start a Guided Help search can be used to start a search session in the Guided Help.

A Guided Help profile can also be specified while starting the session and it is used to filter the results of search. If this is not passed in the request, the default profile of the portal is used. Questions can also be answered at time of starting the search session.

A Guided Help search session can be started in following ways:

  • Launch session for a specific Casebase Release.
  • Launch session for a Casebase and specify the release type.
  • Use a Guided Help session Article and pass the required session parameters.

Prerequisites

  • A Guided Help profile must be assigned to the user.
  • Casebase Release passed in the request must be associated with the portal passed in URI.

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Path Parameters

portalID*string

The ID of the portal being accessed.A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20

Query Parameters

$lang?string

The language that describes the details of a resource. Resources available in different languages may differ from each other.If lang is not passed, then the portal's default language is used.

Value in

  • "en-US"
  • "fr-FR"
  • "en-GB"
  • "es-ES"
  • "it-IT"
  • "nl-NL"
  • "da-DA"
  • "sv-SE"
  • "pt-PT"
  • "fi-FI"
  • "no-NB"
  • "no-NN"
  • "ja-JA"
  • "de-DE"
  • "pt-BR"
  • "zh-CN"
  • "zh-TW"
  • "ko-KO"
  • "ru-RU"
  • "el-EL"
  • "tr-TR"
  • "pl-PL"
  • "cs-CS"
  • "sk-SK"
  • "hu-HU"
  • "sr-SR"
  • "ar-SA"
  • "hr-HR"
  • "ro-RO"
  • "th-TH"
  • "de-AT"
  • "vi-VN"
  • "id-ID"
  • "ms-MY"
  • "fil-PH"
  • "fr-CA"
  • "hi-IN"
  • "uk-UA"
  • "bg-BG"
  • "sl-SI"
  • "xx-XX"
ghCustomAdditionalAttributes?string

Custom attributes to be fetched.

Possible values are:

  • question.custom.<name> where <name> is the internal name of custom attribute of question. 'question' is used as a prefix to distinguish question's custom attribute from other objects custom attributes.
Match^question\.custom\.[^,]+(?:,question\.custom\.[^,]+)*$
Length1 <= length <= 4000

Header Parameters

x-egain-activity-id?string

A unique numeric interaction identifier from eGain.

Match^[0-9]{4,9}$
Length4 <= length <= 9
x-ext-integration-id?string

The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

Match^[\w\W]+$
Lengthlength <= 40
x-ext-interaction-id?string

A unique interaction identifier from other CRM applications.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

Match^[\w\W]+$
Lengthlength <= 40
Accept-Language*string

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Value in

  • "en-US"
  • "es-ES"
  • "fr-FR"
  • "it-IT"
  • "de-DE"
  • "nl-NL"
  • "pt-BR"
  • "pt-PT"
  • "da-DK"
  • "ru-RU"
  • "fr-CA"
  • "zh-CN"
  • "ja-JP"
  • "ko-KR"
  • "sv-SE"
Content-Type*"application/json"

The media type sent by the client.

Default"application/json"

Value in

  • "application/json"

Request Body

application/json

casebaseId*CasebaseId

The numerical ID of the Casebase.

Match^[1-9]\d*$
Length15 <= length <= 15
questions?array<>

Pre-answered Questions in Guided Help search

Itemsitems <= 500
profileId?string

The ID of the guided help profile. 1 will always be the system profile.

Match^1$|^[1-9]\d{9,15}$
Length1 <= length <= 15
sessionVariable?array<>

Session variables used to give Guided Help additional context.

startOver?boolean

Restart the current Guided Help search with the existing context along with session variable context.

useLiveRelease?boolean

Use current live release snapshot of the Casebase otherwise use the authoring release.

ghsArticleId?string

Numeric ID of the guided help session article used for starting search.

Match^[1-9]\d*$
Length15 <= length <= 15

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/gh/search?ghCustomAdditionalAttributes=question.custom.score" \  -H "x-egain-activity-id: 59237" \  -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \  -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \  -H "Accept-Language: en-US" \  -H "Content-Type: application/json" \  -H "Content-Type: application/json" \  -d '{    "casebaseId": "202201000000002"  }'
{  "casebase": {    "name": "Financial Vertical Bot",    "status": "author",    "casebaseId": "202201000000002",    "profiles": [      {        "profile": [          {            "name": "system profile",            "id": "100100000000001"          }        ]      }    ],    "id": "202201000000002",    "searchSettings": {      "closeSessionOnAccept": true,      "closeSessionOnReject": true    }  },  "actionSearch": [],  "answeredQuestion": [],  "caseSearch": [],  "dynamicSearch": [],  "unansweredQuestion": [    {      "title": "[ML]Label Confidence",      "type": "enumerated",      "format": "dropdown",      "shortName": "ML1",      "hasAdditionalInfo": true,      "hasAction": true,      "validAnswer": [        {          "depth": 1,          "isInvisible": false,          "text": "HIGH",          "id": "1000000303"        },        {          "depth": 1,          "isInvisible": false,          "text": "MEDIUM",          "id": "1000000304"        },        {          "depth": 1,          "isInvisible": false,          "text": "LOW",          "id": "1000000305"        },        {          "depth": 1,          "isInvisible": false,          "text": "NA",          "id": "1000000306"        }      ],      "metadata": [        {          "title": "",          "additionalInformation": "",          "action": ""        }      ],      "customAttribute": [],      "id": "1000000322"    },    {      "title": "[ML]Label",      "type": "enumerated",      "format": "dropdown",      "shortName": "Classifier",      "hasAdditionalInfo": true,      "hasAction": true,      "validAnswer": [        {          "depth": 1,          "isInvisible": false,          "text": "None",          "id": "1000000272"        },        {          "depth": 1,          "isInvisible": false,          "text": "Membership",          "id": "1000000842"        },        {          "depth": 1,          "isInvisible": false,          "text": "Online Banking",          "id": "1000000843"        },        {          "depth": 1,          "isInvisible": false,          "text": "Checking and Savings",          "id": "1000000844"        },        {          "depth": 1,          "isInvisible": false,          "text": "Debit Card",          "id": "1000000845"        },        {          "depth": 1,          "isInvisible": false,          "text": "Credit Card",          "id": "1000000846"        },        {          "depth": 1,          "isInvisible": false,          "text": "Loans",          "id": "1000000847"        },        {          "depth": 1,          "isInvisible": false,          "text": "Something Else",          "id": "1000000848"        },        {          "depth": 1,          "isInvisible": false,          "text": "Chat with an Agent",          "id": "1000002048"        }      ],      "metadata": [        {          "title": "",          "additionalInformation": "",          "action": ""        }      ],      "customAttribute": [],      "id": "1000000327"    }  ],  "startupQuestion": [    {      "title": "[ML]Label Confidence",      "type": "enumerated",      "format": "dropdown",      "shortName": "ML1",      "hasAdditionalInfo": true,      "hasAction": true,      "validAnswer": [        {          "depth": 1,          "isInvisible": false,          "text": "HIGH",          "id": "1000000303"        },        {          "depth": 1,          "isInvisible": false,          "text": "MEDIUM",          "id": "1000000304"        },        {          "depth": 1,          "isInvisible": false,          "text": "LOW",          "id": "1000000305"        },        {          "depth": 1,          "isInvisible": false,          "text": "NA",          "id": "1000000306"        }      ],      "metadata": [        {          "title": "",          "additionalInformation": "",          "action": ""        }      ],      "customAttribute": [],      "id": "1000000322"    },    {      "title": "[ML]Label",      "type": "enumerated",      "format": "dropdown",      "shortName": "Classifier",      "hasAdditionalInfo": true,      "hasAction": true,      "validAnswer": [        {          "depth": 1,          "isInvisible": false,          "text": "None",          "id": "1000000272"        },        {          "depth": 1,          "isInvisible": false,          "text": "Membership",          "id": "1000000842"        },        {          "depth": 1,          "isInvisible": false,          "text": "Online Banking",          "id": "1000000843"        },        {          "depth": 1,          "isInvisible": false,          "text": "Checking and Savings",          "id": "1000000844"        },        {          "depth": 1,          "isInvisible": false,          "text": "Debit Card",          "id": "1000000845"        },        {          "depth": 1,          "isInvisible": false,          "text": "Credit Card",          "id": "1000000846"        },        {          "depth": 1,          "isInvisible": false,          "text": "Loans",          "id": "1000000847"        },        {          "depth": 1,          "isInvisible": false,          "text": "Something Else",          "id": "1000000848"        },        {          "depth": 1,          "isInvisible": false,          "text": "Chat with an Agent",          "id": "1000002048"        }      ],      "metadata": [        {          "title": "",          "additionalInformation": "",          "action": ""        }      ],      "customAttribute": [],      "id": "1000000327"    }  ],  "targetClusters": [    {      "id": "1000000258"    }  ]}