StartSearchRequest ¶

class StartSearchRequest(TypedDict, closed=True):
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace whose data is searched.</p>"""
    query_statement: (
        "capo_iotsitewise.types.search_query_statement.SearchQueryStatement"
    )
    """<p>The natural-language query describing the data to search for.</p>"""
    client_token: NotRequired["capo_iotsitewise.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier you provide to ensure the request is idempotent. Repeating a StartSearch call with the same <code>clientToken</code> returns the original search rather than starting a new one. If omitted, the SDK autogenerates one.</p>"""
    search_type: NotRequired["capo_iotsitewise.types.search_type.SearchType"]
    """<p>The search strategy to use. Defaults to <code>QUICK</code> when omitted.</p>"""
    search_filters: NotRequired["capo_iotsitewise.types.search_filters.SearchFilters"]
    """<p>Optional filters that restrict the search to a subset of the workspace's data.</p>"""
    group_id: NotRequired["capo_iotsitewise.types.group_id.GroupId"]
    """<p>An optional caller-supplied identifier used to group related searches together.</p>"""