qcfractal/interface/client.py
def query_keywords(
        self,
        id: Optional["QueryObjectId"] = None,
        *,
        hash_index: Optional["QueryStr"] = None,
        limit: Optional[int] = None,
        skip: int = 0,
        full_return: bool = False,
    ) -> Union["KeywordGETResponse", List["KeywordSet"]]:
        """Obtains KeywordSets from the server using keyword ids.

        Parameters
        ----------
        id : QueryObjectId, optional
            A list of ids to query.
        hash_index : QueryStr, optional
            The hash index to look up
        limit : Optional[int], optional
            The maximum number of keywords to query
        skip : int, optional
            The number of keywords to skip in the query, used during pagination
        full_return : bool, optional
            Returns the full server response if True that contains additional metadata.

        Returns
        -------
        List[KeywordSet]
            The requested KeywordSet objects.
        """

        payload = {"meta": {}, "data": {"id": id, "hash_index": hash_index}}
        return self._automodel_request("keyword", "get", payload, full_return=full_return)
Obtains KeywordSets from the server using keyword ids.

        Parameters
        ----------
        id : QueryObjectId, optional
            A list of ids to query.
        hash_index : QueryStr, optional
            The hash index to look up
        limit : Optional[int], optional
            The maximum number of keywords to query
        skip : int, optional
            The number of keywords to skip in the query, used during pagination
        full_return : bool, optional
            Returns the full server response if True that contains additional metadata.

        Returns
        -------
        List[KeywordSet]
            The requested KeywordSet objects.
        
Obtains KeywordSets from the server using keyword ids.
Parameters

id : QueryObjectId, optional
A list of ids to query.
hash_index : QueryStr, optional
The hash index to look up
limit : Optional[int], optional
The maximum number of keywords to query
skip : int, optional
The number of keywords to skip in the query, used during pagination
full_return : bool, optional
Returns the full server response if True that contains additional metadata.

Returns


Obtains KeywordSets from the server using keyword ids . Parameters id : QueryObjectId optional A list of ids to query . hash_index : QueryStr optional The hash index to look up limit : Optional [ int ] optional The maximum number of keywords to query skip : int optional The number of keywords to skip in the query used during pagination full_return : bool optional Returns the full server response if True that contains additional metadata . Returns
def query_keywords(
        self,
        id: Optional["QueryObjectId"] = None,
        *,
        hash_index: Optional["QueryStr"] = None,
        limit: Optional[int] = None,
        skip: int = 0,
        full_return: bool = False,
    ) -> Union["KeywordGETResponse", List["KeywordSet"]]:
        payload = {"meta": {}, "data": {"id": id, "hash_index": hash_index}}
        return self._automodel_request("keyword", "get", payload, full_return=full_return)
def query_keywords ( self , id : Optional [ "QueryObjectId" ] = None , * , hash_index : Optional [ "QueryStr" ] = None , limit : Optional [ int ] = None , skip : int = 0 , full_return : bool = False , ) -> Union [ "KeywordGETResponse" , List [ "KeywordSet" ] ] : payload = { "meta" : { } , "data" : { "id" : id , "hash_index" : hash_index } } return self . _automodel_request ( "keyword" , "get" , payload , full_return = full_return )
Obtains KeywordSets from the server using keyword ids.
Obtains KeywordSets from the server using keyword ids .
"""Obtains KeywordSets from the server using keyword ids.

        Parameters
        ----------
        id : QueryObjectId, optional
            A list of ids to query.
        hash_index : QueryStr, optional
            The hash index to look up
        limit : Optional[int], optional
            The maximum number of keywords to query
        skip : int, optional
            The number of keywords to skip in the query, used during pagination
        full_return : bool, optional
            Returns the full server response if True that contains additional metadata.

        Returns
        -------
        List[KeywordSet]
            The requested KeywordSet objects.
        """
self
id
Optional["QueryObjectId"]
hash_index
Optional["QueryStr"]
limit
Optional[int]
skip
int
full_return
bool