openfloor.manifest¶

class openfloor.manifest.Capability(keyphrases, descriptions, languages=None, supportedLayers=None)[source]¶

Bases: JsonSerializableDataclass

Represents a single capability in the capabilities array

descriptions: List[str]¶

classmethod from_dict(data)[source]¶

Create a Capability instance from a dictionary

Return type:: Capability

keyphrases: List[str]¶

languages: Optional[List[str]] = None¶

supportedLayers: Optional[SupportedLayers] = None¶

class openfloor.manifest.Identification(speakerUri, serviceUrl, organization=None, conversationalName=None, department=None, role=None, synopsis=None)[source]¶

Bases: JsonSerializableDataclass

Represents the identification section of a conversant

conversationalName: Optional[str] = None¶

department: Optional[str] = None¶

organization: Optional[str] = None¶

role: Optional[str] = None¶

serviceUrl: str¶

speakerUri: str¶

synopsis: Optional[str] = None¶

class openfloor.manifest.Manifest(identification, capabilities=<factory>)[source]¶

Bases: JsonSerializableDataclass

Represents an Assistant Manifest according to the specification

capabilities: List[Capability]¶

classmethod from_dict(data)[source]¶

Create a Manifest instance from a dictionary

Return type:: Manifest

identification: Identification¶

class openfloor.manifest.SupportedLayers(input=<factory>, output=<factory>)[source]¶

Bases: JsonSerializableDataclass

Represents the supported input and output layers for a capability

input: List[str]¶

output: List[str]¶