langchain_core.document_loaders.blob_loaders.Blob

class langchain_core.document_loaders.blob_loaders.Blob[source]

Bases: BaseModel

Blob代表通过引用或值表示的原始数据。

提供一个接口，以不同的表示形式实现Blob，并有助于将数据加载程序的开发与原始数据的下游解析分离。

灵感来自：https://developer.mozilla.org/en-US/docs/Web/API/Blob

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param data: Optional[Union[bytes, str]] = None

与blob相关的原始数据。

param encoding: str = 'utf-8'

如果将字节解码为字符串，则使用的编码。

如果解码为字符串，则使用utf-8作为默认编码。

param metadata: Dict[str, Any] [Optional]

关于blob的元数据（例如，来源）

param mimetype: Optional[str] = None

MimeType不要与文件扩展名混淆。

param path: Optional[Union[str, pathlib.PurePath]] = None

原始内容的位置。

as_bytes() → bytes[source]

以字节形式读取数据。

Return type

bytes

as_bytes_io() → Generator[Union[BytesIO, BufferedReader], None, None][source]

以字节流的形式读取数据。

Return type

Generator[Union[BytesIO, BufferedReader], None, None]

as_string() → str[source]

将数据读取为字符串。

Return type

str

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

Parameters

  • _fields_set (Optional[SetStr]) –

  • values (Any) –

Return type

Model

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to include in new model

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to exclude from new model, as with values this takes precedence over include

  • update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

  • deep (bool) – set to True to make a deep copy of the model

  • self (Model) –

Returns

new model instance

Return type

Model

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • by_alias (bool) –

  • skip_defaults (Optional[bool]) –

  • exclude_unset (bool) –

  • exclude_defaults (bool) –

  • exclude_none (bool) –

Return type

DictStrAny

classmethod from_data(data: Union[str, bytes], *, encoding: str = 'utf-8', mime_type: Optional[str] = None, path: Optional[str] = None, metadata: Optional[dict] = None) → Blob[source]

从内存数据初始化blob。

参数：

data：与blob关联的内存数据 encoding：解码字节为字符串时要使用的编码 mime_type：如果提供，将设置为数据的mime类型 path：如果提供，将设置为数据来源的路径 metadata：要与blob关联的元数据

返回：

Blob实例

Parameters

  • data (Union[str, bytes]) –

  • encoding (str) –

  • mime_type (Optional[str]) –

  • path (Optional[str]) –

  • metadata (Optional[dict]) –

Return type

Blob

classmethod from_orm(obj: Any) → Model
Parameters

obj (Any) –

Return type

Model

classmethod from_path(path: Union[str, PurePath], *, encoding: str = 'utf-8', mime_type: Optional[str] = None, guess_type: bool = True, metadata: Optional[dict] = None) → Blob[source]

从类似路径对象中加载 blob。

参数:

path: 要读取的文件的路径对象 encoding: 如果将字节解码为字符串，则使用的编码 mime_type: 如果提供，将设置为数据的 mime 类型 guess_type: 如果为 True，则将从文件扩展名猜测 mime 类型，

如果未提供 mime 类型

metadata: 与 blob 关联的元数据

返回:

Blob 实例

Parameters

  • path (Union[str, PurePath]) –

  • encoding (str) –

  • mime_type (Optional[str]) –

  • guess_type (bool) –

  • metadata (Optional[dict]) –

Return type

Blob

json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • by_alias (bool) –

  • skip_defaults (Optional[bool]) –

  • exclude_unset (bool) –

  • exclude_defaults (bool) –

  • exclude_none (bool) –

  • encoder (Optional[Callable[[Any], Any]]) –

  • models_as_dict (bool) –

  • dumps_kwargs (Any) –

Return type

unicode

classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model
Parameters

  • path (Union[str, Path]) –

  • content_type (unicode) –

  • encoding (unicode) –

  • proto (Protocol) –

  • allow_pickle (bool) –

Return type

Model

classmethod parse_obj(obj: Any) → Model
Parameters

obj (Any) –

Return type

Model

classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model
Parameters

  • b (Union[str, bytes]) –

  • content_type (unicode) –

  • encoding (unicode) –

  • proto (Protocol) –

  • allow_pickle (bool) –

Return type

Model

classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny
Parameters

  • by_alias (bool) –

  • ref_template (unicode) –

Return type

DictStrAny

classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode
Parameters

  • by_alias (bool) –

  • ref_template (unicode) –

  • dumps_kwargs (Any) –

Return type

unicode

classmethod update_forward_refs(**localns: Any) → None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Parameters

localns (Any) –

Return type

None

classmethod validate(value: Any) → Model
Parameters

value (Any) –

Return type

Model

property source: Optional[str]

如果已知blob的源位置，则返回字符串形式，否则返回None。

如果blob关联了路径，则默认为路径位置。

除非通过名为”source”的元数据字段显式设置，否则将使用该值。

Examples using Blob