langchain.document_loaders.embaas.EmbaasDocumentExtractionParameters

class langchain.document_loaders.embaas.EmbaasDocumentExtractionParameters

Bases: TypedDict

Parameters for the embaas document extraction API.

Methods

__init__(*args, **kwargs)
clear()
copy()
fromkeys([value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items()
keys()
pop(k[,d])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem()	Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()

Attributes

mime_type	The mime type of the document.
file_extension	The file extension of the document.
file_name	The file name of the document.
should_chunk	Whether to chunk the document into pages.
chunk_size	The maximum size of the text chunks.
chunk_overlap	The maximum overlap allowed between chunks.
chunk_splitter	The text splitter class name for creating chunks.
separators	The separators for chunks.
should_embed	Whether to create embeddings for the document in the response.
model	The model to pass to the Embaas document extraction API.
instruction	The instruction to pass to the Embaas document extraction API.

clear() → None.  Remove all items from D.

copy() → a shallow copy of D

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

chunk_overlap: int

The maximum overlap allowed between chunks.

chunk_size: int

The maximum size of the text chunks.

chunk_splitter: str

The text splitter class name for creating chunks.

file_extension: str

The file extension of the document.

file_name: str

The file name of the document.

instruction: str

The instruction to pass to the Embaas document extraction API.

mime_type: str

The mime type of the document.

model: str

The model to pass to the Embaas document extraction API.

separators: List[str]

The separators for chunks.

should_chunk: bool

Whether to chunk the document into pages.

should_embed: bool

Whether to create embeddings for the document in the response.