API reference

NLPRequest Class

Extends Meta::Voice::TranscriptionRequest< TUnityEvent, TOptions, TEvents, TResults >
Abstract class for NLP text & audio requests

Constructors

NLPRequest ( inputType , options , newEvents )
Constructor for NLP requests
Signature 
Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.NLPRequest(NLPRequestInputType inputType, TOptions options, TEvents newEvents)
Parameters
inputType: NLPRequestInputType
options: TOptions
newEvents: TEvents  The request events to be called throughout it's lifecycle

Protected Fields

DecodeRawResponses : bool
Whether or not raw responses should be decoded within this script. Defaults to false
Signature 
virtual bool Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.DecodeRawResponses
ResponseDecoder : INLPRequestResponseDecoder< TResponseData >
The response decoder used to decode response json & provide vars for response data
Signature 
virtual INLPRequestResponseDecoder<TResponseData> Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.ResponseDecoder

Fields

Getter for request input type
Signature 
NLPRequestInputType Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.InputType
IsDecoding : bool
Whether currently decoding a raw response
Signature 
virtual bool Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.IsDecoding
ResponseData : TResponseData
Getter for decoded response data
Signature 
TResponseData Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.ResponseData

Properties

Logger : override IVLogger
[Get]
Signature 
override IVLogger Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.Logger

Protected Methods

ApplyResponseData ( responseData , final )
Sets response data to the current results object
Signature 
virtual void Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.ApplyResponseData(TResponseData responseData, bool final)
Parameters
responseData: TResponseData  Parsed json data returned from request
final: bool  Whether or not this response should be considered final
Returns
void
GetActivateAudioError ()
Throw error on text request
Signature 
override string Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.GetActivateAudioError()
Returns
override string
GetSendError ()
Throw error on text request
Signature 
override string Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.GetSendError()
Returns
override string
HandleRawResponse ( rawResponse , final )
Performs callbacks for raw response &
Signature 
virtual void Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.HandleRawResponse(string rawResponse, bool final)
Parameters
rawResponse: string
final: bool
Returns
void
Log ( log , logLevel )
Append NLP request specific data to log
Signature 
override void Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.Log(string log, VLoggerVerbosity logLevel=VLoggerVerbosity.Info)
Parameters
log: string
logLevel: VLoggerVerbosity
Returns
override void
MakeLastResponseFinal ()
Signature 
virtual void Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.MakeLastResponseFinal()
Returns
void
OnFullResponse ( responseData )
Called when full response has completed
Signature 
virtual void Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.OnFullResponse(TResponseData responseData)
Parameters
responseData: TResponseData
Returns
void
OnPartialResponse ( responseData )
Called when response data has been updated
Signature 
virtual void Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.OnPartialResponse(TResponseData responseData)
Parameters
responseData: TResponseData
Returns
void
OnRawResponse ( rawResponse )
Called when raw response data has been received
Signature 
virtual void Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.OnRawResponse(string rawResponse)
Parameters
rawResponse: string
Returns
void
SetState ( newState )
Sets the NLPRequest object to the given state, but only after being initialized
Signature 
override void Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.SetState(VoiceRequestState newState)
Parameters
newState: VoiceRequestState
Returns
override void

Methods

CompleteEarly ()
Cancels the current request but handles success immediately if possible
Signature 
virtual void Meta.Voice.NLPRequest< TUnityEvent, TOptions, TEvents, TResults, TResponseData >.CompleteEarly()
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta