steamship.data package#

Subpackages#

Submodules#

steamship.data.block module#

class steamship.data.block.Block(*, client: Client = None, id: str = None, fileId: str = None, text: str = None, tags: List[Tag] | None = [], index: int | None = None, mimeType: MimeTypes | None = None, publicData: bool = False, streamState: StreamState | None = None, requestId: str | None = None, url: str | None = None, contentURL: str | None = None, uploadType: BlockUploadType | None = None, uploadBytes: bytes | None = None)[source]#

Bases: CamelModel

A Block is a chunk of content within a File. It can be plain text content, image content, video content, etc. If the content is not text, the text value may be the empty string for backwards compatibility.

class ListRequest(*, fileId: str = None)[source]#

Bases: Request

file_id: str#
class ListResponse(*, blocks: List[Block] = [])[source]#

Bases: Response

blocks: List[Block]#
abort_stream()[source]#
append_stream(bytes: bytes)[source]#
as_llm_input(exclude_block_wrapper: bool | None = False) str[source]#
property chat_id: str#
property chat_role: RoleTag | None#
client: Client#
content_url: str | None#
static create(client: Client, file_id: str, text: str = None, tags: List[Tag] = None, content: str | bytes = None, url: str | None = None, mime_type: MimeTypes | None = None, public_data: bool = False, streaming: bool | None = None) Block[source]#

Create a new Block within a File specified by file_id.

You can create a Block in several ways: - Providing raw text as the text parameter; - Providing the content of the block as string or bytes; - Providing a publicly accessible URL where the content is stored.

delete() Block[source]#
file_id: str#
finish_stream()[source]#
static get(client: Client, _id: str = None) Block[source]#
id: str#
index(embedding_plugin_instance: Any = None)[source]#

Index this block.

index_in_file: int | None#
is_audio()[source]#

Return whether this is an audio Block.

is_image()[source]#

Return whether this is an image Block.

is_steamship_internal()[source]#
is_text() bool[source]#

Return whether this is a text Block.

is_video()[source]#

Return whether this is a video Block.

property message_id: str#
mime_type: MimeTypes | None#
classmethod parse_obj(obj: Any) BaseModel[source]#
public_data: bool#
static query(client: Client, tag_filter_query: str) BlockQueryResponse[source]#
raw()[source]#
property raw_data_url: str | None#

Return a URL at which the data content of this Block can be accessed. If public_data is True, this content can be accessed without an API key.

request_id: str | None#

The Steamship request ID associated with the creation of this block.

set_chat_id(chat_id: str)[source]#
set_chat_role(role: RoleTag)[source]#
set_message_id(message_id: str)[source]#
set_public_data(public_data: bool)[source]#

Set the public_data flag on this Block. If this object already exists server-side, update the flag.

set_request_id(request_id: str | None)[source]#
set_thread_id(thread_id: str) None[source]#
set_user_id(user_id: str) None[source]#
stream_state: StreamState | None#
tags: List[Tag] | None#
text: str#
property thread_id: str | None#
to_public_url() str[source]#

Return a public URL to access the Block’s data.

upload_bytes: bytes | None#
upload_type: BlockUploadType | None#
url: str | None#
property user_id: str | None#
class steamship.data.block.BlockQueryRequest(*, tagFilterQuery: str)[source]#

Bases: Request

tag_filter_query: str#
class steamship.data.block.BlockQueryResponse(*, blocks: List[Block])[source]#

Bases: Response

blocks: List[Block]#
class steamship.data.block.BlockUploadType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

BLOCKS = 'blocks'#
FILE = 'file'#
NONE = 'none'#
URL = 'url'#
class steamship.data.block.StreamState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

ABORTED = 'aborted'#
COMPLETE = 'complete'#
STARTED = 'started'#
steamship.data.block.is_block_id(value: str) bool[source]#

steamship.data.embeddings module#

class steamship.data.embeddings.EmbedAndSearchRequest(*, query: str, docs: List[str], pluginInstance: str, k: int = 1)[source]#

Bases: Request

docs: List[str]#
k: int#
plugin_instance: str#
query: str#
class steamship.data.embeddings.EmbeddedItem(*, id: str = None, indexId: str = None, fileId: str = None, blockId: str = None, tagId: str = None, value: str = None, externalId: str = None, externalType: str = None, metadata: Any = None, embedding: List[float] = None)[source]#

Bases: CamelModel

block_id: str#
clone_for_insert() EmbeddedItem[source]#

Produces a clone with a string representation of the metadata

embedding: List[float]#
external_id: str#
external_type: str#
file_id: str#
id: str#
index_id: str#
metadata: Any#
tag_id: str#
value: str#
class steamship.data.embeddings.EmbeddingIndex(*, client: Client = None, id: str = None, handle: str = None, name: str = None, plugin: str = None, externalId: str = None, externalType: str = None, metadata: str = None)[source]#

Bases: CamelModel

A persistent, read-optimized index over embeddings.

client: Client#
static create(client: Client, handle: str = None, name: str = None, embedder_plugin_instance_handle: str = None, fetch_if_exists: bool = True, external_id: str = None, external_type: str = None, metadata: Any = None) EmbeddingIndex[source]#
delete() EmbeddingIndex[source]#
embed() Task[IndexEmbedResponse][source]#
external_id: str#
external_type: str#
handle: str#
id: str#
insert(value: str, external_id: str = None, external_type: str = None, metadata: int | float | bool | str | List | Dict = None, reindex: bool = True, allow_long_records=False) IndexInsertResponse[source]#
insert_file(file_id: str, block_type: str = None, external_id: str = None, external_type: str = None, metadata: int | float | bool | str | List | Dict = None, reindex: bool = True) IndexInsertResponse[source]#
insert_many(items: List[EmbeddedItem | str], reindex: bool = True, allow_long_records=False) IndexInsertResponse[source]#
list_items(file_id: str = None, block_id: str = None, span_id: str = None, page_size: int | None = None, page_token: str | None = None, sort_order: SortOrder | None = SortOrder.DESC) ListItemsResponse[source]#
metadata: str#
name: str#
classmethod parse_obj(obj: Any) BaseModel[source]#
plugin: str#
search(query: str | List[str], k: int = 1, include_metadata: bool = False) Task[QueryResults][source]#
class steamship.data.embeddings.IndexCreateRequest(*, handle: str = None, name: str = None, pluginInstance: str = None, fetchIfExists: bool = True, externalId: str = None, externalType: str = None, metadata: Any = None)[source]#

Bases: Request

external_id: str#
external_type: str#
fetch_if_exists: bool#
handle: str#
metadata: Any#
name: str#
plugin_instance: str#
class steamship.data.embeddings.IndexEmbedRequest(*, id: str)[source]#

Bases: Request

id: str#
class steamship.data.embeddings.IndexEmbedResponse(*, id: str | None = None)[source]#

Bases: Response

id: str | None#
class steamship.data.embeddings.IndexInsertRequest(*, indexId: str, items: List[EmbeddedItem] = None, value: str = None, fileId: str = None, blockType: str = None, externalId: str = None, externalType: str = None, metadata: Any = None, reindex: bool = True)[source]#

Bases: Request

block_type: str#
external_id: str#
external_type: str#
file_id: str#
index_id: str#
items: List[EmbeddedItem]#
metadata: Any#
reindex: bool#
value: str#
class steamship.data.embeddings.IndexInsertResponse(*, itemIds: List[IndexItemId] = None)[source]#

Bases: Response

item_ids: List[IndexItemId]#
class steamship.data.embeddings.IndexItemId(*, indexId: str = None, id: str = None)[source]#

Bases: CamelModel

id: str#
index_id: str#
class steamship.data.embeddings.IndexSearchRequest(*, id: str, query: str = None, queries: List[str] = None, k: int = 1, includeMetadata: bool = False)[source]#

Bases: Request

id: str#
include_metadata: bool#
k: int#
queries: List[str]#
query: str#
class steamship.data.embeddings.ListItemsRequest(*, pageSize: int | None = None, pageToken: str | None = None, sortOrder: SortOrder | None = SortOrder.DESC, id: str = None, fileId: str = None, blockId: str = None, spanId: str = None)[source]#

Bases: ListRequest

block_id: str#
file_id: str#
id: str#
span_id: str#
class steamship.data.embeddings.ListItemsResponse(*, nextPageToken: str | None = None, items: List[EmbeddedItem])[source]#

Bases: ListResponse

items: List[EmbeddedItem]#
class steamship.data.embeddings.QueryResult(*, value: Hit | None = None, score: float | None = None, index: int | None = None, id: str | None = None)[source]#

Bases: CamelModel

id: str | None#
index: int | None#
score: float | None#
value: Hit | None#
class steamship.data.embeddings.QueryResults(*, items: List[QueryResult] = None)[source]#

Bases: Request

items: List[QueryResult]#

steamship.data.file module#

class steamship.data.file.File(*, client: Client = None, id: str = None, handle: str = None, mimeType: MimeTypes = None, workspaceId: str = None, blocks: List[Block] = [], tags: List[Tag] = [], filename: str = None, publicData: bool = False)[source]#

Bases: CamelModel

A file.

class CreateResponse(data: Any = None, string: str = None, _bytes: bytes | io.BytesIO = None, json: io.BytesIO = None, mime_type: str = None)[source]#

Bases: Response

data_: Any#
mime_type: str#
classmethod parse_obj(obj: Any) Response[source]#
append_block(text: str = None, tags: List[Tag] = None, content: str | bytes = None, url: str | None = None, mime_type: MimeTypes | None = None, public_data: bool = False) Block[source]#

Append a new block to this File. This is a convenience wrapper around Block.create(). You should provide only one of text, content, or url.

This is a server-side operation, saving the new Block to the file. The new block is appended to this client-side File as well for convenience.

blockify(plugin_instance: str = None, wait_on_tasks: List[Task] = None) Task[source]#
blocks: List[Block]#
client: Client#
static create(client: Client, content: str | bytes = None, mime_type: MimeTypes = None, handle: str = None, blocks: List[Block] = None, tags: List[Tag] = None, public_data: bool = False) File[source]#
static create_with_plugin(client: Client, plugin_instance: str, url: str = None, mime_type: str = None) Task[File][source]#
delete() File[source]#
filename: str#
static from_local(client: Client, file_path: str, mime_type: MimeTypes = None, handle: str = None, tags: List[Tag] = None, public_data: bool = False) Any[source]#

Loads a local file into a Steamship File.

NOTE: the file_path should be relative to where the call to from_local is happening.

Loaded files will automatically be tagged with a provenance tag.

Parameters:
  • client – Steamship client for the workspace

  • file_path – Location of the file to upload relative to the current directory of the client

  • mime_type – Optional specification of a particular mime type. If not provided, a guess will be made.

  • handle – Intended handle (for lookups, etc.) for Steamship File

  • tags – Metadata to add to the Steamship File

  • public_data – Whether to make the Steamship File publicly-accessible

generate(plugin_instance_handle: str, start_block_index: int = None, end_block_index: int | None = None, block_index_list: List[int] | None = None, append_output_to_file: bool = True, options: dict | None = None, wait_on_tasks: List[Task] = None, make_output_public: bool = False, streaming: bool | None = False) Task[GenerateResponse][source]#

Generate new content from this file. Assumes this file as context for input and output. May specify start and end blocks.

static get(client: Client, _id: str = None, handle: str = None) File[source]#
handle: str#
id: str#
import_with_plugin(plugin_instance: str, url: str = None, mime_type: str = None) Task[File][source]#

Run an import operation on an (empty) file object that has already been created.

index(plugin_instance: Any = None) EmbeddingIndex[source]#

Index every block in the file.

TODO(ted): Enable indexing the results of a tag query. TODO(ted): It’s hard to load the EmbeddingIndexPluginInstance with just a handle because of the chain of things that need to be created to it to function.

static list(client: Client, page_size: int | None = None, page_token: str | None = None, sort_order: SortOrder | None = SortOrder.DESC) ListFileResponse[source]#
mime_type: MimeTypes#
classmethod parse_obj(obj: Any) BaseModel[source]#
public_data: bool#
static query(client: Client, tag_filter_query: str) FileQueryResponse[source]#
raw()[source]#
property raw_data_url: str | None#

Return a URL at which the data content of this File can be accessed. If public_data is True, this content can be accessed without an API key.

refresh() File[source]#
set_public_data(public_data: bool)[source]#

Set the public_data flag on this File. If this object already exists server-side, update the flag.

tag(plugin_instance: str = None, wait_on_tasks: List[Task] = None) Task[TagResponse][source]#
tags: List[Tag]#
workspace_id: str#
class steamship.data.file.FileClearResponse(*, id: str)[source]#

Bases: Response

id: str#
class steamship.data.file.FileQueryRequest(*, tagFilterQuery: str)[source]#

Bases: Request

tag_filter_query: str#
class steamship.data.file.FileQueryResponse(*, files: List[File])[source]#

Bases: Response

files: List[File]#
class steamship.data.file.FileUploadType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

BLOCKS = 'blocks'#
FILE = 'file'#
FILE_IMPORTER = 'fileImporter'#
NONE = 'none'#
class steamship.data.file.ListFileRequest(*, pageSize: int | None = None, pageToken: str | None = None, sortOrder: SortOrder | None = SortOrder.DESC)[source]#

Bases: ListRequest

class steamship.data.file.ListFileResponse(*, nextPageToken: str | None = None, files: List[File])[source]#

Bases: ListResponse

files: List[File]#

steamship.data.invocable_init_status module#

class steamship.data.invocable_init_status.InvocableInitStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

COMPLETE = 'complete'#
FAILED = 'failed'#
INITIALIZING = 'initializing'#
NOT_NEEDED = 'notNeeded'#

steamship.data.manifest module#

class steamship.data.manifest.ConfigParameter(*, type: ConfigParameterType, description: str | None = None, default: StrictStr | StrictBool | StrictFloat | StrictInt | None = None)[source]#

Bases: BaseModel

default: StrictStr | StrictBool | StrictFloat | StrictInt | None#
description: str | None#
type: ConfigParameterType#
class steamship.data.manifest.ConfigParameterType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

BOOLEAN = 'boolean'#
NUMBER = 'number'#
STRING = 'string'#
static from_python_type(t: Type)[source]#
class steamship.data.manifest.DeployableType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

PACKAGE = 'package'#
PLUGIN = 'plugin'#
class steamship.data.manifest.Manifest(*, type: DeployableType, handle: str, version: str, description: str | None = None, author: str | None = None, entrypoint: str = 'Unused', public: bool, plugin: PluginConfig | None = None, build_config: Dict[str, List[str]] = {'ignore': []}, configTemplate: Dict[str, ConfigParameter] | None = None, steamshipRegistry: SteamshipRegistry)[source]#

Bases: BaseModel

author: str | None#
build_config: Dict[str, List[str]]#
configTemplate: Dict[str, ConfigParameter] | None#
config_template_as_dict()[source]#
description: str | None#
entrypoint: str#
handle: str#
static load_manifest() Manifest[source]#
plugin: PluginConfig | None#
public: bool#
save()[source]#
steamshipRegistry: SteamshipRegistry#
type: DeployableType#
version: str#
class steamship.data.manifest.PluginConfig(*, isTrainable: bool | None = False, transport: str = 'jsonOverHttp', type: str, streaming: bool = False)[source]#

Bases: BaseModel

isTrainable: bool | None#
streaming: bool#
transport: str#
type: str#
class steamship.data.manifest.SteamshipRegistry(*, tagline: str | None = None, tagline2: str | None = None, usefulFor: str | None = None, videoUrl: str | None = None, githubUrl: str | None = None, demoUrl: str | None = None, blogUrl: str | None = None, jupyterUrl: str | None = None, authorGithub: str | None = None, authorName: str | None = None, authorEmail: str | None = None, authorTwitter: str | None = None, authorUrl: str | None = None, tags: List[str])[source]#

Bases: BaseModel

authorEmail: str | None#
authorGithub: str | None#
authorName: str | None#
authorTwitter: str | None#
authorUrl: str | None#
blogUrl: str | None#
demoUrl: str | None#
githubUrl: str | None#
jupyterUrl: str | None#
tagline: str | None#
tagline2: str | None#
tags: List[str]#
usefulFor: str | None#
videoUrl: str | None#

steamship.data.search module#

class steamship.data.search.Hit(*, id: str = None, index: int = None, indexSource: str = None, value: str = None, score: float = None, externalId: str = None, externalType: str = None, metadata: Any = None, query: str = None)[source]#

Bases: CamelModel

external_id: str#
external_type: str#
id: str#
index: int#
index_source: str#
metadata: Any#
query: str#
score: float#
value: str#

steamship.data.user module#

class steamship.data.user.User(*, client: Client = None, id: str = None, handle: str = None)[source]#

Bases: CamelModel

client: Client#
static current(client: Client) User[source]#
handle: str#
id: str#
classmethod parse_obj(obj: Any) BaseModel[source]#

steamship.data.workspace module#

class steamship.data.workspace.ListWorkspacesRequest(*, pageSize: int | None = None, pageToken: str | None = None, sortOrder: SortOrder | None = SortOrder.DESC)[source]#

Bases: ListRequest

class steamship.data.workspace.ListWorkspacesResponse(*, nextPageToken: str | None = None, workspaces: List[Workspace])[source]#

Bases: ListResponse

workspaces: List[Workspace]#
class steamship.data.workspace.SignedUrl[source]#

Bases: object

class Bucket(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

APP_DATA = 'appData'#
EXPORTS = 'exports'#
IMPORTS = 'imports'#
PLUGIN_DATA = 'pluginData'#
USER_DATA = 'userData'#
class Operation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

READ = 'Read'#
WRITE = 'Write'#
class Request(*, bucket: SignedUrl.Bucket, filepath: str, operation: SignedUrl.Operation, expiresInMinutes: int = None)[source]#

Bases: Request

bucket: Bucket#
expires_in_minutes: int#
filepath: str#
operation: Operation#
class Response(*, bucket: str = None, filepath: str = None, operation: str = None, expiresInMinutes: int = None, signedUrl: str = None)[source]#

Bases: Response

bucket: str#
expires_in_minutes: int#
filepath: str#
operation: str#
signed_url: str#
class steamship.data.workspace.Workspace(*, client: Client = None, id: str = None, handle: str = None)[source]#

Bases: CamelModel

class CreateRequest(*, id: str | None = None, handle: str | None = None, fetchIfExists: bool | None = None, externalId: str | None = None, externalType: str | None = None, metadata: str | None = None)[source]#

Bases: Request

external_id: str | None#
external_type: str | None#
fetch_if_exists: bool | None#
handle: str | None#
id: str | None#
metadata: str | None#
client: Client#
static create(client: Client, handle: str | None = None, external_id: str | None = None, external_type: str | None = None, metadata: Any = None, fetch_if_exists: bool = True) Workspace[source]#
create_signed_url(request: Request) Response[source]#
delete() Workspace[source]#
static get(client: Client, id_: str = None, handle: str = None, fetch_if_exists: bool = None) Workspace[source]#
handle: str#
id: str#
static list(client: Client, t: str = None, page_size: int | None = None, page_token: str | None = None, sort_order: SortOrder | None = SortOrder.DESC) ListWorkspacesResponse[source]#
classmethod parse_obj(obj: Any) BaseModel[source]#

Module contents#

class steamship.data.Block(*, client: Client = None, id: str = None, fileId: str = None, text: str = None, tags: List[Tag] | None = [], index: int | None = None, mimeType: MimeTypes | None = None, publicData: bool = False, streamState: StreamState | None = None, requestId: str | None = None, url: str | None = None, contentURL: str | None = None, uploadType: BlockUploadType | None = None, uploadBytes: bytes | None = None)[source]#

Bases: CamelModel

A Block is a chunk of content within a File. It can be plain text content, image content, video content, etc. If the content is not text, the text value may be the empty string for backwards compatibility.

class ListRequest(*, fileId: str = None)[source]#

Bases: Request

file_id: str#
class ListResponse(*, blocks: List[Block] = [])[source]#

Bases: Response

blocks: List[Block]#
abort_stream()[source]#
append_stream(bytes: bytes)[source]#
as_llm_input(exclude_block_wrapper: bool | None = False) str[source]#
property chat_id: str#
property chat_role: RoleTag | None#
client: Client#
content_url: str | None#
static create(client: Client, file_id: str, text: str = None, tags: List[Tag] = None, content: str | bytes = None, url: str | None = None, mime_type: MimeTypes | None = None, public_data: bool = False, streaming: bool | None = None) Block[source]#

Create a new Block within a File specified by file_id.

You can create a Block in several ways: - Providing raw text as the text parameter; - Providing the content of the block as string or bytes; - Providing a publicly accessible URL where the content is stored.

delete() Block[source]#
file_id: str#
finish_stream()[source]#
static get(client: Client, _id: str = None) Block[source]#
id: str#
index(embedding_plugin_instance: Any = None)[source]#

Index this block.

index_in_file: int | None#
is_audio()[source]#

Return whether this is an audio Block.

is_image()[source]#

Return whether this is an image Block.

is_steamship_internal()[source]#
is_text() bool[source]#

Return whether this is a text Block.

is_video()[source]#

Return whether this is a video Block.

property message_id: str#
mime_type: MimeTypes | None#
classmethod parse_obj(obj: Any) BaseModel[source]#
public_data: bool#
static query(client: Client, tag_filter_query: str) BlockQueryResponse[source]#
raw()[source]#
property raw_data_url: str | None#

Return a URL at which the data content of this Block can be accessed. If public_data is True, this content can be accessed without an API key.

request_id: str | None#

The Steamship request ID associated with the creation of this block.

set_chat_id(chat_id: str)[source]#
set_chat_role(role: RoleTag)[source]#
set_message_id(message_id: str)[source]#
set_public_data(public_data: bool)[source]#

Set the public_data flag on this Block. If this object already exists server-side, update the flag.

set_request_id(request_id: str | None)[source]#
set_thread_id(thread_id: str) None[source]#
set_user_id(user_id: str) None[source]#
stream_state: StreamState | None#
tags: List[Tag] | None#
text: str#
property thread_id: str | None#
to_public_url() str[source]#

Return a public URL to access the Block’s data.

upload_bytes: bytes | None#
upload_type: BlockUploadType | None#
url: str | None#
property user_id: str | None#
class steamship.data.DocTag(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

A set of name constants for Tags with a kind of TagKind.doc; appropriate for HTML and Markdown ideas.

ARTICLE = 'article'#
BLOCK_CODE = 'block-code'#
BLOCK_QUOTE = 'block-quote'#
CAPTION = 'caption'#
CHAPTER = 'chapter'#
CHAT = 'chat'#
DIV = 'div'#
DOCUMENT = 'document'#
EMPHASIZED = 'emphasized'#
FOOTER = 'footer'#
H1 = 'h1'#
H2 = 'h2'#
H3 = 'h3'#
H4 = 'h4'#
H5 = 'h5'#
HEADER = 'header'#
IMAGE = 'image'#
LINE = 'line'#
LIST_ITEM = 'list-item'#
MAIN = 'main'#
METADATA = 'metadata'#
ORDERED_LIST = 'ordered-list'#
PAGE = 'page'#
PARAGRAPH = 'paragraph'#
PRE = 'pre'#
REGION = 'region'#
SENTENCE = 'sentence'#
SOURCE = 'source'#
SPAN = 'span'#
STRONG = 'strong'#
SUBTITLE = 'subtitle'#
TELETYPE = 'teletype'#
TEXT = 'text'#
TITLE = 'title'#
TOKEN = 'token'#
UNDERLINED = 'underlined'#
UNKNOWN = 'unknown'#
UNORDERED_LIST = 'unordered-list'#
static from_html_tag(tagname: str | None) DocTag | None[source]#
class steamship.data.EmbeddingIndex(*, client: Client = None, id: str = None, handle: str = None, name: str = None, plugin: str = None, externalId: str = None, externalType: str = None, metadata: str = None)[source]#

Bases: CamelModel

A persistent, read-optimized index over embeddings.

client: Client#
static create(client: Client, handle: str = None, name: str = None, embedder_plugin_instance_handle: str = None, fetch_if_exists: bool = True, external_id: str = None, external_type: str = None, metadata: Any = None) EmbeddingIndex[source]#
delete() EmbeddingIndex[source]#
embed() Task[IndexEmbedResponse][source]#
external_id: str#
external_type: str#
handle: str#
id: str#
insert(value: str, external_id: str = None, external_type: str = None, metadata: int | float | bool | str | List | Dict = None, reindex: bool = True, allow_long_records=False) IndexInsertResponse[source]#
insert_file(file_id: str, block_type: str = None, external_id: str = None, external_type: str = None, metadata: int | float | bool | str | List | Dict = None, reindex: bool = True) IndexInsertResponse[source]#
insert_many(items: List[EmbeddedItem | str], reindex: bool = True, allow_long_records=False) IndexInsertResponse[source]#
list_items(file_id: str = None, block_id: str = None, span_id: str = None, page_size: int | None = None, page_token: str | None = None, sort_order: SortOrder | None = SortOrder.DESC) ListItemsResponse[source]#
metadata: str#
name: str#
classmethod parse_obj(obj: Any) BaseModel[source]#
plugin: str#
search(query: str | List[str], k: int = 1, include_metadata: bool = False) Task[QueryResults][source]#
class steamship.data.File(*, client: Client = None, id: str = None, handle: str = None, mimeType: MimeTypes = None, workspaceId: str = None, blocks: List[Block] = [], tags: List[Tag] = [], filename: str = None, publicData: bool = False)[source]#

Bases: CamelModel

A file.

class CreateResponse(data: Any = None, string: str = None, _bytes: bytes | io.BytesIO = None, json: io.BytesIO = None, mime_type: str = None)[source]#

Bases: Response

data_: Any#
mime_type: str#
classmethod parse_obj(obj: Any) Response[source]#
append_block(text: str = None, tags: List[Tag] = None, content: str | bytes = None, url: str | None = None, mime_type: MimeTypes | None = None, public_data: bool = False) Block[source]#

Append a new block to this File. This is a convenience wrapper around Block.create(). You should provide only one of text, content, or url.

This is a server-side operation, saving the new Block to the file. The new block is appended to this client-side File as well for convenience.

blockify(plugin_instance: str = None, wait_on_tasks: List[Task] = None) Task[source]#
blocks: List[Block]#
client: Client#
static create(client: Client, content: str | bytes = None, mime_type: MimeTypes = None, handle: str = None, blocks: List[Block] = None, tags: List[Tag] = None, public_data: bool = False) File[source]#
static create_with_plugin(client: Client, plugin_instance: str, url: str = None, mime_type: str = None) Task[File][source]#
delete() File[source]#
filename: str#
static from_local(client: Client, file_path: str, mime_type: MimeTypes = None, handle: str = None, tags: List[Tag] = None, public_data: bool = False) Any[source]#

Loads a local file into a Steamship File.

NOTE: the file_path should be relative to where the call to from_local is happening.

Loaded files will automatically be tagged with a provenance tag.

Parameters:
  • client – Steamship client for the workspace

  • file_path – Location of the file to upload relative to the current directory of the client

  • mime_type – Optional specification of a particular mime type. If not provided, a guess will be made.

  • handle – Intended handle (for lookups, etc.) for Steamship File

  • tags – Metadata to add to the Steamship File

  • public_data – Whether to make the Steamship File publicly-accessible

generate(plugin_instance_handle: str, start_block_index: int = None, end_block_index: int | None = None, block_index_list: List[int] | None = None, append_output_to_file: bool = True, options: dict | None = None, wait_on_tasks: List[Task] = None, make_output_public: bool = False, streaming: bool | None = False) Task[GenerateResponse][source]#

Generate new content from this file. Assumes this file as context for input and output. May specify start and end blocks.

static get(client: Client, _id: str = None, handle: str = None) File[source]#
handle: str#
id: str#
import_with_plugin(plugin_instance: str, url: str = None, mime_type: str = None) Task[File][source]#

Run an import operation on an (empty) file object that has already been created.

index(plugin_instance: Any = None) EmbeddingIndex[source]#

Index every block in the file.

TODO(ted): Enable indexing the results of a tag query. TODO(ted): It’s hard to load the EmbeddingIndexPluginInstance with just a handle because of the chain of things that need to be created to it to function.

static list(client: Client, page_size: int | None = None, page_token: str | None = None, sort_order: SortOrder | None = SortOrder.DESC) ListFileResponse[source]#
mime_type: MimeTypes#
classmethod parse_obj(obj: Any) BaseModel[source]#
public_data: bool#
static query(client: Client, tag_filter_query: str) FileQueryResponse[source]#
raw()[source]#
property raw_data_url: str | None#

Return a URL at which the data content of this File can be accessed. If public_data is True, this content can be accessed without an API key.

refresh() File[source]#
set_public_data(public_data: bool)[source]#

Set the public_data flag on this File. If this object already exists server-side, update the flag.

tag(plugin_instance: str = None, wait_on_tasks: List[Task] = None) Task[TagResponse][source]#
tags: List[Tag]#
workspace_id: str#
class steamship.data.GenerationTag(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

A set of name constants for Tags with a kind of TagKind.generation.

GIST = 'gist'#
HEADLINE = 'headline'#
PROMPT_COMPLETION = 'prompt-completion'#
SUMMARY = 'summary'#
class steamship.data.Package(*, client: Client = None, id: str = None, handle: str = None, userId: str = None, profile: Manifest | None = None, description: str | None = None, readme: str | None = None, isPublic: bool = False)[source]#

Bases: CamelModel

client: Client#
static create(client: Client, handle: str = None, profile: Manifest = None, is_public=False, fetch_if_exists=False) Package[source]#
delete() Package[source]#

Delete this package. If this package is public and another user has created an instance of it, this method will throw an error and the package will not be deleted. Deleting the package will delete any versions and instances of it that you have created.

description: str | None#
static get(client: Client, handle: str) Package[source]#
handle: str#
id: str#
is_public: bool#
classmethod parse_obj(obj: Any) BaseModel[source]#
profile: Manifest | None#
readme: str | None#
update(client: Client) Package[source]#
user_id: str#
class steamship.data.PackageInstance(*, client: Client = None, id: str = None, handle: str = None, packageId: str = None, packageHandle: str | None = None, userHandle: str = None, packageVersionId: str = None, packageVersionHandle: str | None = None, userId: str = None, invocationURL: str = None, config: Dict[str, Any] = None, workspaceId: str = None, workspaceHandle: str = None, initStatus: InvocableInitStatus | None = None, createdAt: datetime | None = None)[source]#

Bases: CamelModel

blocks_from_invoke(path: str, verb: Verb = Verb.POST, timeout_s: float | None = None, **kwargs) List[Block][source]#
client: Client#
config: Dict[str, Any]#
static create(client: Client, package_id: str = None, package_handle: str = None, package_version_id: str = None, package_version_handle: str = None, handle: str = None, fetch_if_exists: bool = None, config: Dict[str, Any] = None) PackageInstance[source]#
static create_local_development_instance(client: Client, local_development_url: str, package_id: str = None, package_handle: str = None, handle: str = None, fetch_if_exists: bool = True, config: Dict[str, Any] = None) PackageInstance[source]#
created_at: datetime | None#
delete() PackageInstance[source]#
full_url_for(path: str)[source]#
static get(client: Client, handle: str) PackageInstance[source]#
handle: str#
id: str#
init_status: InvocableInitStatus | None#
invocation_url: str#
invoke(path: str, verb: Verb = Verb.POST, timeout_s: float | None = None, **kwargs)[source]#
static list(client: Client, package_id: str | None = None, package_version_id: str | None = None, include_workspace: bool | None = None, across_workspaces: bool | None = None, page_size: int | None = None, page_token: str | None = None, sort_order: SortOrder | None = SortOrder.DESC) ListPackageInstancesResponse[source]#
load_missing_workspace_handle()[source]#
package_handle: str | None#
package_id: str#
package_version_handle: str | None#
package_version_id: str#
classmethod parse_obj(obj: Any) BaseModel[source]#
refresh_init_status()[source]#
task_from_invoke(path: str, verb: Verb = Verb.POST, timeout_s: float | None = None, **kwargs) Task[source]#
user_handle: str#
user_id: str#
wait_for_init(max_timeout_s: float = 180, retry_delay_s: float = 1)[source]#

Polls and blocks until the init has succeeded or failed (or timeout reached).

Parameters:
  • max_timeout_s (int) – Max timeout in seconds. Default: 180s. After this timeout, an exception will be thrown.

  • retry_delay_s (float) – Delay between status checks. Default: 1s.

workspace_handle: str#
workspace_id: str#
class steamship.data.PackageVersion(*, client: Client = None, id: str = None, packageId: str = None, handle: str = None, configTemplate: Dict[str, Any] = None)[source]#

Bases: CamelModel

client: Client#
config_template: Dict[str, Any]#
static create(client: Client, package_id: str | None = None, handle: str | None = None, filename: str | None = None, filebytes: bytes | None = None, config_template: Dict[str, Any] | None = None, hosting_handler: str | None = None) PackageVersion[source]#
delete() PackageVersion[source]#

Delete this package version. If this package is public and another user has created an instance of this version, this method will throw an error and the PackageVersion will not be deleted. Deleting the PackageVersion will delete any instances of it that you have created.

handle: str#
id: str#
package_id: str#
classmethod parse_obj(obj: Any) BaseModel[source]#
class steamship.data.Plugin(*, client: Client = None, id: str = None, type: str = None, transport: str = None, isPublic: bool = None, trainingPlatform: HostingType | None = None, handle: str = None, description: str = None, metadata: str = None, profile: Manifest | None = None, readme: str | None = None, userId: str | None = None)[source]#

Bases: CamelModel

client: Client#
static create(client: Client, description: str, type_: str, transport: str, is_public: bool, handle: str = None, training_platform: HostingType | None = None, metadata: str | Dict | List = None, fetch_if_exists: bool = False) Plugin[source]#
delete() Plugin[source]#

Delete this plugin. If this plugin is public and another user has created an instance of it, this method will throw an error and the plugin will not be deleted. Deleting the plugin will delete any versions and instances of it that you have created.

description: str#
static get(client: Client, handle: str)[source]#
handle: str#
id: str#
is_public: bool#
static list(client: Client, t: str = None, page_size: int | None = None, page_token: str | None = None, sort_order: SortOrder | None = SortOrder.DESC) ListPluginsResponse[source]#
metadata: str#
classmethod parse_obj(obj: Any) BaseModel[source]#
profile: Manifest | None#
readme: str | None#
training_platform: HostingType | None#
transport: str#
type: str#
update(client: Client) Plugin[source]#
user_id: str | None#
class steamship.data.PluginInstance(*, client: Client = None, id: str = None, handle: str = None, pluginId: str = None, pluginVersionId: str = None, pluginHandle: str | None = None, pluginVersionHandle: str | None = None, workspaceId: str | None = None, userId: str = None, config: Dict[str, Any] = None, hostingType: HostingType | None = None, hostingCpu: HostingCpu | None = None, hostingMemory: HostingMemory | None = None, hostingTimeout: HostingTimeout | None = None, hostingEnvironment: HostingEnvironment | None = None, initStatus: InvocableInitStatus | None = None)[source]#

Bases: CamelModel

client: Client#
config: Dict[str, Any]#
static create(client: Client, plugin_id: str = None, plugin_handle: str = None, plugin_version_id: str = None, plugin_version_handle: str = None, handle: str = None, fetch_if_exists: bool = True, config: Dict[str, Any] = None) PluginInstance[source]#

Create a plugin instance

When handle is empty the engine will automatically assign one fetch_if_exists controls whether we want to re-use an existing plugin instance or not.

delete() PluginInstance[source]#
generate(input_file_id: str = None, input_file_start_block_index: int = None, input_file_end_block_index: int | None = None, input_file_block_index_list: List[int] | None = None, text: str | None = None, block_query: str | None = None, append_output_to_file: bool = False, output_file_id: str | None = None, make_output_public: bool | None = None, options: dict | None = None, streaming: bool | None = None, tags: List[Tag] | None = None) Task[GenerateResponse][source]#

See GenerateRequest for description of parameter options

static get(client: Client, handle: str) PluginInstance[source]#
get_training_parameters(training_request: TrainingParameterPluginInput) TrainingParameterPluginOutput[source]#
handle: str#
hosting_cpu: HostingCpu | None#
hosting_environment: HostingEnvironment | None#
hosting_memory: HostingMemory | None#
hosting_timeout: HostingTimeout | None#
hosting_type: HostingType | None#
id: str#
init_status: InvocableInitStatus | None#
classmethod parse_obj(obj: Any) BaseModel[source]#
plugin_handle: str | None#
plugin_id: str#
plugin_version_handle: str | None#
plugin_version_id: str#
refresh_init_status()[source]#
tag(doc: str | File) Task[TagResponse][source]#
train(training_request: TrainingParameterPluginInput = None, training_epochs: int | None = None, export_query: str | None = None, testing_holdout_percent: float | None = None, test_split_seed: int | None = None, training_params: Dict | None = None, inference_params: Dict | None = None) Task[TrainPluginOutput][source]#

Train a plugin instance. Please provide either training_request OR the other parameters; passing training_request ignores all other parameters, but is kept for backwards compatibility.

user_id: str#
wait_for_init(max_timeout_s: float = 180, retry_delay_s: float = 1)[source]#

Polls and blocks until the init has succeeded or failed (or timeout reached).

Parameters:
  • max_timeout_s (int) – Max timeout in seconds. Default: 180s. After this timeout, an exception will be thrown.

  • retry_delay_s (float) – Delay between status checks. Default: 1s.

workspace_id: str | None#
class steamship.data.PluginVersion(*, client: Client = None, id: str = None, pluginId: str = None, handle: str = None, hostingMemory: HostingMemory | None = None, hostingTimeout: HostingTimeout | None = None, hostingHandler: str = None, isPublic: bool = None, isDefault: bool = None, configTemplate: Dict[str, Any] = None)[source]#

Bases: CamelModel

client: Client#
config_template: Dict[str, Any]#
static create(client: Client, handle: str, plugin_id: str | None = None, filename: str | None = None, filebytes: bytes | None = None, hosting_memory: HostingMemory | None = None, hosting_timeout: HostingTimeout | None = None, hosting_handler: str | None = None, is_public: bool | None = None, is_default: bool | None = None, config_template: Dict[str, Any] | None = None, streaming: bool | None = None) PluginVersion[source]#
delete() PluginVersion[source]#

Delete this plugin version. If this plugin is public and another user has created an instance of this version, this method will throw an error and the PluginVersion will not be deleted. Deleting the PluginVersion will delete any instances of it that you have created.

handle: str#
hosting_handler: str#
hosting_memory: HostingMemory | None#
hosting_timeout: HostingTimeout | None#
id: str#
is_default: bool#
is_public: bool#
static list(client: Client, plugin_id: str = None, handle: str = None, public: bool = True) ListPluginVersionsResponse[source]#
classmethod parse_obj(obj: Any) BaseModel[source]#
plugin_id: str#
class steamship.data.Tag(*, client: Client = None, id: str = None, fileId: str = None, blockId: str | None = None, kind: TagKind | str = None, name: str | None = None, value: Dict[TagValueKey | str, Any] | None = None, startIdx: int | None = None, endIdx: int | None = None, text: str | None = None)[source]#

Bases: CamelModel

class DeleteRequest(*, id: str = None, fileId: str = None, blockId: str = None)[source]#

Bases: Request

block_id: str#
file_id: str#
id: str#
class ListRequest(*, fileId: str = None, blockId: str = None)[source]#

Bases: Request

block_id: str#
file_id: str#
class ListResponse(*, tags: List[Tag] = None)[source]#

Bases: Response

tags: List[Tag]#
block_id: str | None#
client: Client#
static create(client: Client, file_id: str = None, block_id: str = None, kind: str = None, name: str = None, start_idx: int = None, end_idx: int = None, value: Dict[str, Any] = None) Tag[source]#
delete() Tag[source]#
end_idx: int | None#
file_id: str#
id: str#
index(plugin_instance: Any = None)[source]#

Index this tag.

kind: TagKind | str#
name: str | None#
classmethod parse_obj(obj: Any) BaseModel[source]#
static query(client: Client, tag_filter_query: str) TagQueryResponse[source]#
start_idx: int | None#
text: str | None#
value: Dict[TagValueKey | str, Any] | None#
class steamship.data.TagKind(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

A set of kind constants for Tags.

These define broad categories of tags. Suggested name values for each category are found in separate enums. For example: kind=TagKind.DOCUMENT, name=DocTag.H1

AGENT_STATUS_MESSAGE = 'agent-status-message'#
CHAT = 'chat'#
CHAT_HISTORY_CONTEXT = 'chat-history-context'#
DEPENDENCY = 'dependency'#
DOCUMENT = 'document'#
EMBEDDING = 'embedding'#
EMOTION = 'emotion'#
ENTITY = 'entity'#
FUNCTION_ARG = 'function-arg'#
FUNCTION_SELECTION = 'function-selection'#
GENERATION = 'generation'#
INTENT = 'intent'#
KIND = 'summary'#
LLM_STATUS_MESSAGE = 'llm-status-message'#
MESSAGE_ID = 'message-id'#
PART_OF_SPEECH = 'part-of-speech'#
PROVENANCE = 'provenance'#
ROLE = 'role'#
SEARCH_RESULT = 'search-result'#
SENTIMENT = 'sentiment'#
STATUS_MESSAGE = 'status-message'#
SUMMARY = 'summary'#
TIMESTAMP = 'timestamp'#
TOKEN = 'token'#
TOKENIZATION = 'tokenization'#
TOOL_STATUS_MESSAGE = 'tool-status-message'#
TOPIC = 'topic'#
class steamship.data.TagValueKey(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

A set of key constants for the value object within a tag.

BOOL_VALUE = 'bool-value'#