Vorsto Docs
  • Get Started
  • Getting Started
    • Create Agent
    • Configure Agent
    • Functions
    • Parameters
  • API
    • Authentication
    • Request
    • Object Response
    • Text Response
    • API Web Hook
    • IP Whitelisting
  • 3rd Party Models
    • GPT
    • Gemini
Powered by GitBook
On this page

Was this helpful?

  1. API

Object Response

PreviousRequestNextText Response

Last updated 7 months ago

Was this helpful?

The Object response is a configurable JSON response for your agent. This ensures a predictable response format from your agent.

Functions are not available on Object Responses as they are returned on every api call.

You can configure your object response parameters on your agent configuration form as seen below.

Each parameter data type can be String, Number or Boolean. A parameter name and parameter description is required. For example, an agent meant to classify movies in genre would have a configuration like so:

Name: Class Description: The genre of the movie Type: String

Below is a sample response from a diagnosis fraud analysis agent

{
    "message": {
        "id": "duH7f5mOItDIlpYRbMPDE",
        "role": "assistant",
        "content": {
            "fraud": false,
            "comment": "The diagnosis of Pediculus Capitis (head lice) is a valid medical condition. The details provided do not indicate any fraudulent activity."
        }
    }
}

The parameters from the above response are fraud (string) and comment (string).

Object responses do not allow functions and hence non-long running. Agent responses are returned on every requests. Your configured parameters are returned as the "content" response object.