Get the generation details - HoopAI Help Center

{ "prompt": "Personality:\nFriendly and professional,\n\nIntent:\nAssist customers with inquiries\n\nAdditional Information:\nHandle basic support queries", "responseMessage": "Hello! I understand you're interested in our products. How can I assist you today?", "actionLogs": [ { "contactUpdateAction": [ { "fieldId": "field_123", "value": "John Doe" } ] } ], "history": [ { "role": "user", "content": "Hi, I have a question about returns" }, { "role": "assistant", "content": "I'll be happy to help you with information about our return policy." } ], "intent": "Assist customers with product inquiries and support", "faqs": [ { "id": "chunk_123", "content": "Our return policy allows returns within 30 days of purchase.", "title": "Return Policy FAQ" } ], "website": [ { "id": "chunk_456", "content": "We offer free shipping on orders over $50.", "url": "https://example.com/shipping" } ], "agentId": "emp_123", "input": "What is your return policy?", "mode": "auto-pilot" }

Authorizations

Authorization

string

header

required

Access Token or Private Integration Token

Headers

Version

enum<string>

required

API Version

Available options:

2021-04-15

Query Parameters

messageId

string

required

Message Id

Example:

"messageId123"

source

enum<string>

required

Available options:

conversation,

workflow

Example:

"conversation"

Response

Successful response

prompt

string

required

The complete prompt used for the AI response.

Example:

"Personality:\nFriendly and professional,\n\nIntent:\nAssist customers with inquiries\n\nAdditional Information:\nHandle basic support queries"

responseMessage

string

required

The response message generated by the AI.

Example:

"Hello! I understand you're interested in our products. How can I assist you today?"

actionLogs

array

required

List of actions taken during this interaction.

Example:

[
  {
    "contactUpdateAction": [
      {
        "fieldId": "field_123",
        "value": "John Doe"
      }
    ]
  }
]

history

array

required

Conversation history leading up to this response.

Example:

[
  {
    "role": "user",
    "content": "Hi, I have a question about returns"
  },
  {
    "role": "assistant",
    "content": "I'll be happy to help you with information about our return policy."
  }
]

intent

string

The intent/goal extracted from location prompt.

Example:

"Assist customers with product inquiries and support"

faqs

array

FAQ chunks used in generating the response from fine-tuned data.

Example:

[
  {
    "id": "chunk_123",
    "content": "Our return policy allows returns within 30 days of purchase.",
    "title": "Return Policy FAQ"
  }
]

website

array

Website content chunks used in generating the response.

Example:

[
  {
    "id": "chunk_456",
    "content": "We offer free shipping on orders over $50.",
    "url": "https://example.com/shipping"
  }
]

agentId

string

ID of the employee/agent that generated the response.

Example:

"emp_123"

input

string

The original input message that triggered this response.

Example:

"What is your return policy?"

mode

string

Mode of operation during this interaction.

Example:

"auto-pilot"