Enums
Module: Inworld.AI. Namespace: Inworld.
These are the enums that used in Inworld Unity SDK.
File Reference
| Enum | Description | Values |
|---|---|---|
| InworldConnectionStatus | The connection status of the InworldClient. | Idle: Initial State Initializing: Used at getting runtime token. Initialized: Getting runtime Token Completed. Connecting: Start Session with Inworld Server by runtime token. Connected: Controller is connected to World-Engine and ready to work. Exhausted: Received when user is running out of quota. Error: Some error occured. |
| InworldMessage | The extra message sent by Inworld server. | None GoalEnable GoalDisable GoalComplete RelationUpdate ConversationNextTurn Error Critical GoAway IncompleteInteraction |
| ErrorType | The error type returned by Inworld Server. | UNDEFINED = -2 CLIENT_ERROR = -1 SESSION_TOKEN_EXPIRED = 0 SESSION_TOKEN_INVALID = 1: Session token is completely invalid. SESSION_RESOURCES_EXHAUSTED = 2: Session's resources are temporarily exhausted. BILLING_TOKENS_EXHAUSTED = 3: Billing tokens are exhausted -- client should buy more time or wait till end of billing period. ACCOUNT_DISABLED = 4: Developer account is completely disabled, either due to a ToS violation or for some other reason. SESSION_INVALID = 5: Session is invalid due to missing agents or some other reason. RESOURCE_NOT_FOUND = 6: Resource id is invalid or otherwise could not be found. SAFETY_VIOLATION = 7: Safety policies have been violated. |
| ReconnectionType | The instructions of how to reconnect received by Inworld server. | UNDEFINED = 0 NO_RETRY = 1: Client should not try to reconnect. IMMEDIATE = 2: Client can try to reconnect immediately TIMEOUT = 3: Client can try to reconnect after given period, specified in InworldStatus.reconnect_time. |
| FeedbackType | The type of the feedbacks. | INTERACTION_DISLIKE_TYPE_UNSPECIFIED = 0 INTERACTION_DISLIKE_TYPE_IRRELEVANT = 1: The content is irrelevant INTERACTION_DISLIKE_TYPE_UNSAFE = 2: The content is unsafe INTERACTION_DISLIKE_TYPE_UNTRUE = 3: The content is untrue. INTERACTION_DISLIKE_TYPE_INCORRECT_USE_KNOWLEDGE = 4: The content uses knowledge incorrectly. INTERACTION_DISLIKE_TYPE_UNEXPECTED_ACTION = 5: The content contains unexpected action. INTERACTION_DISLIKE_TYPE_UNEXPECTED_GOAL_BEHAVIOR = 6: The content contains unexpected goal behaviour INTERACTION_DISLIKE_TYPE_REPETITION = 7: The content contains repetition issue. |
| ControlType | The type of the ControlEvents. | UNKNOWN AUDIO_SESSION_START AUDIO_SESSION_END INTERACTION_END WARNING |
| SourceType | Determines the type of the source or the targets. | NONE AGENT PLAYER WORLD |
| PacketType | The type of the InworldPackets. | UNKNOWN TEXT CONTROL AUDIO GESTURE CUSTOM CANCEL_RESPONSE EMOTION ACTION SESSION_RESPONSE |
| MicSampleMode | The mode of the microphone sampling. | NO_MIC NO_FILTER PUSH_TO_TALK AEC TURN_BASED |
| CharSelectingMethod | The mode for selecting characters. | Manual KeyCode SightAngle AutoChat |