ResourceFile

class openapi_client.models.resource_file.ResourceFile(**data)

Bases: BaseModel

File information for a knowledge base resource.

file_name: Optional[StrictStr]

file_status: Optional[StrictStr]

dataset_name: Optional[StrictStr]

file_path: Optional[StrictStr]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of ResourceFile from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of ResourceFile from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'dataset_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='DatasetName', alias_priority=2, description='The name of the dataset containing the file.'), 'file_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='FileName', alias_priority=2, description='The name of the file.'), 'file_path': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='FilePath', alias_priority=2, description='The S3 path to the file.'), 'file_status': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='FileStatus', alias_priority=2, description="The current status of the file (e.g., 'INDEXED', 'FAILED', 'PENDING').")}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(__context)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self (BaseModel) – The BaseModel instance.

• __context (Any) – The context.

Return type:

None