Page Comparison

{
	"description": "Information about a specific session (conversation) with an agent.  Only the acess level can be changed on an existing session.  You will need to start a new session if you wish to use a different agentId.",
	"properties": {
		"agentAccessLevel": {
			"description": "Required. Specifies the access level that the agent will have during this session only.",
			"$ref": "org.sagebionetworks.repo.model.agent.AgentAccessLevel"
		},
		"agentRegistrationId": {
			"type": "string",
			"description": "Optional. When provided, the registered agent will be used for this session.  When excluded the default 'baseline' agent will be used."
		}
	}
}

{
	"description": "Defines the level of data access that the agent will be given during a session.",
	"name": "AgentAccessLevel",
	"type": "string",
	"enum": [
		{
			"name": "PUBLICLY_ACCESSIBLE",
			"description": "The agent will only have access to ALL data that is already publicly available to anyone."
		},
		{
			"name": "READ_YOUR_PRIVATE_DATA",
			"description": "The agent will have access to ALL data in Synapse that you have 'read' access to.  The agent will also have access to ALL data that is publicly available."
		},
		{
			"name": "WRITE_YOUR_PRIVATE_DATA",
			"description": "Grant the agent permission to make data changes within Synapse on your behalf. Any change the agent makes will be attributed to you.  Under this level the Agent will also have access to ALL data in Synapse that you have 'read' access to.  The agent will also have access to ALL data that is publicly available."
		}
	]
}

{
	"description": "Information about a specific session (conversation) with an agent.  Only the acess level can be changed on an existing session.  You will need to start a new session if you wish to use a different agentId.",
	"properties": {
		"sessionId": {
			"type": "string",
			"description": "The unique identifier for a conversation with an agent.  The sessionId issued by Synapse when the session is started.  The caller must provided this sessionId with each chat request to identify a specific conversation with an agent.  A sessionId can only be used by the user that created it."
		},
		"agentAccessLevel": {
			"description": "Specifies the access level that the agent will have during this session only.",
			"$ref": "org.sagebionetworks.repo.model.agent.AgentAccessLevel"
		},
		"startedOn": {
			"type": "string",
			"format": "date-time",
			"description": "The date this session was started."
		},
		"startedBy": {
			"type": "integer",
			"description": "The id of the user that started this session"
		},
		"modifiedOn": {
			"type": "string",
			"format": "date-time",
			"description": "The date this session was last modified."
		},
		"agentRegistrationId": {
			"type": "string",
			"description": "Identifies that agent that will be used for this session.  The default value is null, which indicates that the default agent will be used."
		},
		"etag": {
			"type": "string",
			"description": "Will change whenever the session changes."
		}
	}
}

{
	"description": "Request a single page agent sessions for the current user.  The session are ordered by 'startedOn' descending.",
	"properties": {
		"nextPageToken": {
			"type": "string",
			"description": "Forward the returned 'nextPageToken' to get the next page of results."
		}
	}
}

{
	"description": "A single page of agent sessions",
	"properties": {
		"page": {
			"type": "array",
			"items": {
				"$ref": "org.sagebionetworks.repo.model.agent.AgentSession"
			}
		},
		"nextPageToken": {
			"type": "string",
			"description": "InformationForward aboutthis atoken specificto sessionget (conversation)the withnext anpage agent.  Each session is immutable.  You will need to start a new session if you wish to use a different access level or agentId."of results."
		}
	}
}

{
	"description": "Send a chat message to the Synapse chat agent",
	"implements": [
		{
			"$ref": "org.sagebionetworks.repo.model.asynch.AsynchronousRequestBody"
		}
	],
	"properties": {
		"agentAccessLevelsessionId": {
			"description": "Required. Specifies the access level "The sessionId that identifies the agentconversation willwith have during this session onlythe agent.",
			"$reftype": "org.sagebionetworks.repo.model.agent.AgentAccessLevelstring"
		},
		"agentIdchatText": {
			"description": "The user's text message to send to the agent.",
			"type": "string"
		},
		"enableTrace": {
			"description": "Optional. Most usersWhen trace is enabled, the agent will notinclude useinformation thisabout parameter.its decision Ifprocess youand arethe authorizedfunctions/tools toit testwill experimentaluse agents,to provideprocess thethis IDrequest. ofDefault the agentvalue you wish to test.is false.",
			"type": "boolean"
		}
	}
}

 {
	"description": "Request a single page of a session's history.  The history is ordered by the interaction time stamp descending.",
	"properties": {
		"nextPageToken": {
			"type": "string",
			"description": "Forward the returned 'nextPageToken' to get the next page of results."
		}
	]}
}

{
	"description": "org.sagebionetworks.repo.model.agent.AgentAccessLevel"
		}Represents a single interaction between the user and an agent.",
		"startedOnproperties": {
			"typeusersRequestText": "string",{
			"formattype": "date-timestring",
			"description": "The datetext thisof sessionthe was started.user's request"
		},
		"agentIdusersRequestTimestamp": {
			"type": "string",
			"descriptionformat": "Identifies that agent that will be used for this session.  The default value is null, which indicates that the default agent will be used."date-time",
			"description": "The time stamp when the user made the request"
		},
	}
}

{
			"description": "The sessionId that identifies the conversation with the agent.",
			"type": "string"
		},
		"chatTextA single page of an agent trace events for an asynchronous agent chat job. The events are sorted by timestamp ascending.",
	"properties": {
			"descriptionjobId": "The user's text message to send to the agent.",
{
			"type": "string",
		}
	}
}

{
			"description": "The agent's text response to the user's request",
			Represents a single trace event generated during an agent chat asynchronous job request.",
	"properties": {
		"timestamp": {
			"type": "stringinteger",
		}
	}
}

{
	"description": "ForwardThe thisregistration tokenof toa getcustom the next page of results."
		}
	}
}