Talk Analytics API, gRPC: TalkService.Search
rpc for searching talks. will return ids only
gRPC request
rpc Search (SearchTalkRequest) returns (SearchTalkResponse)
SearchTalkRequest
{
"organization_id": "string",
"space_id": "string",
"connection_id": "string",
"project_id": "string",
"filters": [
{
"key": "string",
// Includes only one of the fields `any_match`, `int_range`, `double_range`, `date_range`, `duration_range`, `boolean_match`
"any_match": {
"values": [
"string"
]
},
"int_range": {
"from_value": "google.protobuf.Int64Value",
"to_value": "google.protobuf.Int64Value",
"bounds_inclusive": {
"from_inclusive": "bool",
"to_inclusive": "bool"
}
},
"double_range": {
"from_value": "google.protobuf.DoubleValue",
"to_value": "google.protobuf.DoubleValue",
"bounds_inclusive": {
"from_inclusive": "bool",
"to_inclusive": "bool"
}
},
"date_range": {
"from_value": "google.protobuf.Timestamp",
"to_value": "google.protobuf.Timestamp",
"bounds_inclusive": {
"from_inclusive": "bool",
"to_inclusive": "bool"
}
},
"duration_range": {
"from_value": "google.protobuf.Duration",
"to_value": "google.protobuf.Duration",
"bounds_inclusive": {
"from_inclusive": "bool",
"to_inclusive": "bool"
}
},
"boolean_match": {
"value": "bool"
},
// end of the list of possible fields
"inverse": "bool",
"channel_number": "google.protobuf.Int64Value"
}
],
"query": {
"text": "string",
"inverse": "bool",
"channel_number": "google.protobuf.Int64Value"
},
"page_size": "int64",
"page_token": "string",
"sort_data": {
"fields": [
{
"field": "string",
"order": "SortOrder",
"position": "int64"
}
]
}
}
|
Field |
Description |
|
organization_id |
string id of organization |
|
space_id |
string id of space |
|
connection_id |
string id of connection |
|
project_id |
string id of project |
|
filters[] |
metadata keys filters (user and system) |
|
query |
Full-text search query |
|
page_size |
int64 page size, from 1 to 1000, default 100 |
|
page_token |
string next page token, if page is not first |
|
sort_data |
talks sorting options |
Filter
|
Field |
Description |
|
key |
string metadata key (user.some_key / system.created_at / analysis.speechkit.duration) |
|
any_match |
find talk matched by any text filters Includes only one of the fields |
|
int_range |
find talks with value from int range Includes only one of the fields |
|
double_range |
find talks with value from double range Includes only one of the fields |
|
date_range |
find talks with value from date range Includes only one of the fields |
|
duration_range |
find talks with value from duration range Includes only one of the fields |
|
boolean_match |
find talks with value equals boolean Includes only one of the fields |
|
inverse |
bool |
|
channel_number |
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 |
|
from_value |
|
|
to_value |
|
|
bounds_inclusive |
BoundsInclusive
indicates whether to include range boundaries
|
Field |
Description |
|
from_inclusive |
bool include from bound |
|
to_inclusive |
bool include to bound |
DoubleRangeFilter
|
Field |
Description |
|
from_value |
|
|
to_value |
|
|
bounds_inclusive |
DateRangeFilter
|
Field |
Description |
|
from_value |
|
|
to_value |
|
|
bounds_inclusive |
DurationRangeFilter
|
Field |
Description |
|
from_value |
|
|
to_value |
|
|
bounds_inclusive |
BooleanFilter
|
Field |
Description |
|
value |
bool |
Query
|
Field |
Description |
|
text |
string |
|
inverse |
bool should or should NOT match |
|
channel_number |
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 |
int64 number of field in comparing order (sort by key1 (position = 0), then key2 (position = 1), then key3...) |
SearchTalkResponse
{
"talk_ids": [
"string"
],
"talks_count": "int64",
"next_page_token": "string"
}
|
Field |
Description |
|
talk_ids[] |
string page results entries |
|
talks_count |
int64 total documents matched |
|
next_page_token |
string page token for next request |