ListAggregatedUtterancesRequest

import type { ListAggregatedUtterancesRequest } from "https://aws-api.deno.dev/v0.4/services/lexmodelsv2.ts?docs=full";

interface ListAggregatedUtterancesRequest {

aggregationDuration: UtteranceAggregationDuration;

botAliasId?: string | null;

botId: string;

botVersion?: string | null;

filters?: AggregatedUtterancesFilter[] | null;

localeId: string;

maxResults?: number | null;

nextToken?: string | null;

sortBy?: AggregatedUtterancesSortBy | null;

}

§Properties

aggregationDuration: UtteranceAggregationDuration

[src]

The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.

botAliasId?: string | null

[src]

The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

botId: string

[src]

The unique identifier of the bot associated with this request.

botVersion?: string | null

[src]

The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

filters?: AggregatedUtterancesFilter[] | null

[src]

Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

localeId: string

[src]

The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

maxResults?: number | null

[src]

The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don't specify the maxResults parameter, 1,000 results are returned.

nextToken?: string | null

[src]

If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

sortBy?: AggregatedUtterancesSortBy | null

[src]

Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.