Organization module

Queries

Set of Organization queries.

Source code in kili/entrypoints/queries/organization/__init__.py

class QueriesOrganization(BaseOperationEntrypointMixin):
    """Set of Organization queries."""

    graphql_client: GraphQLClient

    # pylint: disable=too-many-arguments

    @overload
    def organizations(
        self,
        email: Optional[str] = None,
        organization_id: Optional[str] = None,
        fields: ListOrTuple[str] = ("id", "name"),
        first: Optional[int] = None,
        skip: int = 0,
        disable_tqdm: Optional[bool] = None,
        *,
        as_generator: Literal[True],
    ) -> Generator[Dict, None, None]: ...

    @overload
    def organizations(
        self,
        email: Optional[str] = None,
        organization_id: Optional[str] = None,
        fields: ListOrTuple[str] = ("id", "name"),
        first: Optional[int] = None,
        skip: int = 0,
        disable_tqdm: Optional[bool] = None,
        *,
        as_generator: Literal[False] = False,
    ) -> List[Dict]: ...

    @typechecked
    def organizations(
        self,
        email: Optional[str] = None,
        organization_id: Optional[str] = None,
        fields: ListOrTuple[str] = ("id", "name"),
        first: Optional[int] = None,
        skip: int = 0,
        disable_tqdm: Optional[bool] = None,
        *,
        as_generator: bool = False,
    ) -> Iterable[Dict]:
        # pylint: disable=line-too-long
        """Get a generator or a list of organizations that match a set of criteria.

        Args:
            email: Email of a user of the organization
            organization_id: Identifier of the organization
            fields: All the fields to request among the possible fields for the organizations.
                See [the documentation](https://docs.kili-technology.com/reference/graphql-api#organization) for all possible fields.
            first: Maximum number of organizations to return.
            skip: Number of skipped organizations (they are ordered by creation date)
            disable_tqdm: If `True`, the progress bar will be disabled
            as_generator: If `True`, a generator on the organizations is returned.

        Returns:
            An iterable of organizations.

        Examples:
            >>> kili.organizations(organization_id=organization_id, fields=['users.email'])
            [{'users': [{'email': 'john@doe.com'}]}]
        """
        where = OrganizationWhere(
            email=email,
            organization_id=organization_id,
        )
        disable_tqdm = disable_tqdm_if_as_generator(as_generator, disable_tqdm)
        options = QueryOptions(disable_tqdm, first, skip)
        organizations_gen = OrganizationQuery(self.graphql_client, self.http_client)(
            where, fields, options
        )

        if as_generator:
            return organizations_gen
        return list(organizations_gen)

    @typechecked
    def count_organizations(
        self, email: Optional[str] = None, organization_id: Optional[str] = None
    ) -> int:
        """Count organizations that match a set of criteria.

        Args:
            email: Email of a user of the organization
            organization_id: Identifier of the organization

        Returns:
            An integer corresponding to the number of organizations that match the criteria.
        """
        where = OrganizationWhere(
            email=email,
            organization_id=organization_id,
        )
        return OrganizationQuery(self.graphql_client, self.http_client).count(where)

    @typechecked
    def organization_metrics(
        self,
        organization_id: str,
        start_date: Optional[datetime] = None,
        end_date: Optional[datetime] = None,
    ) -> Dict:
        """Get organization metrics.

        Args:
            organization_id: Identifier of the organization
            start_date: Start date of the metrics computation
            end_date: End date of the metrics computation

        Returns:
            A dictionary containing the metrics of the organization.
        """
        if start_date is None:
            start_date = datetime.now()
        if end_date is None:
            end_date = datetime.now()
        where = OrganizationMetricsWhere(
            organization_id=organization_id, start_date=start_date, end_date=end_date
        )
        return OrganizationQuery(self.graphql_client, self.http_client).metrics(where)

count_organizations(self, email=None, organization_id=None)

Count organizations that match a set of criteria.

Parameters:

Name	Type	Description	Default
email	Optional[str]	Email of a user of the organization	None
organization_id	Optional[str]	Identifier of the organization	None

Returns:

Type	Description
int	An integer corresponding to the number of organizations that match the criteria.

Source code in kili/entrypoints/queries/organization/__init__.py

@typechecked
def count_organizations(
    self, email: Optional[str] = None, organization_id: Optional[str] = None
) -> int:
    """Count organizations that match a set of criteria.

    Args:
        email: Email of a user of the organization
        organization_id: Identifier of the organization

    Returns:
        An integer corresponding to the number of organizations that match the criteria.
    """
    where = OrganizationWhere(
        email=email,
        organization_id=organization_id,
    )
    return OrganizationQuery(self.graphql_client, self.http_client).count(where)

organization_metrics(self, organization_id, start_date=None, end_date=None)

Get organization metrics.

Parameters:

Name	Type	Description	Default
organization_id	str	Identifier of the organization	required
start_date	Optional[datetime.datetime]	Start date of the metrics computation	None
end_date	Optional[datetime.datetime]	End date of the metrics computation	None

Returns:

Type	Description
Dict	A dictionary containing the metrics of the organization.

Source code in kili/entrypoints/queries/organization/__init__.py

@typechecked
def organization_metrics(
    self,
    organization_id: str,
    start_date: Optional[datetime] = None,
    end_date: Optional[datetime] = None,
) -> Dict:
    """Get organization metrics.

    Args:
        organization_id: Identifier of the organization
        start_date: Start date of the metrics computation
        end_date: End date of the metrics computation

    Returns:
        A dictionary containing the metrics of the organization.
    """
    if start_date is None:
        start_date = datetime.now()
    if end_date is None:
        end_date = datetime.now()
    where = OrganizationMetricsWhere(
        organization_id=organization_id, start_date=start_date, end_date=end_date
    )
    return OrganizationQuery(self.graphql_client, self.http_client).metrics(where)

organizations(self, email=None, organization_id=None, fields=('id', 'name'), first=None, skip=0, disable_tqdm=None, *, as_generator=False)

Get a generator or a list of organizations that match a set of criteria.

Parameters:

Name	Type	Description	Default
email	Optional[str]	Email of a user of the organization	None
organization_id	Optional[str]	Identifier of the organization	None
fields	Union[List[str], Tuple[str, ...]]	All the fields to request among the possible fields for the organizations. See the documentation for all possible fields.	('id', 'name')
first	Optional[int]	Maximum number of organizations to return.	None
skip	int	Number of skipped organizations (they are ordered by creation date)	0
disable_tqdm	Optional[bool]	If True, the progress bar will be disabled	None
as_generator	bool	If True, a generator on the organizations is returned.	False

Returns:

Type	Description
Iterable[Dict]	An iterable of organizations.

Examples:

>>> kili.organizations(organization_id=organization_id, fields=['users.email'])
[{'users': [{'email': 'john@doe.com'}]}]

Source code in kili/entrypoints/queries/organization/__init__.py

@typechecked
def organizations(
    self,
    email: Optional[str] = None,
    organization_id: Optional[str] = None,
    fields: ListOrTuple[str] = ("id", "name"),
    first: Optional[int] = None,
    skip: int = 0,
    disable_tqdm: Optional[bool] = None,
    *,
    as_generator: bool = False,
) -> Iterable[Dict]:
    # pylint: disable=line-too-long
    """Get a generator or a list of organizations that match a set of criteria.

    Args:
        email: Email of a user of the organization
        organization_id: Identifier of the organization
        fields: All the fields to request among the possible fields for the organizations.
            See [the documentation](https://docs.kili-technology.com/reference/graphql-api#organization) for all possible fields.
        first: Maximum number of organizations to return.
        skip: Number of skipped organizations (they are ordered by creation date)
        disable_tqdm: If `True`, the progress bar will be disabled
        as_generator: If `True`, a generator on the organizations is returned.

    Returns:
        An iterable of organizations.

    Examples:
        >>> kili.organizations(organization_id=organization_id, fields=['users.email'])
        [{'users': [{'email': 'john@doe.com'}]}]
    """
    where = OrganizationWhere(
        email=email,
        organization_id=organization_id,
    )
    disable_tqdm = disable_tqdm_if_as_generator(as_generator, disable_tqdm)
    options = QueryOptions(disable_tqdm, first, skip)
    organizations_gen = OrganizationQuery(self.graphql_client, self.http_client)(
        where, fields, options
    )

    if as_generator:
        return organizations_gen
    return list(organizations_gen)