Talk Analytics API, REST: Assistants.List
Rpc for listing assistants in a project
HTTP request
POST https://rest-api.speechsense.yandexcloud.net/speechsense/v1/assistants/list
Body parameters
{
"projectId": "string"
}
|
Field |
Description |
|
projectId |
string Project id |
Response
HTTP Code: 200 - OK
{
"assistants": [
{
"id": "string",
"projectId": "string",
"modelId": "string",
"name": "string",
"description": "string",
"prompt": "string",
"fields": [
{
"id": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"enabled": "boolean",
"labels": "object",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"modifiedBy": "string"
}
]
}
|
Field |
Description |
|
assistants[] |
Assistants belonging to the given project |
Assistant
|
Field |
Description |
|
id |
string Assistant id |
|
projectId |
string Project id |
|
modelId |
string Model id |
|
name |
string Assistant name |
|
description |
string Assistant description |
|
prompt |
string Prompt |
|
fields[] |
Fields that will be set after assistant processing |
|
enabled |
boolean |
|
labels |
object (map<string, string>) Billing labels |
|
createdAt |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
createdBy |
string Subject id |
|
modifiedAt |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
modifiedBy |
string Subject id |
AssistantField
|
Field |
Description |
|
id |
string Field id |
|
name |
string Field name |
|
description |
string Field description |
|
type |
enum (AssistantFieldType) Field type
|