KnowledgeSourceFile Class

Metadata for a file uploaded to a File knowledge source.

Constructor

KnowledgeSourceFile(*args: Any, **kwargs: Any)

Variables

Name	Description
file_id	str The unique identifier for the file.
file_name	str The original file name.
file_size_bytes	int The file size in bytes.
created_at	datetime The timestamp when the file was created.
last_updated_at	datetime The timestamp when the file was last updated.
error_message	str The error message if file processing failed, null otherwise.
prefix	str The prefix (directory-like path) derived from the full file name.
metadata	dict[str, str] Custom key/value metadata stored with the file. Returned but not searchable or filterable.
parsing_mode	str or BlobIndexerParsingMode The parsing mode applied to the file (auto-detected from the file). Known values are: "default", "text", "delimitedText", "json", "jsonArray", "jsonLines", and "markdown".
extraction_mode	str or FileKnowledgeSourceExtractionMode The extraction mode applied to the file. Known values are: "minimal" and "standard".

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from the dictionary.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.
setdefault	Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
update	Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on the mapping's values

Attributes

created_at

The timestamp when the file was created.

created_at: datetime | None

error_message

The error message if file processing failed, null otherwise.

error_message: str | None

extraction_mode

"minimal" and "standard".

extraction_mode: str | _models.FileKnowledgeSourceExtractionMode | None

file_id

The unique identifier for the file.

file_id: str | None

file_name

The original file name.

file_name: str | None

file_size_bytes

The file size in bytes.

file_size_bytes: int | None

last_updated_at

The timestamp when the file was last updated.

last_updated_at: datetime | None

metadata

Custom key/value metadata stored with the file. Returned but not searchable or filterable.

metadata: dict[str, str] | None

parsing_mode

The parsing mode applied to the file (auto-detected from the file). Known values are: "default", "text", "delimitedText", "json", "jsonArray", "jsonLines", and "markdown".

parsing_mode: str | _models.BlobIndexerParsingMode | None

prefix

The prefix (directory-like path) derived from the full file name.

prefix: str | None

Feedback

Was this page helpful?