Gets the latest web plugin deployment for an assistant. Use user-scoped authentication because the operation requires organization and project context.
Parameters
Configuration for the client connection.
request
GetAssistantDeploymentRequest
required
Deployment lookup request. Assistant ID for the deployment.
Usage
import {
ConnectionConfig ,
GetAssistantDeploymentRequest ,
GetAssistantWebpluginDeployment ,
} from "@rapidaai/react" ;
const auth = ConnectionConfig . WithDebugger ({
authorization: "AUTHORIZATION_TOKEN_PLACEHOLDER" ,
userId: "AUTH_ID_PLACEHOLDER" ,
projectId: "PROJECT_ID_PLACEHOLDER" ,
});
const connectionCfg = ConnectionConfig . DefaultConnectionConfig ( auth );
const request = new GetAssistantDeploymentRequest ();
request . setAssistantid ( "ASSISTANT_ID_PLACEHOLDER" );
const response = await GetAssistantWebpluginDeployment ( connectionCfg , request );
console . dir ( response . toObject ());
Response
Numeric status code for the operation.
Indicates whether the operation was successful.
data
AssistantWebpluginDeployment
Webplugin deployment. If no deployment exists, the deployment field may be omitted. Unique identifier for the web plugin deployment.
Assistant ID for the deployment.
First message the assistant sends when the session starts.
Message used when the assistant cannot understand or handle input.
Speech-to-text provider configuration.
Text-to-speech provider configuration.
Suggested starter prompts.
Whether this web plugin capability is enabled.
Whether this web plugin capability is enabled.
Whether this web plugin capability is enabled.
Whether this web plugin capability is enabled.
Current deployment status.
Number of idle-timeout retries.
Message sent on idle timeout.
Maximum session duration in seconds.
Timestamp when the deployment was created.
Timestamp when the deployment was last updated.
Error details when the operation fails. Stable, machine-readable numeric code.
Developer-oriented message with diagnostic details.
Human-friendly description safe for display to end users.
Errors
Code Meaning 1012001Unauthenticated request. 1012002Missing authentication scope. 1012003Invalid assistantId. 1012004Unable to get assistant web plugin deployment.