...
| Code Block |
|---|
|
{
"description": "Information about a specific session (conversation) with an agent. Each session is immutableOnly 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 access level or 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": "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"
},
"startedOnmodifiedOn": {
"type": "string",
"format": "date-time",
"description": "The date this session was last startedmodified."
},
"agentIdagentRegistrationId": {
"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."
}
}
} |
ListAgentSessionsRequest:
...
| Code Block |
|---|
|
{
"description": "Represents a single trace event generated during an agent chat asynchronous job request.",
"properties": {
"timestamp": {
"type": "integer",
"description": "The time stamp identifies when the agent generated this trace event. It is also used to uniquely identify this event within the context of this asynchronous job."
},
"message": {
"type": "string",
"description": "The trace text message generated by the agent while processing a chat request."
}
}
} |
RegisterAgentRequestAgentRegistrationRequest.json
| Code Block |
|---|
|
{
"description": "Request to register a custom AWS agent with Synapse. Currently, only internal users are authorized to register custom agents.",
"properties": {
"awsAgentId": {
"type": "string",
"description": "The AWS issued agent ID of the agent to be registered."
},
"awsAliasId": {
"type": "string",
"description": "The AWS issued agent alias ID of the agent alias to be used. Optional. If an alias is not provided then 'TSTALIASID' will be used."
}
}
} |
...
