Talk Analytics API, REST: Talk.Search
rpc for searching talks. will return ids only
HTTP request
POST https://rest-api.speechsense.yandexcloud.net/speechsense/v1/talks/search
Body parameters
{
"organizationId": "string",
"spaceId": "string",
"connectionId": "string",
"projectId": "string",
"filters": [
{
"key": "string",
// Includes only one of the fields `anyMatch`, `intRange`, `doubleRange`, `dateRange`, `durationRange`, `booleanMatch`
"anyMatch": {
"values": [
"string"
]
},
"intRange": {
"fromValue": "string",
"toValue": "string",
"boundsInclusive": {
"fromInclusive": "boolean",
"toInclusive": "boolean"
}
},
"doubleRange": {
"fromValue": "number",
"toValue": "number",
"boundsInclusive": {
"fromInclusive": "boolean",
"toInclusive": "boolean"
}
},
"dateRange": {
"fromValue": "string",
"toValue": "string",
"boundsInclusive": {
"fromInclusive": "boolean",
"toInclusive": "boolean"
}
},
"durationRange": {
"fromValue": "string",
"toValue": "string",
"boundsInclusive": {
"fromInclusive": "boolean",
"toInclusive": "boolean"
}
},
"booleanMatch": {
"value": "boolean"
},
// end of the list of possible fields
"inverse": "boolean",
"channelNumber": "string"
}
],
"query": {
"text": "string",
"inverse": "boolean",
"channelNumber": "string"
},
"pageSize": "string",
"pageToken": "string",
"sortData": {
"fields": [
{
"field": "string",
"order": "string",
"position": "string"
}
]
}
}
|
Field |
Description |
|
organizationId |
string id of organization |
|
spaceId |
string id of space |
|
connectionId |
string id of connection |
|
projectId |
string id of project |
|
filters[] |
metadata keys filters (user and system) |
|
query |
Full-text search query |
|
pageSize |
string (int64) page size, from 1 to 1000, default 100 |
|
pageToken |
string next page token, if page is not first |
|
sortData |
talks sorting options |
Filter
|
Field |
Description |
|
key |
string metadata key (user.some_key / system.created_at / analysis.speechkit.duration) |
|
anyMatch |
find talk matched by any text filters Includes only one of the fields |
|
intRange |
find talks with value from int range Includes only one of the fields |
|
doubleRange |
find talks with value from double range Includes only one of the fields |
|
dateRange |
find talks with value from date range Includes only one of the fields |
|
durationRange |
find talks with value from duration range Includes only one of the fields |
|
booleanMatch |
find talks with value equals boolean Includes only one of the fields |
|
inverse |
boolean |
|
channelNumber |
string (int64) channel number to apply filter for, starting with 0. applies to all channels if not specified |
AnyMatchFilter
|
Field |
Description |
|
values[] |
string values list to match with "OR" operator |
IntRangeFilter
|
Field |
Description |
|
fromValue |
string (int64) |
|
toValue |
string (int64) |
|
boundsInclusive |
BoundsInclusive
indicates whether to include range boundaries
|
Field |
Description |
|
fromInclusive |
boolean include from bound |
|
toInclusive |
boolean include to bound |
DoubleRangeFilter
|
Field |
Description |
|
fromValue |
number (double) |
|
toValue |
number (double) |
|
boundsInclusive |
DateRangeFilter
|
Field |
Description |
|
fromValue |
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 |
|
toValue |
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 |
|
boundsInclusive |
DurationRangeFilter
|
Field |
Description |
|
fromValue |
string (duration) |
|
toValue |
string (duration) |
|
boundsInclusive |
BooleanFilter
|
Field |
Description |
|
value |
boolean |
Query
|
Field |
Description |
|
text |
string |
|
inverse |
boolean should or should NOT match |
|
channelNumber |
string (int64) id of channel to search ("1", "2", ..., any channel if not set) |
SortData
|
Field |
Description |
|
fields[] |
SortField
|
Field |
Description |
|
field |
string sorting key |
|
order |
enum (SortOrder) sorting order by current
|
|
position |
string (int64) number of field in comparing order (sort by key1 (position = 0), then key2 (position = 1), then key3...) |
Response
HTTP Code: 200 - OK
{
"talkIds": [
"string"
],
"talksCount": "string",
"nextPageToken": "string"
}
|
Field |
Description |
|
talkIds[] |
string page results entries |
|
talksCount |
string (int64) total documents matched |
|
nextPageToken |
string page token for next request |