@slack/web-api / AssistantSearchContextArguments
Interface: AssistantSearchContextArguments
Defined in: packages/web-api/src/types/request/assistant.ts:5
Extends
TokenOverridableSortDir
Properties
action_token?
action_token?: string;
Defined in: packages/web-api/src/types/request/assistant.ts:9
Description
Send action_token as received in a message event.
after?
after?: number;
Defined in: packages/web-api/src/types/request/assistant.ts:27
Description
UNIX timestamp filter. If present, filters for results after this date.
before?
before?: number;
Defined in: packages/web-api/src/types/request/assistant.ts:25
Description
UNIX timestamp filter. If present, filters for results before this date.
channel_types?
channel_types?: ("im" | "mpim" | "public_channel" | "private_channel")[];
Defined in: packages/web-api/src/types/request/assistant.ts:14
Description
Mix and match channel types by providing a comma-separated list of any combination of
public_channel, private_channel, mpim, im.
content_types?
content_types?: ("channels" | "users" | "messages" | "files" | "enterprise")[];
Defined in: packages/web-api/src/types/request/assistant.ts:19
Description
Content types to include, a comma-separated list of any combination of messages, files,
enterprise, channels, users.
context_channel_id?
context_channel_id?: string;
Defined in: packages/web-api/src/types/request/assistant.ts:34
Description
Context channel ID to support scoping the search when applicable.
cursor?
cursor?: string;
Defined in: packages/web-api/src/types/request/assistant.ts:39
Description
The cursor returned by the API. Leave this blank for the first request and use this to get the next page of results.
disable_semantic_search?
disable_semantic_search?: boolean;
Defined in: packages/web-api/src/types/request/assistant.ts:64
Description
Whether to disable semantic search. When true, only keyword-based search is used. Defaults to false.
highlight?
highlight?: boolean;
Defined in: packages/web-api/src/types/request/assistant.ts:47
Description
Whether to highlight the search query in the results. Defaults to false if unspecified.
include_archived_channels?
include_archived_channels?: boolean;
Defined in: packages/web-api/src/types/request/assistant.ts:59
Description
Whether to include archived channels in the search results.
include_bots?
include_bots?: boolean;
Defined in: packages/web-api/src/types/request/assistant.ts:21
Description
Whether the results should include bots.
include_context_messages?
include_context_messages?: boolean;
Defined in: packages/web-api/src/types/request/assistant.ts:32
Description
Whether to include context messages surrounding the main message result. Defaults to false if unspecified.
include_deleted_users?
include_deleted_users?: boolean;
Defined in: packages/web-api/src/types/request/assistant.ts:23
Description
Whether to include deleted users in the user search results. Defaults to false.
include_message_blocks?
include_message_blocks?: boolean;
Defined in: packages/web-api/src/types/request/assistant.ts:45
Description
Whether to return the message blocks in the response.
limit?
limit?: number;
Defined in: packages/web-api/src/types/request/assistant.ts:41
Description
Number of results to return, up to a max of 20. Defaults to 20.
modifiers?
modifiers?: string;
Defined in: packages/web-api/src/types/request/assistant.ts:57
Description
A string containing only modifiers in the format of modifier:value. Search results returned
will match the modifier value. For now modifiers only affect term clauses.
query
query: string;
Defined in: packages/web-api/src/types/request/assistant.ts:7
Description
User prompt or search query
sort?
sort?: "score" | "timestamp";
Defined in: packages/web-api/src/types/request/assistant.ts:43
Description
The field to sort the results by. Defaults to score. Can be one of: score, timestamp.
sort_dir?
sort_dir?: "asc" | "desc";
Defined in: packages/web-api/src/types/request/common.ts:130
Description
Change sort direction to ascending (asc) or descending (desc). Defaults to desc.
Inherited from
SortDir.sort_dir
term_clauses?
term_clauses?: string[];
Defined in: packages/web-api/src/types/request/assistant.ts:52
Description
A list of term clauses. A term clause is a string with search terms. Search results returned will match every term clause specified (i.e., conjunctive normal form).
token?
token?: string;
Defined in: packages/web-api/src/types/request/common.ts:43
Description
Overridable authentication token bearing required scopes.
Inherited from
TokenOverridable.token