For more authentication options, see: https://doc.rapida.ai/api-reference/authentication
Parameters
ConnectionConfig
required
Configuration for the client connection.
GetAllAssistantRequest
required
Show child attributes
Show child attributes
Paginate
required
Usage
from rapida import (
ConnectionConfig,
GetAllAssistantRequest,
get_all_assistant,
)
from pprint import pprint
connection_config = ConnectionConfig.default_connection_config(
ConnectionConfig.with_sdk("{rapida-api-key}")
)
response = get_all_assistant(
client_cfg=connection_config,
request=GetAllAssistantRequest(
paginate=Paginate(page=0, pageSize=20),
# criterias=[Criteria(key="KEY", value="VALUE", logic="should")],
),
)
pprint(response)
package main
import (
"context"
"fmt"
"os"
clients "github.com/rapidaai/rapida-go/rapida/clients"
rapida_proto "github.com/rapidaai/rapida-go/rapida/clients/protos"
connections "github.com/rapidaai/rapida-go/rapida/connections"
)
func main() {
// Configure client connection using RAPIDA_PROJECT_CREDENTIAL environment variable
connectionConfig := connections.
DefaultconnectionConfig(connections.WithSDK(os.Getenv("RAPIDA_PROJECT_CREDENTIAL")))
// Retrieve all assistants with pagination
response, err := clients.GetAllAssistant(context.Background(), connectionConfig, &rapida_proto.GetAllAssistantRequest{
Paginate: &rapida_proto.Paginate{
Page: 0,
PageSize: 20,
},
// Optional: Add filtering criteria
// Criterias: []*rapida_proto.Criteria{{
// Key: "key",
// Value: "value",
// Logic: "should", // or "must"
// }},
})
if err != nil {
fmt.Printf("Error while making call using rapida: %+v\n", err)
return
}
// Print the response
fmt.Printf("Rapida calling response: %+v\n", response)
}
import {
ConnectionConfig,
Paginate,
GetAssistant,
GetAllAssistant,
} from "@rapidaai/nodejs";
(async () => {
const connectionCfg = ConnectionConfig.DefaultConnectionConfig(
ConnectionConfig.WithSDK({
ApiKey: process.env.RAPIDA_PROJECT_CREDENTIAL,
})
);
getAllAssistant(connectionCfg);
})();
async function getAllAssistant(connectionCfg, page = 0, pageSize = 20) {
const pagination = new Paginate();
pagination.setPage(page);
pagination.setPageSize(pageSize);
const request = new GetAllAssistantRequest();
request.setPaginate(pagination);
try {
const response = await GetAllAssistant(connectionCfg, request);
console.log("All Assistants Response:", response.toObject());
} catch (error) {
console.error("Error with GetAllAssistant call:", error);
}
}
Response
int32
Numeric status code for the operation.
boolean
Indicates whether the operation was successful.
Assistant[]
Array of assistant objects returned by the request.
Show child attributes
Show child attributes
uint64
Unique identifier for the assistant.
string
Current status of the assistant.
string
Visibility setting of the assistant.
string
Source system or origin of the assistant.
uint64
Identifier mapping to the assistant’s source.
AssistantTool[]
Array of tools available to the assistant.
uint64
Associated project identifier.
uint64
Associated organization identifier.
uint64
Model identifier tied to the assistant provider.
AssistantProviderModel
Detailed information about the assistant’s provider model.
Show child attributes
Show child attributes
uint64
Unique identifier for the provider model.
TextChatCompletePrompt
string
Description of the provider model.
uint64
Identifier of the model provider.
string
Name of the model provider.
Metadata[]
string
Status of the provider model.
uint64
Identifier of the creator.
User
User object of the creator.
uint64
Identifier of the last updater.
User
User object of the last updater.
timestamp
Timestamp when the provider model was created.
timestamp
Timestamp when the provider model was last updated.
string
Name of the assistant.
string
Description of the assistant’s purpose.
Tag
Tag information associated with the assistant.
string
Language setting for the assistant.
Organization
Organization details associated with the assistant.
uint64
Identifier of the assistant creator.
User
User object of the assistant creator.
uint64
Identifier of the last updater.
User
User object of the last updater.
timestamp
Timestamp when the assistant was created.
timestamp
Timestamp when the assistant was last updated.
AssistantDebuggerDeployment
Configuration for debugger deployment.
AssistantPhoneDeployment
Configuration for phone deployment.
AssistantWhatsappDeployment
Configuration for WhatsApp deployment.
AssistantWebpluginDeployment
Configuration for web plugin deployment.
AssistantApiDeployment
Configuration for API deployment.
AssistantConversation[]
Array of conversations associated with the assistant.
AssistantWebhook[]
Array of webhooks configured for the assistant.
object
object
Pagination information for the response.