For setup and authentication options, see the Installation guide and Authentication.
Parameters
ConnectionConfig
required
Configuration for the client connection.
GetAssistantDeploymentRequest
required
Deployment lookup request.
Show child attributes
Show child attributes
uint64
required
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());
import {
ConnectionConfig,
GetAssistantDeploymentRequest,
GetAssistantWebpluginDeployment,
} from "@rapidaai/nodejs";
const auth = ConnectionConfig.WithDebugger({
authorization: process.env.RAPIDA_AUTHORIZATION,
userId: process.env.RAPIDA_AUTH_ID,
projectId: process.env.RAPIDA_PROJECT_ID,
});
const connectionCfg = ConnectionConfig.DefaultConnectionConfig(auth);
const request = new GetAssistantDeploymentRequest();
request.setAssistantid(process.env.RAPIDA_ASSISTANT_ID);
const response = await GetAssistantWebpluginDeployment(connectionCfg, request);
console.dir(response.toObject());
import os
from pprint import pprint
from rapida import ConnectionConfig
from rapida.clients.protos.assistant_deployment_pb2 import (
GetAssistantDeploymentRequest,
)
auth = ConnectionConfig.with_debugger(
authorization=os.getenv("RAPIDA_AUTHORIZATION"),
user_id=os.getenv("RAPIDA_AUTH_ID"),
project_id=os.getenv("RAPIDA_PROJECT_ID"),
)
connection_config = ConnectionConfig.default_connection_config(auth)
response = connection_config.assistant_deployment_client.GetAssistantWebpluginDeployment(
GetAssistantDeploymentRequest(
assistantId=int(os.getenv("RAPIDA_ASSISTANT_ID")),
),
metadata=connection_config.auth,
)
pprint(response)
package main
import (
"context"
"fmt"
"os"
clients "github.com/rapidaai/rapida-go/rapida/clients"
connections "github.com/rapidaai/rapida-go/rapida/connections"
protos "github.com/rapidaai/rapida-go/protos"
)
func main() {
connectionConfig := connections.DefaultconnectionConfig(
connections.WithPersonalToken(
os.Getenv("RAPIDA_AUTHORIZATION"),
os.Getenv("RAPIDA_AUTH_ID"),
os.Getenv("RAPIDA_PROJECT_ID"),
),
)
response, err := clients.GetAssistantWebpluginDeployment(
context.Background(),
connectionConfig,
&protos.GetAssistantDeploymentRequest{
AssistantId: 2227823180112723968,
},
)
if err != nil {
fmt.Printf("error while getting web plugin deployment: %+v\n", err)
return
}
fmt.Printf("get web plugin deployment response: %+v\n", response)
}
Response
int32
Numeric status code for the operation.
boolean
Indicates whether the operation was successful.
AssistantWebpluginDeployment
Webplugin deployment. If no deployment exists, the deployment field may be omitted.
Show child attributes
Show child attributes
uint64
Unique identifier for the web plugin deployment.
uint64
Assistant ID for the deployment.
string
First message the assistant sends when the session starts.
boolean
Controls whether users can interrupt the opening greeting in audio sessions.
string
Message used when the assistant cannot understand or handle input.
DeploymentAudioProvider
Speech-to-text provider configuration.
DeploymentAudioProvider
Text-to-speech provider configuration.
string[]
Suggested starter prompts.
boolean
Whether this web plugin capability is enabled.
boolean
Whether this web plugin capability is enabled.
boolean
Whether this web plugin capability is enabled.
boolean
Whether this web plugin capability is enabled.
string
Current deployment status.
uint64
Idle timeout in seconds.
uint64
Number of idle-timeout retries.
string
Message sent on idle timeout.
uint64
Maximum session duration in seconds.
timestamp
Timestamp when the deployment was created.
timestamp
Timestamp when the deployment was last updated.
Error
Errors
| Code | Meaning |
|---|---|
1012001 | Unauthenticated request. |
1012002 | Missing authentication scope. |
1012003 | Invalid assistantId. |
1012004 | Unable to get assistant web plugin deployment. |