Skip to content

SearchResult

Source code in docs_src/capo_iotsitewise/types/search_result.py
class SearchResult(TypedDict, closed=True):
    search_id: "capo_iotsitewise.types.search_id.SearchId"
    """<p>The identifier of the search that produced this result.</p>"""
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace the search ran against.</p>"""
    dataset_id: "capo_iotsitewise.types.dataset_id.DatasetId"
    """<p>The identifier of the dataset that contains the matching data.</p>"""
    time_series_id: "capo_iotsitewise.types.time_series_id.TimeSeriesId"
    """<p>The identifier of the time series that contains the matching data.</p>"""
    start_timestamp: "capo_iotsitewise.types.time_in_nanos.TimeInNanos"
    """<p>The start of the matching time-series segment, in nanoseconds since the Unix epoch.</p>"""
    end_timestamp: "capo_iotsitewise.types.time_in_nanos.TimeInNanos"
    """<p>The end of the matching time-series segment, in nanoseconds since the Unix epoch.</p>"""
    top_timestamp: "capo_iotsitewise.types.time_in_nanos.TimeInNanos"
    """<p>The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.</p>"""
    score: "float"
    """<p>The relevance score of this result. Higher scores indicate a stronger match.</p>"""

dataset_id instance-attribute

dataset_id: DatasetId

The identifier of the dataset that contains the matching data.

end_timestamp instance-attribute

end_timestamp: TimeInNanos

The end of the matching time-series segment, in nanoseconds since the Unix epoch.

score instance-attribute

score: float

The relevance score of this result. Higher scores indicate a stronger match.

search_id instance-attribute

search_id: SearchId

The identifier of the search that produced this result.

start_timestamp instance-attribute

start_timestamp: TimeInNanos

The start of the matching time-series segment, in nanoseconds since the Unix epoch.

time_series_id instance-attribute

time_series_id: TimeSeriesId

The identifier of the time series that contains the matching data.

top_timestamp instance-attribute

top_timestamp: TimeInNanos

The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.

workspace_name instance-attribute

workspace_name: WorkspaceName

The name of the workspace the search ran against.