API reference
NLPRequest Class
Abstract class for NLP text & audio requests
Others
TUnityEvent
The type of event callback performed by TEvents for all event callbacks
TOptions
The type containing all specific options to be passed to the end service.
TEvents
The type containing all events of TSession to be called throughout the lifecycle of the request.
TResults
The type containing all data that can be returned from the end service.
Properties
override IVLogger Logger[Get]
Fields
NLPRequestInputType InputType[Get]
Getter for request input type
TResponseData ResponseData[Get]
Getter for decoded response data
bool IsDecoding[Get]
Whether currently decoding a raw response
Protected Fields
INLPRequestResponseDecoder< TResponseData > ResponseDecoder[Get]
The response decoder used to decode response json & provide vars for response data
bool DecodeRawResponses[Get]
Whether or not raw responses should be decoded within this script. Defaults to false
Protected Functions
NLPRequest
( NLPRequestInputType inputType,
TOptions options,
TEvents newEvents )
Constructor for NLP requests
Parameters
newInputType
The input type for nlp request transmission
newOptions
The request parameters sent to the backend service
newEvents
The request events to be called throughout it's lifecycle
virtual override void SetState
( VoiceRequestState newState )
Sets the NLPRequest object to the given state, but only after being initialized
virtual override void Log
( string log,
VLoggerVerbosity logLevel )
Append NLP request specific data to log
virtual override string GetActivateAudioError ( )
Throw error on text request
virtual override string GetSendError ( )
Throw error on text request
virtual void HandleRawResponse
( string rawResponse,
bool final )
Performs callbacks for raw response &
Parameters
rawResponse
final
virtual void OnRawResponse
( string rawResponse )
Called when raw response data has been received
virtual void ApplyResponseData
( TResponseData responseData,
bool final )
Sets response data to the current results object
Parameters
responseData
Parsed json data returned from request
final
Whether or not this response should be considered final
virtual void OnPartialResponse
( TResponseData responseData )
Called when response data has been updated
virtual void OnFullResponse
( TResponseData responseData )
Called when full response has completed
virtual void MakeLastResponseFinal ( )
Member Functions
virtual void CompleteEarly ( )
Cancels the current request but handles success immediately if possible
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta