steamship.data.tags package#

Submodules#

steamship.data.tags.tag module#

class steamship.data.tags.tag.Tag(*, client: steamship.base.client.Client = None, id: str = None, fileId: str = None, blockId: Optional[str] = None, kind: str = None, name: Optional[str] = None, value: Optional[Dict[str, Any]] = None, startIdx: Optional[int] = None, endIdx: Optional[int] = None, text: Optional[str] = None)[source]#

Bases: steamship.base.model.CamelModel

class CreateRequest(*, id: str = None, fileId: str = None, blockId: str = None, kind: str = None, name: str = None, startIdx: int = None, endIdx: int = None, value: Dict[str, Any] = None)[source]#

Bases: steamship.base.request.Request

Request to create a new Tag.

block_id: str#
end_idx: int#
file_id: str#
id: str#
kind: str#
name: str#
start_idx: int#
value: Dict[str, Any]#
class DeleteRequest(*, id: str = None, fileId: str = None, blockId: str = None)[source]#

Bases: steamship.base.request.Request

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

Bases: steamship.base.request.Request

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

Bases: steamship.base.response.Response

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

Index this tag.

kind: str#
name: Optional[str]#
static query(client: steamship.base.client.Client, tag_filter_query: str) steamship.data.tags.tag.TagQueryResponse[source]#
start_idx: Optional[int]#
text: Optional[str]#
value: Optional[Dict[str, Any]]#
class steamship.data.tags.tag.TagQueryRequest(*, tagFilterQuery: str)[source]#

Bases: steamship.base.request.Request

tag_filter_query: str#
class steamship.data.tags.tag.TagQueryResponse(*, tags: List[steamship.data.tags.tag.Tag])[source]#

Bases: steamship.base.response.Response

tags: List[steamship.data.tags.tag.Tag]#

steamship.data.tags.tag_constants module#

class steamship.data.tags.tag_constants.DocTag(value)[source]#

Bases: str, enum.Enum

A set of name constants for 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'#
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'#
ORDERED_LIST = 'ordered-list'#
PAGE = 'page'#
PARAGRAPH = 'paragraph'#
PRE = 'pre'#
REGION = 'region'#
SENTENCE = 'sentence'#
SPAN = 'span'#
STRONG = 'strong'#
SUBTITLE = 'subtitle'#
TELETYPE = 'teletype'#
TITLE = 'title'#
TOKEN = 'token'#
UNDERLINED = 'underlined'#
UNKNOWN = 'unknown'#
UNORDERED_LIST = 'unordered-list'#
static from_html_tag(tagname: Optional[str]) Optional[steamship.data.tags.tag_constants.DocTag][source]#
class steamship.data.tags.tag_constants.EmotionTag(value)[source]#

Bases: str, enum.Enum

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

ANGER = 'anger'#
CONCERN = 'concern'#
FEAR = 'fear'#
HAPPINESS = 'happiness'#
HUMOR = 'humor'#
JOY = 'joy'#
LOVE = 'love'#
NEGATIVE = 'negative'#
NEUTRAL = 'neutral'#
POSITIVE = 'positive'#
SADNESS = 'sadness'#
SCORE = 'score'#
SERIOUSNESS = 'seriousness'#
SURPRISE = 'surprise'#
class steamship.data.tags.tag_constants.EntityTag(value)[source]#

Bases: str, enum.Enum

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

DATE = 'date'#
FACILITY = 'facility'#
GEO_POLITICAL_ENTITY = 'geo-political-entity'#
LOCATION = 'location'#
MONEY = 'money'#
ORGANIZATION = 'organization'#
PERCENT = 'percent'#
PERSON = 'person'#
PRODUCT = 'product'#
TIME = 'time'#
class steamship.data.tags.tag_constants.GenerationTag(value)[source]#

Bases: str, enum.Enum

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

PROMPT_COMPLETION = 'prompt-completion'#
SUMMARY = 'summary'#
class steamship.data.tags.tag_constants.IntentTag(value)[source]#

Bases: str, enum.Enum

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

ARE_YOU_THERE = 'are-you-there'#
COMPLAINT = 'complaint'#
EXPLANATION = 'explanation'#
PRAISE = 'praise'#
QUESTION = 'question'#
REQUEST = 'request'#
REVISITING_TOPIC = 'revisiting-topic'#
SALUTATION = 'salutation'#
SCHEDULING_REQUEST = 'scheduling-request'#
class steamship.data.tags.tag_constants.SentimentTag(value)[source]#

Bases: str, enum.Enum

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

NEGATIVE = 'negative'#
NEUTRAL = 'neutral'#
POSITIVE = 'positive'#
SCORE = 'score'#
class steamship.data.tags.tag_constants.TagKind(value)[source]#

Bases: str, enum.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=DocumentTag.H1

DEPENDENCY = 'dependency'#
DOCUMENT = 'document'#
EMBEDDING = 'embedding'#
EMOTION = 'emotion'#
ENTITY = 'entity'#
GENERATION = 'generation'#
INTENT = 'intent'#
PART_OF_SPEECH = 'part-of-speech'#
SENTIMENT = 'sentiment'#
TOKEN = 'token'#
class steamship.data.tags.tag_constants.TagValue(value)[source]#

Bases: str, enum.Enum

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

BOOL_VALUE = 'bool-value'#
NUMBER_VALUE = 'number-value'#
SCORE = 'score'#
STRING_VALUE = 'string-value'#
VECTOR_VALUE = 'vector-value'#
class steamship.data.tags.tag_constants.TokenTag(value)[source]#

Bases: str, enum.Enum

A set of name constants for Tags with a kind of TagKind.token; appropriate for parsing-level ideas.

ENTITY_IOB = 'entity-iob'#
ENTITY_TYPE = 'entity-type'#
HEAD = 'head'#
IS_ALPHA = 'is-alpha'#
IS_ASCII = 'is-ascii'#
IS_BRACKET = 'is-bracket'#
IS_CURRENCY = 'is-currency'#
IS_DIGIT = 'is-digit'#
IS_LEFT_PUNCT = 'is-left-punct'#
IS_OUT_OF_VOCABULARY = 'is-out-of-vocabulary'#
IS_PUNCT = 'is-punct'#
IS_QUOTE = 'is-quote'#
IS_RIGHT_PUNCT = 'is-right-punct'#
IS_SPACE = 'is-space'#
IS_STOPWORD = 'is-stopword'#
IS_TITLE = 'is-title'#
LANGUAGE = 'language'#
LEFT_EDGE = 'left-edge'#
LEMMA = 'lemma'#
LIKE_EMAIL = 'like-email'#
LIKE_NUM = 'like-num'#
LIKE_URL = 'like-url'#
NORMALIZED = 'normalized'#
PREFIX = 'prefix'#
RIGHT_EDGE = 'right-edge'#
SHAPE = 'shape'#
SUFFIX = 'suffix'#
TEXT_WITH_WHITESPACE = 'text-with-whitespace'#
WHITESPACE = 'whitespace'#

Module contents#

class steamship.data.tags.DocTag(value)[source]#

Bases: str, enum.Enum

A set of name constants for 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'#
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'#
ORDERED_LIST = 'ordered-list'#
PAGE = 'page'#
PARAGRAPH = 'paragraph'#
PRE = 'pre'#
REGION = 'region'#
SENTENCE = 'sentence'#
SPAN = 'span'#
STRONG = 'strong'#
SUBTITLE = 'subtitle'#
TELETYPE = 'teletype'#
TITLE = 'title'#
TOKEN = 'token'#
UNDERLINED = 'underlined'#
UNKNOWN = 'unknown'#
UNORDERED_LIST = 'unordered-list'#
static from_html_tag(tagname: Optional[str]) Optional[steamship.data.tags.tag_constants.DocTag][source]#
class steamship.data.tags.EmotionTag(value)[source]#

Bases: str, enum.Enum

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

ANGER = 'anger'#
CONCERN = 'concern'#
FEAR = 'fear'#
HAPPINESS = 'happiness'#
HUMOR = 'humor'#
JOY = 'joy'#
LOVE = 'love'#
NEGATIVE = 'negative'#
NEUTRAL = 'neutral'#
POSITIVE = 'positive'#
SADNESS = 'sadness'#
SCORE = 'score'#
SERIOUSNESS = 'seriousness'#
SURPRISE = 'surprise'#
class steamship.data.tags.EntityTag(value)[source]#

Bases: str, enum.Enum

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

DATE = 'date'#
FACILITY = 'facility'#
GEO_POLITICAL_ENTITY = 'geo-political-entity'#
LOCATION = 'location'#
MONEY = 'money'#
ORGANIZATION = 'organization'#
PERCENT = 'percent'#
PERSON = 'person'#
PRODUCT = 'product'#
TIME = 'time'#
class steamship.data.tags.GenerationTag(value)[source]#

Bases: str, enum.Enum

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

PROMPT_COMPLETION = 'prompt-completion'#
SUMMARY = 'summary'#
class steamship.data.tags.IntentTag(value)[source]#

Bases: str, enum.Enum

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

ARE_YOU_THERE = 'are-you-there'#
COMPLAINT = 'complaint'#
EXPLANATION = 'explanation'#
PRAISE = 'praise'#
QUESTION = 'question'#
REQUEST = 'request'#
REVISITING_TOPIC = 'revisiting-topic'#
SALUTATION = 'salutation'#
SCHEDULING_REQUEST = 'scheduling-request'#
class steamship.data.tags.SentimentTag(value)[source]#

Bases: str, enum.Enum

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

NEGATIVE = 'negative'#
NEUTRAL = 'neutral'#
POSITIVE = 'positive'#
SCORE = 'score'#
class steamship.data.tags.Tag(*, client: steamship.base.client.Client = None, id: str = None, fileId: str = None, blockId: Optional[str] = None, kind: str = None, name: Optional[str] = None, value: Optional[Dict[str, Any]] = None, startIdx: Optional[int] = None, endIdx: Optional[int] = None, text: Optional[str] = None)[source]#

Bases: steamship.base.model.CamelModel

class CreateRequest(*, id: str = None, fileId: str = None, blockId: str = None, kind: str = None, name: str = None, startIdx: int = None, endIdx: int = None, value: Dict[str, Any] = None)[source]#

Bases: steamship.base.request.Request

Request to create a new Tag.

block_id: str#
end_idx: int#
file_id: str#
id: str#
kind: str#
name: str#
start_idx: int#
value: Dict[str, Any]#
class DeleteRequest(*, id: str = None, fileId: str = None, blockId: str = None)[source]#

Bases: steamship.base.request.Request

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

Bases: steamship.base.request.Request

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

Bases: steamship.base.response.Response

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

Index this tag.

kind: str#
name: Optional[str]#
static query(client: steamship.base.client.Client, tag_filter_query: str) steamship.data.tags.tag.TagQueryResponse[source]#
start_idx: Optional[int]#
text: Optional[str]#
value: Optional[Dict[str, Any]]#
class steamship.data.tags.TagKind(value)[source]#

Bases: str, enum.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=DocumentTag.H1

DEPENDENCY = 'dependency'#
DOCUMENT = 'document'#
EMBEDDING = 'embedding'#
EMOTION = 'emotion'#
ENTITY = 'entity'#
GENERATION = 'generation'#
INTENT = 'intent'#
PART_OF_SPEECH = 'part-of-speech'#
SENTIMENT = 'sentiment'#
TOKEN = 'token'#
class steamship.data.tags.TagValue(value)[source]#

Bases: str, enum.Enum

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

BOOL_VALUE = 'bool-value'#
NUMBER_VALUE = 'number-value'#
SCORE = 'score'#
STRING_VALUE = 'string-value'#
VECTOR_VALUE = 'vector-value'#
class steamship.data.tags.TokenTag(value)[source]#

Bases: str, enum.Enum

A set of name constants for Tags with a kind of TagKind.token; appropriate for parsing-level ideas.

ENTITY_IOB = 'entity-iob'#
ENTITY_TYPE = 'entity-type'#
HEAD = 'head'#
IS_ALPHA = 'is-alpha'#
IS_ASCII = 'is-ascii'#
IS_BRACKET = 'is-bracket'#
IS_CURRENCY = 'is-currency'#
IS_DIGIT = 'is-digit'#
IS_LEFT_PUNCT = 'is-left-punct'#
IS_OUT_OF_VOCABULARY = 'is-out-of-vocabulary'#
IS_PUNCT = 'is-punct'#
IS_QUOTE = 'is-quote'#
IS_RIGHT_PUNCT = 'is-right-punct'#
IS_SPACE = 'is-space'#
IS_STOPWORD = 'is-stopword'#
IS_TITLE = 'is-title'#
LANGUAGE = 'language'#
LEFT_EDGE = 'left-edge'#
LEMMA = 'lemma'#
LIKE_EMAIL = 'like-email'#
LIKE_NUM = 'like-num'#
LIKE_URL = 'like-url'#
NORMALIZED = 'normalized'#
PREFIX = 'prefix'#
RIGHT_EDGE = 'right-edge'#
SHAPE = 'shape'#
SUFFIX = 'suffix'#
TEXT_WITH_WHITESPACE = 'text-with-whitespace'#
WHITESPACE = 'whitespace'#