steamship.data.operations package#

Submodules#

steamship.data.operations.blockifier module#

class steamship.data.operations.blockifier.BlockifyRequest(*, type: str = None, pluginInstance: str = None, id: str = None, handle: str = None, name: str = None)[source]#

Bases: Request

handle: str#
id: str#
name: str#
plugin_instance: str#
type: str#

steamship.data.operations.embedder module#

class steamship.data.operations.embedder.EmbedRequest(*, docs: List[str], pluginInstance: str, metadata: Dict = None)[source]#

Bases: Request

docs: List[str]#
metadata: Dict#
plugin_instance: str#

steamship.data.operations.generator module#

class steamship.data.operations.generator.GenerateRequest(*, pluginInstance: str = None, inputFileId: str = None, inputFileStartBlockIndex: int = None, inputFileEndBlockIndex: Optional[int] = None, text: Optional[str] = None, blockQuery: Optional[str] = None, appendOutputToFile: bool = False, outputFileId: Optional[str] = None, options: Optional[dict] = None)[source]#

Bases: Request

This class provides the input for a request to a Generator. There are several ways to specify the input; see below

append_output_to_file: bool#
block_query: Optional[str]#
input_file_end_block_index: Optional[int]#
input_file_id: str#
input_file_start_block_index: int#
options: Optional[dict]#
output_file_id: Optional[str]#
plugin_instance: str#
text: Optional[str]#
class steamship.data.operations.generator.GenerateResponse(*, blocks: List[Block])[source]#

Bases: Response

blocks: List[Block]#

steamship.data.operations.tagger module#

class steamship.data.operations.tagger.TagRequest(*, type: str = None, id: str = None, name: str = None, handle: str = None, pluginInstance: str = None, file: File = None)[source]#

Bases: Request

file: File#
handle: str#
id: str#
name: str#
plugin_instance: str#
type: str#
class steamship.data.operations.tagger.TagResponse(*, file: File = None)[source]#

Bases: Response

file: File#

Module contents#