Get Assets

In this section you can find all of Misty's API calls related to fetching information about her stored assets. To display a list of assets in the output field in the Python Interface you will need to use the syntax shown in the example below:

from mistyPy.Robot import Robot

# Initialize Misty
misty = Robot()

# Get the list of videos
video_list = misty.get_video_list()

# Check if video list is retrieved successfully
if video_list is not None:
    # Print the list of videos
    print("List of Videos:")
    for video in video_list:
        print(video)
else:
    print("Failed to retrieve the video list.")

GetAudioFile

Obtains a system or user-uploaded audio file currently stored on Misty.

Example Code

misty.get_audiofile("myaudio.mp4", false)

Parameters

misty.get_audio_file(self, fileName : str = None, base64 : bool = None)

  • FileName (string): The name of the audio file to get, including its file type extension.

  • Base64 (boolean): Optional. Sending a request with true returns the audio file data as a downloadable Base64 string. Sending a request with false returns the audio file to your browser or REST client. Defaults to false.

GetAudioList

Lists all audio files (default system files and user-uploaded files) currently stored on Misty.

misty.get_audio_list()

GetImage

Obtains a system or user-uploaded image file.

Example Code

misty.get_image("e_Amazement.jpg", false)

Parameters

misty.get_image(self, fileName : str = None, base64 : bool = None)

  • FileName (string) - The name of the image file to get, including the file type extension.

  • Base64 (boolean) - Optional. Sending a request with true returns the image data as a downloadable Base64 string. Sending a request with false displays the image in your browser or REST client immediately after the image is taken. Default is true.

GetImageList

Obtains a list of the images currently stored on Misty.

misty.get_image_list()

GetVideo

Obtains a user-uploaded video file currently stored on Misty.

Note: This command only obtains user-uploaded video assets. To obtain a video recording that Misty created, you must use the GetVideoRecording command.

Example Code

misty.get_video("myvideo.mp4", false)

Parameters

misty.get_video(self, fileName : str = None, base64 : bool = None)

  • FileName (string) - The name of the video to obtain, with the file type extension.

  • Base64 (boolean) - Optional. Sending a request with true returns the video data as a Base64-encoded string. Sending a request with false downloads the video file to your REST client. Default is false.

GetVideoList

Obtains a list of the user-uploaded video assets saved to Misty's storage.

Note: This command only obtains a list of user-uploaded video assets. To obtain a list of video recordings that Misty created, you must use the GetVideoRecordingsList command.

misty.get_video_list()

GetVideoRecording

Downloads a video that Misty has created. Optionally, returns the video data as a Base64 string.

You can only use this command to download videos that Misty recorded. To get videos that you or another user has uploaded, use the GetVideo command.

Example Code

misty.get_video_recording("myrecording.mp4",true)

Tip: Misty records videos in .mp4 format. Video recordings have a maximum resolution of 3840 x 2160 pixels and can be up to 3 minutes long. A single video file can be up to 225 MB and can take several minutes to download.

Parameters

misty.get_video_recording(self, name : str = None, base64 : bool = None)

  • Name (string) - Optional. The filename of the video to download. If not supplied, defaults to misty_video.

  • Base64 (boolean) - Optional. Sending a request with true returns the video data as a Base64-encoded string. Sending a request with false downloads the video file to your REST client. Defaults to false.

GetVideoRecordingList

Obtains a list of filenames for each video recording saved to Misty's local storage.

misty.get_video_recording_list()

GetKnownFaces

Obtains a list of the names of faces on which Misty has been successfully trained.

misty.get_known_faces()

GetConversations

Obtains a list of conversations stored in Misty's memory.

misty.get_conversations()

GetLoadedContexts

Obtains a list of loaded contexts used for NLP.

misty.get_loaded_contexts()

GetStates

Obtains a list of states used in your conversation.

misty.get_states()

Last updated