Struct ArtifactPlan

pub struct ArtifactPlan {
    pub recording_enabled: Option<bool>,
    pub recording_format: Option<RecordingFormatTrue>,
    pub video_recording_enabled: Option<bool>,
    pub pcap_enabled: Option<bool>,
    pub pcap_s3_path_prefix: Option<String>,
    pub transcript_plan: Option<TranscriptPlan>,
    pub recording_path: Option<String>,
}

Fields

recording_enabled: Option<bool>

This determines whether assistant’s calls are recorded. Defaults to true. Usage: - If you don’t want to record the calls, set this to false. - If you want to record the calls when assistant.hipaaEnabled (deprecated) or assistant.compliancePlan.hipaaEnabled explicity set this to true and make sure to provide S3 or GCP credentials on the Provider Credentials page in the Dashboard. You can find the recording at call.artifact.recordingUrl and call.artifact.stereoRecordingUrl after the call is ended. @default true

recording_format: Option<RecordingFormatTrue>

This determines the format of the recording. Defaults to wav;l16. @default ‘wav;l16’

video_recording_enabled: Option<bool>

This determines whether the video is recorded during the call. Defaults to false. Only relevant for webCall type. You can find the video recording at call.artifact.videoRecordingUrl after the call is ended. @default false

pcap_enabled: Option<bool>

This determines whether the SIP packet capture is enabled. Defaults to true. Only relevant for phone type calls where phone number’s provider is vapi or byo-phone-number. You can find the packet capture at call.artifact.pcapUrl after the call is ended. @default true

pcap_s3_path_prefix: Option<String>

This is the path where the SIP packet capture will be uploaded. This is only used if you have provided S3 or GCP credentials on the Provider Credentials page in the Dashboard. If credential.s3PathPrefix or credential.bucketPlan.path is set, this will append to it. Usage: - If you want to upload the packet capture to a specific path, set this to the path. Example: /my-assistant-captures. - If you want to upload the packet capture to the root of the bucket, set this to /. @default ‘/’

transcript_plan: Option<TranscriptPlan>

This is the plan for call.artifact.transcript. To disable, set transcriptPlan.enabled to false.

recording_path: Option<String>

This is the path where the recording will be uploaded. This is only used if you have provided S3 or GCP credentials on the Provider Credentials page in the Dashboard. If credential.s3PathPrefix or credential.bucketPlan.path is set, this will append to it. Usage: - If you want to upload the recording to a specific path, set this to the path. Example: /my-assistant-recordings. - If you want to upload the recording to the root of the bucket, set this to /. @default ‘/’

Implementations

impl ArtifactPlan

pub fn new() -> ArtifactPlan

Trait Implementations

impl Clone for ArtifactPlan

fn clone(&self) -> ArtifactPlan

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArtifactPlan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ArtifactPlan

fn default() -> ArtifactPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ArtifactPlan

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ArtifactPlan

fn eq(&self, other: &ArtifactPlan) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ArtifactPlan

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ArtifactPlan