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: int | None = None, inputFileBlockIndexList: List[int] | None = None, text: str | None = None, blockQuery: str | None = None, appendOutputToFile: bool = False, outputFileId: str | None = None, makeOutputPublic: bool | None = None, options: dict | None = None, streaming: bool | None = None, tags: List[Tag] | None = 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: str | None#
input_file_block_index_list: List[int] | None#
input_file_end_block_index: int | None#
input_file_id: str#
input_file_start_block_index: int#
make_output_public: bool | None#
options: dict | None#
output_file_id: str | None#
plugin_instance: str#
streaming: bool | None#
tags: List[Tag] | None#
text: str | None#
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#