Namespaces
	demo

	porcupine

	pvrecorder

	rhino

	setup

	test_porcupine

	test_rhino

	util

Functions
def	create (access_key, library_path=None, model_path=None, keyword_paths=None, keywords=None, sensitivities=None)

Variables
	KEYWORD_PATHS = pv_keyword_paths('')

	KEYWORDS = set(KEYWORD_PATHS.keys())

	LIBRARY_PATH = pv_library_path('')

	MODEL_PATH = pv_model_path('')

Function Documentation

◆ create()

def python.create	(	access_key,
		context_path = `None`,
		library_path = `None`,
		model_path = `None`,
		sensitivity = `None`,
		require_endpoint = `None`
	)

Factory method for Porcupine wake word engine.

:param access_key: AccessKey obtained from Picovoice Console.
:param library_path: Absolute path to Porcupine's dynamic library. If not set it will be set to the default
location.
:param model_path: Absolute path to the file containing model parameters. If not set it will be set to the default
location.
:param keyword_paths: Absolute paths to keyword model files. If not set it will be populated from `keywords`
argument.
:param keywords: List of keywords (phrases) for detection. The list of available (default) keywords can be
retrieved using `pvporcupine.KEYWORDS`. If `keyword_paths` is set then this argument will be ignored.
:param sensitivities: Sensitivities for detecting keywords. Each value should be a number within [0, 1]. A higher
sensitivity results in fewer misses at the cost of increasing the false alarm rate. If not set 0.5 will be used.
:return: An instance of Porcupine wake word engine.

Factory method for Rhino Speech-to-Intent engine.

:param access_key: AccessKey obtained from Picovoice Console (https://console.picovoice.ai/).
:param context_path: Absolute path to file containing context model (file with `.rhn` extension. A context
represents the set of expressions (spoken commands), intents, and intent arguments (slots) within a domain of
interest.
:param library_path: Absolute path to Rhino's dynamic library. If not set it will be set to the default
location.
:param model_path: Absolute path to the file containing model parameters. If not set it will be set to the default
location.
:param sensitivity: Inference sensitivity. It should be a number within [0, 1]. A higher sensitivity value
results in fewer misses at the cost of (potentially) increasing the erroneous inference rate.
:param require_endpoint If set to `False`, Rhino does not require an endpoint (chunk of silence) before
    finishing inference.
:return An instance of Rhino Speech-to-Intent engine.

Definition at line 36 of file porcupine/binding/python/__init__.py.