cohere-python

1
# This file was auto-generated by Fern from our API Definition.
2

3
import datetime as dt
4
import typing
5

6
from ..core.datetime_utils import serialize_datetime
7
from .dataset_part import DatasetPart
8
from .dataset_type import DatasetType
9
from .dataset_validation_status import DatasetValidationStatus
10

11
try:
12
    import pydantic.v1 as pydantic  # type: ignore
13
except ImportError:
14
    import pydantic  # type: ignore
15

16

17
class Dataset(pydantic.BaseModel):
18
    id: str = pydantic.Field()
19
    """
20
    The dataset ID
21
    """
22

23
    name: str = pydantic.Field()
24
    """
25
    The name of the dataset
26
    """
27

28
    created_at: dt.datetime = pydantic.Field()
29
    """
30
    The creation date
31
    """
32

33
    updated_at: dt.datetime = pydantic.Field()
34
    """
35
    The last update date
36
    """
37

38
    dataset_type: DatasetType
39
    validation_status: DatasetValidationStatus
40
    validation_error: typing.Optional[str] = pydantic.Field(default=None)
41
    """
42
    Errors found during validation
43
    """
44

45
    schema_: typing.Optional[str] = pydantic.Field(alias="schema", default=None)
46
    """
47
    the avro schema of the dataset
48
    """
49

50
    required_fields: typing.Optional[typing.List[str]] = None
51
    preserve_fields: typing.Optional[typing.List[str]] = None
52
    dataset_parts: typing.Optional[typing.List[DatasetPart]] = pydantic.Field(default=None)
53
    """
54
    the underlying files that make up the dataset
55
    """
56

57
    validation_warnings: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
58
    """
59
    warnings found during validation
60
    """
61

62
    def json(self, **kwargs: typing.Any) -> str:
63
        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
64
        return super().json(**kwargs_with_defaults)
65

66
    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
67
        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
68
        return super().dict(**kwargs_with_defaults)
69

70
    class Config:
71
        frozen = True
72
        smart_union = True
73
        allow_population_by_field_name = True
74
        populate_by_name = True
75
        extra = pydantic.Extra.allow
76
        json_encoders = {dt.datetime: serialize_datetime}
77