What do the values of the QueryType param mean?

Platform API
1

Hello,

I want to know what mean this values :

AutoSearch, ManualSearch, Suggestion

for this endpoint : POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/search

Sincerely,
Bayahya DIAGANA

2

Hi Bayahya

Here is some info I could find about these query types:

  • The type of the query that initiates search:
    • AutoSearch: search was initiated automatically;
    • ManualSearch: search was initiated by a user;
    • Suggestion: search was initiated by selecting an autocomplete suggestion.

Hope this helps
-Charlie

3

Hi Charlie,

thank you for this response but I want to understand functionally what the difference is? Because with the 3 values I have the same result.

Sincerey,
Bayahya DIAGANA

4

I asked the team that owns this feature for some clarity on this. I'm awaiting their response now. If I discover anything in the meantime, I'll let you know here.

5

Hi Bayahya

Here is some more information provided to me by the knowledge team:

Explanation on that parameter's values: It defines what use-cases the knowledge query was happening.

  • ManualSearch: A user searched manually
  • Suggestion: A user started searching and accepted an autocomplete suggestion
  • AutoSearch: The search was made automatically by GC system to surface results for a user (e.g. Agent Assist
    "automatic suggestions" use-case).
  • Article: The knowledge surfacing happened by directly arriving to an article via link (e.g. to knowledge portal)
  • Recommendation: The knowledge (article) was surfaced based on a recommendation engine (e.g. FAQ in knowledge portal)
  • Category: The knowledge (article) was surfaced by browsing articles through categories (e.g. in knowledge portal)

The parameter is optional, and can be given in to the knowledge surfacing endpoints:

  • Knowledge search
  • Knowledge document viewed
  • Knowledge document copied
  • Knowledge document feedback

The parameter serves 2 purposes at the moment:

  • Main one is for analytics UIs to be able to distinguish presented metrics based on the use-case. E.g.: Agent Assist performance dashboard (not yet released) has a concept of "Manual searches" vs "Automatic searches", where we want to see how well automatic searches perform, and replace the need for manual searches.
  • Some features can use this parameter to filter for the use-cases they need / support. E.g. knowledge optimizer is filtering out the "automatic searches" coming from agent assist with this parameter, as it has too much noise and would degrade the feature there.
1 Like
6

Thank you Charlie, it's clear for me.

1 Like
7

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.