slackline - v1.0.0

slackline/api/assistant/search_context

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Setters for the optional arguments of assistant.search.context. Each setter takes the call that assistant.search_context returns and sets one argument:

assistant.search_context(query: "What is project gizmo?")
|> search_context.action_token("12345.98765.abcd2358fdea")

Values

action_token

</> 
pub fn action_token(
  call: slackline.Call(assistant.SearchContext, r),
  action_token: String,
) -> slackline.Call(assistant.SearchContext, r)

Send action_token as received in a message event.

after

</> 
pub fn after(
  call: slackline.Call(assistant.SearchContext, r),
  after: Int,
) -> slackline.Call(assistant.SearchContext, r)

UNIX timestamp filter. If present, filters for results after this date.

before

</> 
pub fn before(
  call: slackline.Call(assistant.SearchContext, r),
  before: Int,
) -> slackline.Call(assistant.SearchContext, r)

UNIX timestamp filter. If present, filters for results before this date.

channel_types

</> 
pub fn channel_types(
  call: slackline.Call(assistant.SearchContext, r),
  channel_types: List(String),
) -> slackline.Call(assistant.SearchContext, r)

Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im. Defaults to public_channel.

content_types

</> 
pub fn content_types(
  call: slackline.Call(assistant.SearchContext, r),
  content_types: List(String),
) -> slackline.Call(assistant.SearchContext, r)

Content types to include, a comma-separated list of any combination of messages, files, channels, users. Defaults to messages.

context_channel_id

</> 
pub fn context_channel_id(
  call: slackline.Call(assistant.SearchContext, r),
  context_channel_id: String,
) -> slackline.Call(assistant.SearchContext, r)

Context channel ID to support scoping the search when applicable.

cursor

</> 
pub fn cursor(
  call: slackline.Call(assistant.SearchContext, r),
  cursor: String,
) -> slackline.Call(assistant.SearchContext, r)

The cursor returned by the API. Leave this blank for the first request and use this to get the next page of results.

</> 
pub fn disable_semantic_search(
  call: slackline.Call(assistant.SearchContext, r),
  disable_semantic_search: Bool,
) -> slackline.Call(assistant.SearchContext, r)

Whether to disable semantic search. When true, only keyword-based search is used. Defaults to false.

highlight

</> 
pub fn highlight(
  call: slackline.Call(assistant.SearchContext, r),
  highlight: Bool,
) -> slackline.Call(assistant.SearchContext, r)

Whether to highlight the search query in the results. Defaults to false if unspecified.

include_archived_channels

</> 
pub fn include_archived_channels(
  call: slackline.Call(assistant.SearchContext, r),
  include_archived_channels: Bool,
) -> slackline.Call(assistant.SearchContext, r)

Whether to include archived channels in the search results.

include_bots

</> 
pub fn include_bots(
  call: slackline.Call(assistant.SearchContext, r),
  include_bots: Bool,
) -> slackline.Call(assistant.SearchContext, r)

Whether the results should include bots.

include_context_messages

</> 
pub fn include_context_messages(
  call: slackline.Call(assistant.SearchContext, r),
  include_context_messages: Bool,
) -> slackline.Call(assistant.SearchContext, r)

Whether to include context messages surrounding the main message result. Defaults to false if unspecified.

include_deleted_users

</> 
pub fn include_deleted_users(
  call: slackline.Call(assistant.SearchContext, r),
  include_deleted_users: Bool,
) -> slackline.Call(assistant.SearchContext, r)

Whether to include deleted users in the user search results. Defaults to false.

include_message_blocks

</> 
pub fn include_message_blocks(
  call: slackline.Call(assistant.SearchContext, r),
  include_message_blocks: Bool,
) -> slackline.Call(assistant.SearchContext, r)

Whether to return the message blocks in the response.

keywords_clauses

</> 
pub fn keywords_clauses(
  call: slackline.Call(assistant.SearchContext, r),
  keywords_clauses: List(List(String)),
) -> slackline.Call(assistant.SearchContext, r)

Groups of keywords. A result matches any keyword in each group.

limit

</> 
pub fn limit(
  call: slackline.Call(assistant.SearchContext, r),
  limit: Int,
) -> slackline.Call(assistant.SearchContext, r)

Number of results to return, up to a max of 20. Defaults to 20.

modifiers

</> 
pub fn modifiers(
  call: slackline.Call(assistant.SearchContext, r),
  modifiers: String,
) -> slackline.Call(assistant.SearchContext, r)

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.

sort

</> 
pub fn sort(
  call: slackline.Call(assistant.SearchContext, r),
  sort: common.SearchSort,
) -> slackline.Call(assistant.SearchContext, r)

The field to sort the results by. Defaults to score. Can be one of: score, timestamp. Acceptable values: score timestamp Defaults to score.

sort_dir

</> 
pub fn sort_dir(
  call: slackline.Call(assistant.SearchContext, r),
  sort_dir: common.SortDirection,
) -> slackline.Call(assistant.SearchContext, r)

The direction to sort the results by. Defaults to desc. Acceptable values: asc desc Defaults to desc.

term_clauses

</> 
pub fn term_clauses(
  call: slackline.Call(assistant.SearchContext, r),
  term_clauses: List(String),
) -> slackline.Call(assistant.SearchContext, r)

Search term clauses. Results match every clause. Between 1 and 5.

✨ Search Document