agent

Interface to agent SSE. Replaces the previous Assistant module.
Description:
  • Interface to agent SSE. Replaces the previous Assistant module.
Source:
Returns:
Type
object

Methods

(inner) getAgentResultsStream(intent, parametersopt) → {ReadableStream}

Description:
  • Retrieve a stream of agent results from Constructor.io API
Source:
Example
const readableStream = constructorio.agent.getAgentResultsStream('I want to get shoes', {
    domain: "nike_sportswear",
});
const reader = readableStream.getReader();
const { value, done } = await reader.read();
Parameters:
Name Type Attributes Description
intent string Intent to use to perform an intent based recommendations
parameters object <optional>
 Additional parameters to refine result set
Properties
Name Type Attributes Description
domain string <optional>
 domain name e.g. swimming sports gear, groceries
numResultsPerPage number <optional>
 The total number of results to return
Returns:
Returns a ReadableStream.
Type
ReadableStream