Skip to main content
Version: Next

APIMessageSearchResult

Index

Properties

optionaldocuments_indexed

documents_indexed?: number

The number of documents that have been indexed during the current index operation, if any

doing_deep_historical_index

doing_deep_historical_index: boolean

Whether the guild is undergoing a deep historical indexing operation

optionalmembers

members?: APIThreadMember[]

A thread member object for each returned thread the current user has joined

messages

messages: Omit<APIMessage, reactions>[][]

A nested array of messages that match the query

@remarks

The nested array was used to provide surrounding context to search results. However, surrounding context is no longer returned.

optionalthreads

The threads that contain the returned messages

total_results

total_results: number

The total number of results that match the query