vapi_server_sdk 0.0.0.pre.alpha7 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/requests.rb +2 -10
- data/lib/types_export.rb +184 -26
- data/lib/vapi_server_sdk/analytics/client.rb +14 -43
- data/lib/vapi_server_sdk/assistants/client.rb +57 -60
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_client_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_model.rb +39 -0
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_server_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_transcriber.rb +27 -1
- data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_voice.rb +26 -0
- data/lib/vapi_server_sdk/calls/client.rb +58 -28
- data/lib/vapi_server_sdk/knowledge_bases/client.rb +394 -0
- data/lib/vapi_server_sdk/knowledge_bases/types/knowledge_bases_create_request.rb +96 -0
- data/lib/vapi_server_sdk/knowledge_bases/types/knowledge_bases_create_response.rb +96 -0
- data/lib/vapi_server_sdk/knowledge_bases/types/knowledge_bases_delete_response.rb +96 -0
- data/lib/vapi_server_sdk/knowledge_bases/types/knowledge_bases_get_response.rb +96 -0
- data/lib/vapi_server_sdk/knowledge_bases/types/knowledge_bases_list_response_item.rb +96 -0
- data/lib/vapi_server_sdk/knowledge_bases/types/knowledge_bases_update_response.rb +96 -0
- data/lib/vapi_server_sdk/logs/client.rb +10 -6
- data/lib/vapi_server_sdk/squads/client.rb +56 -32
- data/lib/vapi_server_sdk/tools/client.rb +4 -0
- data/lib/vapi_server_sdk/tools/types/tools_create_request.rb +39 -0
- data/lib/vapi_server_sdk/tools/types/tools_create_response.rb +39 -0
- data/lib/vapi_server_sdk/tools/types/tools_delete_response.rb +39 -0
- data/lib/vapi_server_sdk/tools/types/tools_get_response.rb +39 -0
- data/lib/vapi_server_sdk/tools/types/tools_list_response_item.rb +39 -0
- data/lib/vapi_server_sdk/tools/types/tools_update_response.rb +39 -0
- data/lib/vapi_server_sdk/types/analytics_query_dto.rb +59 -0
- data/lib/vapi_server_sdk/types/anthropic_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/anthropic_model.rb +21 -13
- data/lib/vapi_server_sdk/types/anthropic_model_model.rb +2 -0
- data/lib/vapi_server_sdk/types/anyscale_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/anyscale_model.rb +21 -13
- data/lib/vapi_server_sdk/types/assembly_ai_credential.rb +111 -0
- data/lib/vapi_server_sdk/types/assembly_ai_transcriber.rb +97 -0
- data/lib/vapi_server_sdk/types/assistant.rb +42 -64
- data/lib/vapi_server_sdk/types/assistant_client_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/types/assistant_custom_endpointing_rule.rb +100 -0
- data/lib/vapi_server_sdk/types/assistant_model.rb +39 -0
- data/lib/vapi_server_sdk/types/assistant_overrides.rb +57 -65
- data/lib/vapi_server_sdk/types/assistant_overrides_client_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/types/assistant_overrides_model.rb +39 -0
- data/lib/vapi_server_sdk/types/assistant_overrides_server_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/types/assistant_overrides_transcriber.rb +27 -1
- data/lib/vapi_server_sdk/types/assistant_overrides_voice.rb +26 -0
- data/lib/vapi_server_sdk/types/assistant_server_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/types/assistant_transcriber.rb +27 -1
- data/lib/vapi_server_sdk/types/assistant_voice.rb +26 -0
- data/lib/vapi_server_sdk/types/auto_reload_plan.rb +65 -0
- data/lib/vapi_server_sdk/types/auto_reload_plan_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/azure_credential.rb +129 -0
- data/lib/vapi_server_sdk/types/azure_credential_region.rb +23 -0
- data/lib/vapi_server_sdk/types/azure_open_ai_credential.rb +12 -2
- data/lib/vapi_server_sdk/types/azure_open_ai_credential_models_item.rb +1 -0
- data/lib/vapi_server_sdk/types/azure_open_ai_credential_region.rb +1 -0
- data/lib/vapi_server_sdk/types/azure_voice.rb +25 -21
- data/lib/vapi_server_sdk/types/bash_tool.rb +194 -0
- data/lib/vapi_server_sdk/types/bash_tool_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/block_complete_message.rb +29 -4
- data/lib/vapi_server_sdk/types/block_start_message.rb +29 -4
- data/lib/vapi_server_sdk/types/both_custom_endpointing_rule.rb +126 -0
- data/lib/vapi_server_sdk/types/byo_sip_trunk_credential.rb +29 -9
- data/lib/vapi_server_sdk/types/call.rb +15 -1
- data/lib/vapi_server_sdk/types/call_ended_reason.rb +49 -24
- data/lib/vapi_server_sdk/types/call_log_privileged.rb +88 -0
- data/lib/vapi_server_sdk/types/call_log_privileged_level.rb +12 -0
- data/lib/vapi_server_sdk/types/call_logs_paginated_response.rb +75 -0
- data/lib/vapi_server_sdk/types/cartesia_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/cartesia_voice.rb +25 -21
- data/lib/vapi_server_sdk/types/cartesia_voice_language.rb +9 -1
- data/lib/vapi_server_sdk/types/client_inbound_message_add_message.rb +25 -3
- data/lib/vapi_server_sdk/types/client_inbound_message_message.rb +13 -0
- data/lib/vapi_server_sdk/types/client_inbound_message_transfer.rb +63 -0
- data/lib/vapi_server_sdk/types/client_inbound_message_transfer_destination.rb +96 -0
- data/lib/vapi_server_sdk/types/{client_message_language_changed.rb → client_message_language_change_detected.rb} +5 -5
- data/lib/vapi_server_sdk/types/client_message_message.rb +22 -9
- data/lib/vapi_server_sdk/types/client_message_tool_calls_tool_with_tool_call_list_item.rb +77 -77
- data/lib/vapi_server_sdk/types/client_message_transfer_update.rb +116 -0
- data/lib/vapi_server_sdk/types/client_message_transfer_update_destination.rb +122 -0
- data/lib/vapi_server_sdk/types/computer_tool.rb +218 -0
- data/lib/vapi_server_sdk/types/computer_tool_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/condition.rb +9 -9
- data/lib/vapi_server_sdk/types/create_anthropic_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_anyscale_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_assembly_ai_credential_dto.rb +74 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto.rb +43 -65
- data/lib/vapi_server_sdk/types/create_assistant_dto_client_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto_model.rb +39 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto_server_messages_item.rb +1 -0
- data/lib/vapi_server_sdk/types/create_assistant_dto_transcriber.rb +27 -1
- data/lib/vapi_server_sdk/types/create_assistant_dto_voice.rb +26 -0
- data/lib/vapi_server_sdk/types/create_azure_credential_dto.rb +95 -0
- data/lib/vapi_server_sdk/types/create_azure_credential_dto_region.rb +23 -0
- data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto.rb +13 -3
- data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_models_item.rb +1 -0
- data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_region.rb +1 -0
- data/lib/vapi_server_sdk/types/create_bash_tool_dto.rb +161 -0
- data/lib/vapi_server_sdk/types/create_bash_tool_dto_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/create_byo_sip_trunk_credential_dto.rb +31 -11
- data/lib/vapi_server_sdk/types/create_cartesia_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_computer_tool_dto.rb +185 -0
- data/lib/vapi_server_sdk/types/create_computer_tool_dto_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/create_custom_knowledge_base_dto.rb +137 -0
- data/lib/vapi_server_sdk/types/create_custom_llm_credential_dto.rb +31 -2
- data/lib/vapi_server_sdk/types/create_deep_infra_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_deepgram_credential_dto.rb +9 -2
- data/lib/vapi_server_sdk/types/create_eleven_labs_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_gcp_credential_dto.rb +10 -10
- data/lib/vapi_server_sdk/types/create_gladia_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_go_high_level_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_google_credential_dto.rb +76 -0
- data/lib/vapi_server_sdk/types/create_groq_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_inflection_ai_credential_dto.rb +76 -0
- data/lib/vapi_server_sdk/types/create_langfuse_credential_dto.rb +96 -0
- data/lib/vapi_server_sdk/types/create_lmnt_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_make_credential_dto.rb +17 -2
- data/lib/vapi_server_sdk/types/create_open_ai_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_open_router_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_org_dto.rb +21 -2
- data/lib/vapi_server_sdk/types/create_org_dto_channel.rb +10 -0
- data/lib/vapi_server_sdk/types/create_perplexity_ai_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_play_ht_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_rime_ai_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_runpod_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_s_3_credential_dto.rb +13 -3
- data/lib/vapi_server_sdk/types/{knowledge_base.rb → create_tavus_credential_dto.rb} +21 -21
- data/lib/vapi_server_sdk/types/create_text_editor_tool_dto.rb +161 -0
- data/lib/vapi_server_sdk/types/create_text_editor_tool_dto_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/create_together_ai_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/create_trieve_knowledge_base_dto.rb +109 -0
- data/lib/vapi_server_sdk/types/create_twilio_credential_dto.rb +16 -2
- data/lib/vapi_server_sdk/types/create_vapi_phone_number_dto.rb +20 -2
- data/lib/vapi_server_sdk/types/create_vonage_credential_dto.rb +16 -2
- data/lib/vapi_server_sdk/types/create_webhook_credential_dto.rb +84 -0
- data/lib/vapi_server_sdk/types/create_x_ai_credential_dto.rb +76 -0
- data/lib/vapi_server_sdk/types/credits_buy_dto.rb +55 -0
- data/lib/vapi_server_sdk/types/custom_knowledge_base.rb +154 -0
- data/lib/vapi_server_sdk/types/custom_llm_credential.rb +46 -3
- data/lib/vapi_server_sdk/types/custom_llm_model.rb +23 -15
- data/lib/vapi_server_sdk/types/custom_message.rb +92 -0
- data/lib/vapi_server_sdk/types/custom_transcriber.rb +125 -0
- data/lib/vapi_server_sdk/types/custom_voice.rb +132 -0
- data/lib/vapi_server_sdk/types/customer_custom_endpointing_rule.rb +100 -0
- data/lib/vapi_server_sdk/types/deep_infra_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/deep_infra_model.rb +21 -13
- data/lib/vapi_server_sdk/types/deepgram_credential.rb +9 -1
- data/lib/vapi_server_sdk/types/deepgram_transcriber.rb +69 -11
- data/lib/vapi_server_sdk/types/deepgram_voice.rb +17 -17
- data/lib/vapi_server_sdk/types/eleven_labs_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/eleven_labs_voice.rb +28 -24
- data/lib/vapi_server_sdk/types/fallback_azure_voice.rb +100 -0
- data/lib/vapi_server_sdk/types/fallback_azure_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/fallback_azure_voice_voice_id.rb +9 -0
- data/lib/vapi_server_sdk/types/fallback_cartesia_voice.rb +100 -0
- data/lib/vapi_server_sdk/types/fallback_cartesia_voice_language.rb +23 -0
- data/lib/vapi_server_sdk/types/fallback_cartesia_voice_model.rb +10 -0
- data/lib/vapi_server_sdk/types/fallback_custom_voice.rb +117 -0
- data/lib/vapi_server_sdk/types/fallback_deepgram_voice.rb +81 -0
- data/lib/vapi_server_sdk/types/fallback_deepgram_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/fallback_deepgram_voice_id_enum.rb +18 -0
- data/lib/vapi_server_sdk/types/fallback_eleven_labs_voice.rb +164 -0
- data/lib/vapi_server_sdk/types/fallback_eleven_labs_voice_id.rb +54 -0
- data/lib/vapi_server_sdk/types/fallback_eleven_labs_voice_id_enum.rb +21 -0
- data/lib/vapi_server_sdk/types/fallback_eleven_labs_voice_model.rb +12 -0
- data/lib/vapi_server_sdk/types/fallback_lmnt_voice.rb +88 -0
- data/lib/vapi_server_sdk/types/fallback_lmnt_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/fallback_lmnt_voice_id_enum.rb +8 -0
- data/lib/vapi_server_sdk/types/fallback_neets_voice.rb +81 -0
- data/lib/vapi_server_sdk/types/fallback_neets_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/fallback_neets_voice_id_enum.rb +7 -0
- data/lib/vapi_server_sdk/types/fallback_open_ai_voice.rb +87 -0
- data/lib/vapi_server_sdk/types/fallback_open_ai_voice_id.rb +20 -0
- data/lib/vapi_server_sdk/types/fallback_plan.rb +61 -0
- data/lib/vapi_server_sdk/types/fallback_plan_voices_item.rb +211 -0
- data/lib/vapi_server_sdk/types/fallback_play_ht_voice.rb +172 -0
- data/lib/vapi_server_sdk/types/fallback_play_ht_voice_emotion.rb +19 -0
- data/lib/vapi_server_sdk/types/fallback_play_ht_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/fallback_play_ht_voice_id_enum.rb +16 -0
- data/lib/vapi_server_sdk/types/fallback_play_ht_voice_language.rb +44 -0
- data/lib/vapi_server_sdk/types/fallback_play_ht_voice_model.rb +10 -0
- data/lib/vapi_server_sdk/types/fallback_rime_ai_voice.rb +96 -0
- data/lib/vapi_server_sdk/types/fallback_rime_ai_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/fallback_rime_ai_voice_id_enum.rb +87 -0
- data/lib/vapi_server_sdk/types/fallback_rime_ai_voice_model.rb +9 -0
- data/lib/vapi_server_sdk/types/fallback_tavus_voice.rb +147 -0
- data/lib/vapi_server_sdk/types/fallback_tavus_voice_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/format_plan.rb +0 -2
- data/lib/vapi_server_sdk/types/function_tool_with_tool_call.rb +10 -1
- data/lib/vapi_server_sdk/types/gcp_credential.rb +2 -2
- data/lib/vapi_server_sdk/types/ghl_tool_with_tool_call.rb +9 -1
- data/lib/vapi_server_sdk/types/gladia_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/go_high_level_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/google_credential.rb +113 -0
- data/lib/vapi_server_sdk/types/google_model.rb +178 -0
- data/lib/vapi_server_sdk/types/google_model_model.rb +12 -0
- data/lib/vapi_server_sdk/types/google_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/groq_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/groq_model.rb +21 -13
- data/lib/vapi_server_sdk/types/hipaa_buy_dto.rb +65 -0
- data/lib/vapi_server_sdk/types/inflection_ai_credential.rb +113 -0
- data/lib/vapi_server_sdk/types/inflection_ai_model.rb +177 -0
- data/lib/vapi_server_sdk/types/inflection_ai_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk/types/invite_user_dto.rb +9 -9
- data/lib/vapi_server_sdk/types/knowledge_base_response_document.rb +74 -0
- data/lib/vapi_server_sdk/types/langfuse_credential.rb +130 -0
- data/lib/vapi_server_sdk/types/lmnt_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/lmnt_voice.rb +18 -14
- data/lib/vapi_server_sdk/types/log.rb +12 -4
- data/lib/vapi_server_sdk/types/log_resource.rb +8 -0
- data/lib/vapi_server_sdk/types/make_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/make_tool_with_tool_call.rb +9 -1
- data/lib/vapi_server_sdk/types/neets_voice.rb +17 -17
- data/lib/vapi_server_sdk/types/o_auth_2_authentication_plan.rb +79 -0
- data/lib/vapi_server_sdk/types/oauth_2_authentication_session.rb +68 -0
- data/lib/vapi_server_sdk/types/open_ai_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/open_ai_function.rb +30 -4
- data/lib/vapi_server_sdk/types/open_ai_model.rb +23 -15
- data/lib/vapi_server_sdk/types/open_ai_model_fallback_models_item.rb +2 -0
- data/lib/vapi_server_sdk/types/open_ai_model_model.rb +2 -0
- data/lib/vapi_server_sdk/types/open_ai_voice.rb +22 -14
- data/lib/vapi_server_sdk/types/open_ai_voice_id.rb +7 -0
- data/lib/vapi_server_sdk/types/open_router_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/open_router_model.rb +21 -13
- data/lib/vapi_server_sdk/types/org.rb +35 -2
- data/lib/vapi_server_sdk/types/org_channel.rb +10 -0
- data/lib/vapi_server_sdk/types/org_with_org_user.rb +262 -0
- data/lib/vapi_server_sdk/types/org_with_org_user_channel.rb +10 -0
- data/lib/vapi_server_sdk/types/org_with_org_user_role.rb +9 -0
- data/lib/vapi_server_sdk/types/payment.rb +167 -0
- data/lib/vapi_server_sdk/types/payment_retry_dto.rb +55 -0
- data/lib/vapi_server_sdk/types/payment_status.rb +11 -0
- data/lib/vapi_server_sdk/types/payments_paginated_response.rb +75 -0
- data/lib/vapi_server_sdk/types/perplexity_ai_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/perplexity_ai_model.rb +21 -13
- data/lib/vapi_server_sdk/types/phone_number_paginated_response.rb +75 -0
- data/lib/vapi_server_sdk/types/phone_number_paginated_response_results_item.rb +121 -0
- data/lib/vapi_server_sdk/types/play_ht_credential.rb +13 -2
- data/lib/vapi_server_sdk/types/play_ht_voice.rb +37 -15
- data/lib/vapi_server_sdk/types/play_ht_voice_language.rb +44 -0
- data/lib/vapi_server_sdk/types/play_ht_voice_model.rb +10 -0
- data/lib/vapi_server_sdk/types/regex_option.rb +2 -2
- data/lib/vapi_server_sdk/types/regex_option_type.rb +1 -1
- data/lib/vapi_server_sdk/types/regex_replacement.rb +14 -4
- data/lib/vapi_server_sdk/types/rime_ai_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/rime_ai_voice.rb +18 -14
- data/lib/vapi_server_sdk/types/runpod_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/s_3_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/server.rb +16 -2
- data/lib/vapi_server_sdk/types/server_message_end_of_call_report_ended_reason.rb +49 -24
- data/lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb +195 -0
- data/lib/vapi_server_sdk/types/server_message_knowledge_base_request_messages_item.rb +97 -0
- data/lib/vapi_server_sdk/types/{server_message_language_changed_phone_number.rb → server_message_knowledge_base_request_phone_number.rb} +8 -8
- data/lib/vapi_server_sdk/types/{server_message_language_changed.rb → server_message_language_change_detected.rb} +10 -10
- data/lib/vapi_server_sdk/types/server_message_language_change_detected_phone_number.rb +125 -0
- data/lib/vapi_server_sdk/types/server_message_message.rb +22 -9
- data/lib/vapi_server_sdk/types/server_message_response_knowledge_base_request.rb +81 -0
- data/lib/vapi_server_sdk/types/server_message_response_message_response.rb +14 -0
- data/lib/vapi_server_sdk/types/server_message_status_update_ended_reason.rb +49 -24
- data/lib/vapi_server_sdk/types/server_message_tool_calls_tool_with_tool_call_list_item.rb +77 -77
- data/lib/vapi_server_sdk/types/server_message_transfer_update.rb +18 -2
- data/lib/vapi_server_sdk/types/sip_authentication.rb +80 -0
- data/lib/vapi_server_sdk/types/start_speaking_plan.rb +54 -10
- data/lib/vapi_server_sdk/types/start_speaking_plan_custom_endpointing_rules_item.rb +108 -0
- data/lib/vapi_server_sdk/types/structured_data_plan.rb +28 -10
- data/lib/vapi_server_sdk/types/subscription.rb +336 -0
- data/lib/vapi_server_sdk/types/subscription_concurrency_line_buy_dto.rb +55 -0
- data/lib/vapi_server_sdk/types/subscription_concurrency_line_remove_dto.rb +55 -0
- data/lib/vapi_server_sdk/types/subscription_coupon_add_dto.rb +67 -0
- data/lib/vapi_server_sdk/types/subscription_monthly_charge.rb +65 -0
- data/lib/vapi_server_sdk/types/subscription_status.rb +10 -0
- data/lib/vapi_server_sdk/types/subscription_type.rb +10 -0
- data/lib/vapi_server_sdk/types/success_evaluation_plan.rb +38 -16
- data/lib/vapi_server_sdk/types/summary_plan.rb +26 -8
- data/lib/vapi_server_sdk/types/sync_voice_library_dto_providers_item.rb +1 -0
- data/lib/vapi_server_sdk/types/tavus_conversation_properties.rb +173 -0
- data/lib/vapi_server_sdk/types/tavus_credential.rb +111 -0
- data/lib/vapi_server_sdk/types/tavus_voice.rb +163 -0
- data/lib/vapi_server_sdk/types/tavus_voice_voice_id.rb +53 -0
- data/lib/vapi_server_sdk/types/text_content.rb +73 -0
- data/lib/vapi_server_sdk/types/text_content_language.rb +191 -0
- data/lib/vapi_server_sdk/types/text_editor_tool.rb +194 -0
- data/lib/vapi_server_sdk/types/text_editor_tool_messages_item.rb +120 -0
- data/lib/vapi_server_sdk/types/together_ai_credential.rb +13 -3
- data/lib/vapi_server_sdk/types/together_ai_model.rb +21 -13
- data/lib/vapi_server_sdk/types/tool_message_complete.rb +29 -3
- data/lib/vapi_server_sdk/types/tool_message_delayed.rb +30 -3
- data/lib/vapi_server_sdk/types/tool_message_failed.rb +30 -3
- data/lib/vapi_server_sdk/types/tool_message_start.rb +29 -4
- data/lib/vapi_server_sdk/types/transfer_destination_assistant.rb +79 -33
- data/lib/vapi_server_sdk/types/transfer_destination_assistant_message.rb +65 -0
- data/lib/vapi_server_sdk/types/transfer_destination_number.rb +56 -24
- data/lib/vapi_server_sdk/types/transfer_destination_number_message.rb +65 -0
- data/lib/vapi_server_sdk/types/transfer_destination_sip.rb +60 -15
- data/lib/vapi_server_sdk/types/transfer_destination_sip_message.rb +65 -0
- data/lib/vapi_server_sdk/types/transfer_destination_step.rb +28 -14
- data/lib/vapi_server_sdk/types/transfer_destination_step_message.rb +65 -0
- data/lib/vapi_server_sdk/types/transfer_plan.rb +141 -0
- data/lib/vapi_server_sdk/types/transfer_plan_message.rb +58 -0
- data/lib/vapi_server_sdk/types/transfer_plan_mode.rb +32 -0
- data/lib/vapi_server_sdk/types/transport.rb +70 -0
- data/lib/vapi_server_sdk/types/transport_cost.rb +12 -2
- data/lib/vapi_server_sdk/types/transport_cost_provider.rb +9 -0
- data/lib/vapi_server_sdk/types/transport_provider.rb +11 -0
- data/lib/vapi_server_sdk/types/trieve_knowledge_base.rb +125 -0
- data/lib/vapi_server_sdk/types/trieve_knowledge_base_vector_store_create_plan.rb +109 -0
- data/lib/vapi_server_sdk/types/trieve_knowledge_base_vector_store_search_plan.rb +95 -0
- data/lib/vapi_server_sdk/types/trieve_knowledge_base_vector_store_search_plan_search_type.rb +12 -0
- data/lib/vapi_server_sdk/types/twilio_credential.rb +12 -2
- data/lib/vapi_server_sdk/types/update_anthropic_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_anyscale_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_assembly_ai_credential_dto.rb +74 -0
- data/lib/vapi_server_sdk/types/update_azure_credential_dto.rb +95 -0
- data/lib/vapi_server_sdk/types/update_azure_credential_dto_region.rb +23 -0
- data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto.rb +13 -3
- data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_models_item.rb +1 -0
- data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_region.rb +1 -0
- data/lib/vapi_server_sdk/types/update_byo_sip_trunk_credential_dto.rb +31 -11
- data/lib/vapi_server_sdk/types/update_cartesia_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_custom_llm_credential_dto.rb +31 -2
- data/lib/vapi_server_sdk/types/update_deep_infra_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_deepgram_credential_dto.rb +9 -2
- data/lib/vapi_server_sdk/types/update_eleven_labs_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_gcp_credential_dto.rb +10 -10
- data/lib/vapi_server_sdk/types/update_gladia_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_go_high_level_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_google_credential_dto.rb +76 -0
- data/lib/vapi_server_sdk/types/update_groq_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_inflection_ai_credential_dto.rb +76 -0
- data/lib/vapi_server_sdk/types/update_langfuse_credential_dto.rb +96 -0
- data/lib/vapi_server_sdk/types/update_lmnt_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_make_credential_dto.rb +17 -2
- data/lib/vapi_server_sdk/types/update_open_ai_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_open_router_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_org_dto.rb +21 -2
- data/lib/vapi_server_sdk/types/update_org_dto_channel.rb +10 -0
- data/lib/vapi_server_sdk/types/update_perplexity_ai_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_play_ht_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_rime_ai_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_runpod_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_s_3_credential_dto.rb +13 -3
- data/lib/vapi_server_sdk/types/update_tavus_credential_dto.rb +74 -0
- data/lib/vapi_server_sdk/types/update_together_ai_credential_dto.rb +11 -2
- data/lib/vapi_server_sdk/types/update_twilio_credential_dto.rb +16 -2
- data/lib/vapi_server_sdk/types/update_vonage_credential_dto.rb +16 -2
- data/lib/vapi_server_sdk/types/update_x_ai_credential_dto.rb +76 -0
- data/lib/vapi_server_sdk/types/vapi_cost.rb +10 -2
- data/lib/vapi_server_sdk/types/vapi_cost_sub_type.rb +9 -0
- data/lib/vapi_server_sdk/types/vapi_model.rb +24 -16
- data/lib/vapi_server_sdk/types/vapi_phone_number.rb +20 -2
- data/lib/vapi_server_sdk/types/vonage_credential.rb +12 -2
- data/lib/vapi_server_sdk/types/webhook_credential.rb +134 -0
- data/lib/vapi_server_sdk/types/x_ai_credential.rb +113 -0
- data/lib/vapi_server_sdk/types/xai_model.rb +177 -0
- data/lib/vapi_server_sdk/types/xai_model_tools_item.rb +159 -0
- data/lib/vapi_server_sdk.rb +7 -0
- metadata +167 -8
@@ -0,0 +1,185 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "create_computer_tool_dto_messages_item"
|
4
|
+
require_relative "open_ai_function"
|
5
|
+
require_relative "server"
|
6
|
+
require "ostruct"
|
7
|
+
require "json"
|
8
|
+
|
9
|
+
module Vapi
|
10
|
+
class CreateComputerToolDto
|
11
|
+
# @return [Boolean] This determines if the tool is async.
|
12
|
+
# If async, the assistant will move forward without waiting for your server to
|
13
|
+
# respond. This is useful if you just want to trigger something on your server.
|
14
|
+
# If sync, the assistant will wait for your server to respond. This is useful if
|
15
|
+
# want assistant to respond with the result from your server.
|
16
|
+
# Defaults to synchronous (`false`).
|
17
|
+
attr_reader :async
|
18
|
+
# @return [Array<Vapi::CreateComputerToolDtoMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
|
19
|
+
# For some tools, this is auto-filled based on special fields like
|
20
|
+
# `tool.destinations`. For others like the function tool, these can be custom
|
21
|
+
# configured.
|
22
|
+
attr_reader :messages
|
23
|
+
# @return [String] The sub type of tool.
|
24
|
+
attr_reader :sub_type
|
25
|
+
# @return [String] The name of the tool, fixed to 'computer'
|
26
|
+
attr_reader :name
|
27
|
+
# @return [Float] The display width in pixels
|
28
|
+
attr_reader :display_width_px
|
29
|
+
# @return [Float] The display height in pixels
|
30
|
+
attr_reader :display_height_px
|
31
|
+
# @return [Float] Optional display number
|
32
|
+
attr_reader :display_number
|
33
|
+
# @return [Vapi::OpenAiFunction] This is the function definition of the tool.
|
34
|
+
# For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
|
35
|
+
# tool-specific fields like `tool.destinations`. But, even in those cases, you can
|
36
|
+
# provide a custom function definition for advanced use cases.
|
37
|
+
# An example of an advanced use case is if you want to customize the message
|
38
|
+
# that's spoken for `endCall` tool. You can specify a function where it returns an
|
39
|
+
# argument "reason". Then, in `messages` array, you can have many
|
40
|
+
# "request-complete" messages. One of these messages will be triggered if the
|
41
|
+
# `messages[].conditions` matches the "reason" argument.
|
42
|
+
attr_reader :function
|
43
|
+
# @return [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
|
44
|
+
# All requests will be sent with the call object among other things. You can find
|
45
|
+
# more details in the Server URL documentation.
|
46
|
+
# This overrides the serverUrl set on the org and the phoneNumber. Order of
|
47
|
+
# precedence: highest tool.server.url, then assistant.serverUrl, then
|
48
|
+
# phoneNumber.serverUrl, then org.serverUrl.
|
49
|
+
attr_reader :server
|
50
|
+
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
51
|
+
attr_reader :additional_properties
|
52
|
+
# @return [Object]
|
53
|
+
attr_reader :_field_set
|
54
|
+
protected :_field_set
|
55
|
+
|
56
|
+
OMIT = Object.new
|
57
|
+
|
58
|
+
# @param async [Boolean] This determines if the tool is async.
|
59
|
+
# If async, the assistant will move forward without waiting for your server to
|
60
|
+
# respond. This is useful if you just want to trigger something on your server.
|
61
|
+
# If sync, the assistant will wait for your server to respond. This is useful if
|
62
|
+
# want assistant to respond with the result from your server.
|
63
|
+
# Defaults to synchronous (`false`).
|
64
|
+
# @param messages [Array<Vapi::CreateComputerToolDtoMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
|
65
|
+
# For some tools, this is auto-filled based on special fields like
|
66
|
+
# `tool.destinations`. For others like the function tool, these can be custom
|
67
|
+
# configured.
|
68
|
+
# @param sub_type [String] The sub type of tool.
|
69
|
+
# @param name [String] The name of the tool, fixed to 'computer'
|
70
|
+
# @param display_width_px [Float] The display width in pixels
|
71
|
+
# @param display_height_px [Float] The display height in pixels
|
72
|
+
# @param display_number [Float] Optional display number
|
73
|
+
# @param function [Vapi::OpenAiFunction] This is the function definition of the tool.
|
74
|
+
# For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
|
75
|
+
# tool-specific fields like `tool.destinations`. But, even in those cases, you can
|
76
|
+
# provide a custom function definition for advanced use cases.
|
77
|
+
# An example of an advanced use case is if you want to customize the message
|
78
|
+
# that's spoken for `endCall` tool. You can specify a function where it returns an
|
79
|
+
# argument "reason". Then, in `messages` array, you can have many
|
80
|
+
# "request-complete" messages. One of these messages will be triggered if the
|
81
|
+
# `messages[].conditions` matches the "reason" argument.
|
82
|
+
# @param server [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
|
83
|
+
# All requests will be sent with the call object among other things. You can find
|
84
|
+
# more details in the Server URL documentation.
|
85
|
+
# This overrides the serverUrl set on the org and the phoneNumber. Order of
|
86
|
+
# precedence: highest tool.server.url, then assistant.serverUrl, then
|
87
|
+
# phoneNumber.serverUrl, then org.serverUrl.
|
88
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
89
|
+
# @return [Vapi::CreateComputerToolDto]
|
90
|
+
def initialize(sub_type:, name:, display_width_px:, display_height_px:, async: OMIT, messages: OMIT,
|
91
|
+
display_number: OMIT, function: OMIT, server: OMIT, additional_properties: nil)
|
92
|
+
@async = async if async != OMIT
|
93
|
+
@messages = messages if messages != OMIT
|
94
|
+
@sub_type = sub_type
|
95
|
+
@name = name
|
96
|
+
@display_width_px = display_width_px
|
97
|
+
@display_height_px = display_height_px
|
98
|
+
@display_number = display_number if display_number != OMIT
|
99
|
+
@function = function if function != OMIT
|
100
|
+
@server = server if server != OMIT
|
101
|
+
@additional_properties = additional_properties
|
102
|
+
@_field_set = {
|
103
|
+
"async": async,
|
104
|
+
"messages": messages,
|
105
|
+
"subType": sub_type,
|
106
|
+
"name": name,
|
107
|
+
"displayWidthPx": display_width_px,
|
108
|
+
"displayHeightPx": display_height_px,
|
109
|
+
"displayNumber": display_number,
|
110
|
+
"function": function,
|
111
|
+
"server": server
|
112
|
+
}.reject do |_k, v|
|
113
|
+
v == OMIT
|
114
|
+
end
|
115
|
+
end
|
116
|
+
|
117
|
+
# Deserialize a JSON object to an instance of CreateComputerToolDto
|
118
|
+
#
|
119
|
+
# @param json_object [String]
|
120
|
+
# @return [Vapi::CreateComputerToolDto]
|
121
|
+
def self.from_json(json_object:)
|
122
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
123
|
+
parsed_json = JSON.parse(json_object)
|
124
|
+
async = parsed_json["async"]
|
125
|
+
messages = parsed_json["messages"]&.map do |item|
|
126
|
+
item = item.to_json
|
127
|
+
Vapi::CreateComputerToolDtoMessagesItem.from_json(json_object: item)
|
128
|
+
end
|
129
|
+
sub_type = parsed_json["subType"]
|
130
|
+
name = parsed_json["name"]
|
131
|
+
display_width_px = parsed_json["displayWidthPx"]
|
132
|
+
display_height_px = parsed_json["displayHeightPx"]
|
133
|
+
display_number = parsed_json["displayNumber"]
|
134
|
+
if parsed_json["function"].nil?
|
135
|
+
function = nil
|
136
|
+
else
|
137
|
+
function = parsed_json["function"].to_json
|
138
|
+
function = Vapi::OpenAiFunction.from_json(json_object: function)
|
139
|
+
end
|
140
|
+
if parsed_json["server"].nil?
|
141
|
+
server = nil
|
142
|
+
else
|
143
|
+
server = parsed_json["server"].to_json
|
144
|
+
server = Vapi::Server.from_json(json_object: server)
|
145
|
+
end
|
146
|
+
new(
|
147
|
+
async: async,
|
148
|
+
messages: messages,
|
149
|
+
sub_type: sub_type,
|
150
|
+
name: name,
|
151
|
+
display_width_px: display_width_px,
|
152
|
+
display_height_px: display_height_px,
|
153
|
+
display_number: display_number,
|
154
|
+
function: function,
|
155
|
+
server: server,
|
156
|
+
additional_properties: struct
|
157
|
+
)
|
158
|
+
end
|
159
|
+
|
160
|
+
# Serialize an instance of CreateComputerToolDto to a JSON object
|
161
|
+
#
|
162
|
+
# @return [String]
|
163
|
+
def to_json(*_args)
|
164
|
+
@_field_set&.to_json
|
165
|
+
end
|
166
|
+
|
167
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
168
|
+
# hash and check each fields type against the current object's property
|
169
|
+
# definitions.
|
170
|
+
#
|
171
|
+
# @param obj [Object]
|
172
|
+
# @return [Void]
|
173
|
+
def self.validate_raw(obj:)
|
174
|
+
obj.async&.is_a?(Boolean) != false || raise("Passed value for field obj.async is not the expected type, validation failed.")
|
175
|
+
obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
|
176
|
+
obj.sub_type.is_a?(String) != false || raise("Passed value for field obj.sub_type is not the expected type, validation failed.")
|
177
|
+
obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
178
|
+
obj.display_width_px.is_a?(Float) != false || raise("Passed value for field obj.display_width_px is not the expected type, validation failed.")
|
179
|
+
obj.display_height_px.is_a?(Float) != false || raise("Passed value for field obj.display_height_px is not the expected type, validation failed.")
|
180
|
+
obj.display_number&.is_a?(Float) != false || raise("Passed value for field obj.display_number is not the expected type, validation failed.")
|
181
|
+
obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
|
182
|
+
obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
|
183
|
+
end
|
184
|
+
end
|
185
|
+
end
|
@@ -0,0 +1,120 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
require_relative "tool_message_start"
|
5
|
+
require_relative "tool_message_complete"
|
6
|
+
require_relative "tool_message_failed"
|
7
|
+
require_relative "tool_message_delayed"
|
8
|
+
|
9
|
+
module Vapi
|
10
|
+
class CreateComputerToolDtoMessagesItem
|
11
|
+
# @return [Object]
|
12
|
+
attr_reader :member
|
13
|
+
# @return [String]
|
14
|
+
attr_reader :discriminant
|
15
|
+
|
16
|
+
private_class_method :new
|
17
|
+
alias kind_of? is_a?
|
18
|
+
|
19
|
+
# @param member [Object]
|
20
|
+
# @param discriminant [String]
|
21
|
+
# @return [Vapi::CreateComputerToolDtoMessagesItem]
|
22
|
+
def initialize(member:, discriminant:)
|
23
|
+
@member = member
|
24
|
+
@discriminant = discriminant
|
25
|
+
end
|
26
|
+
|
27
|
+
# Deserialize a JSON object to an instance of CreateComputerToolDtoMessagesItem
|
28
|
+
#
|
29
|
+
# @param json_object [String]
|
30
|
+
# @return [Vapi::CreateComputerToolDtoMessagesItem]
|
31
|
+
def self.from_json(json_object:)
|
32
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
33
|
+
member = case struct.type
|
34
|
+
when "request-start"
|
35
|
+
Vapi::ToolMessageStart.from_json(json_object: json_object)
|
36
|
+
when "request-complete"
|
37
|
+
Vapi::ToolMessageComplete.from_json(json_object: json_object)
|
38
|
+
when "request-failed"
|
39
|
+
Vapi::ToolMessageFailed.from_json(json_object: json_object)
|
40
|
+
when "request-response-delayed"
|
41
|
+
Vapi::ToolMessageDelayed.from_json(json_object: json_object)
|
42
|
+
else
|
43
|
+
Vapi::ToolMessageStart.from_json(json_object: json_object)
|
44
|
+
end
|
45
|
+
new(member: member, discriminant: struct.type)
|
46
|
+
end
|
47
|
+
|
48
|
+
# For Union Types, to_json functionality is delegated to the wrapped member.
|
49
|
+
#
|
50
|
+
# @return [String]
|
51
|
+
def to_json(*_args)
|
52
|
+
case @discriminant
|
53
|
+
when "request-start"
|
54
|
+
{ **@member.to_json, type: @discriminant }.to_json
|
55
|
+
when "request-complete"
|
56
|
+
{ **@member.to_json, type: @discriminant }.to_json
|
57
|
+
when "request-failed"
|
58
|
+
{ **@member.to_json, type: @discriminant }.to_json
|
59
|
+
when "request-response-delayed"
|
60
|
+
{ **@member.to_json, type: @discriminant }.to_json
|
61
|
+
else
|
62
|
+
{ "type": @discriminant, value: @member }.to_json
|
63
|
+
end
|
64
|
+
@member.to_json
|
65
|
+
end
|
66
|
+
|
67
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
68
|
+
# hash and check each fields type against the current object's property
|
69
|
+
# definitions.
|
70
|
+
#
|
71
|
+
# @param obj [Object]
|
72
|
+
# @return [Void]
|
73
|
+
def self.validate_raw(obj:)
|
74
|
+
case obj.type
|
75
|
+
when "request-start"
|
76
|
+
Vapi::ToolMessageStart.validate_raw(obj: obj)
|
77
|
+
when "request-complete"
|
78
|
+
Vapi::ToolMessageComplete.validate_raw(obj: obj)
|
79
|
+
when "request-failed"
|
80
|
+
Vapi::ToolMessageFailed.validate_raw(obj: obj)
|
81
|
+
when "request-response-delayed"
|
82
|
+
Vapi::ToolMessageDelayed.validate_raw(obj: obj)
|
83
|
+
else
|
84
|
+
raise("Passed value matched no type within the union, validation failed.")
|
85
|
+
end
|
86
|
+
end
|
87
|
+
|
88
|
+
# For Union Types, is_a? functionality is delegated to the wrapped member.
|
89
|
+
#
|
90
|
+
# @param obj [Object]
|
91
|
+
# @return [Boolean]
|
92
|
+
def is_a?(obj)
|
93
|
+
@member.is_a?(obj)
|
94
|
+
end
|
95
|
+
|
96
|
+
# @param member [Vapi::ToolMessageStart]
|
97
|
+
# @return [Vapi::CreateComputerToolDtoMessagesItem]
|
98
|
+
def self.request_start(member:)
|
99
|
+
new(member: member, discriminant: "request-start")
|
100
|
+
end
|
101
|
+
|
102
|
+
# @param member [Vapi::ToolMessageComplete]
|
103
|
+
# @return [Vapi::CreateComputerToolDtoMessagesItem]
|
104
|
+
def self.request_complete(member:)
|
105
|
+
new(member: member, discriminant: "request-complete")
|
106
|
+
end
|
107
|
+
|
108
|
+
# @param member [Vapi::ToolMessageFailed]
|
109
|
+
# @return [Vapi::CreateComputerToolDtoMessagesItem]
|
110
|
+
def self.request_failed(member:)
|
111
|
+
new(member: member, discriminant: "request-failed")
|
112
|
+
end
|
113
|
+
|
114
|
+
# @param member [Vapi::ToolMessageDelayed]
|
115
|
+
# @return [Vapi::CreateComputerToolDtoMessagesItem]
|
116
|
+
def self.request_response_delayed(member:)
|
117
|
+
new(member: member, discriminant: "request-response-delayed")
|
118
|
+
end
|
119
|
+
end
|
120
|
+
end
|
@@ -0,0 +1,137 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "server"
|
4
|
+
require "ostruct"
|
5
|
+
require "json"
|
6
|
+
|
7
|
+
module Vapi
|
8
|
+
class CreateCustomKnowledgeBaseDto
|
9
|
+
# @return [Vapi::Server] /**
|
10
|
+
# This is where the knowledge base request will be sent.
|
11
|
+
# Request Example:
|
12
|
+
# POST https://{server.url}
|
13
|
+
# Content-Type: application/json
|
14
|
+
# {
|
15
|
+
# "messsage": {
|
16
|
+
# "type": "knowledge-base-request",
|
17
|
+
# "messages": [
|
18
|
+
# {
|
19
|
+
# "role": "user",
|
20
|
+
# "content": "Why is ocean blue?"
|
21
|
+
# }
|
22
|
+
# ],
|
23
|
+
# ...other metadata about the call...
|
24
|
+
# }
|
25
|
+
# }
|
26
|
+
# Response Expected:
|
27
|
+
# ```
|
28
|
+
# {
|
29
|
+
# "message": {
|
30
|
+
# "role": "assistant",
|
31
|
+
# "content": "The ocean is blue because water absorbs everything but blue.",
|
32
|
+
# }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK
|
33
|
+
# "documents": [
|
34
|
+
# {
|
35
|
+
# "content": "The ocean is blue primarily because water absorbs colors in
|
36
|
+
# the red part of the light spectrum and scatters the blue light, making it more
|
37
|
+
# visible to our eyes.",
|
38
|
+
# "similarity": 1
|
39
|
+
# },
|
40
|
+
# {
|
41
|
+
# "content": "Blue light is scattered more by the water molecules than other
|
42
|
+
# colors, enhancing the blue appearance of the ocean.",
|
43
|
+
# "similarity": .5
|
44
|
+
# }
|
45
|
+
# ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL
|
46
|
+
# }
|
47
|
+
# ```
|
48
|
+
attr_reader :server
|
49
|
+
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
50
|
+
attr_reader :additional_properties
|
51
|
+
# @return [Object]
|
52
|
+
attr_reader :_field_set
|
53
|
+
protected :_field_set
|
54
|
+
|
55
|
+
OMIT = Object.new
|
56
|
+
|
57
|
+
# @param server [Vapi::Server] /**
|
58
|
+
# This is where the knowledge base request will be sent.
|
59
|
+
# Request Example:
|
60
|
+
# POST https://{server.url}
|
61
|
+
# Content-Type: application/json
|
62
|
+
# {
|
63
|
+
# "messsage": {
|
64
|
+
# "type": "knowledge-base-request",
|
65
|
+
# "messages": [
|
66
|
+
# {
|
67
|
+
# "role": "user",
|
68
|
+
# "content": "Why is ocean blue?"
|
69
|
+
# }
|
70
|
+
# ],
|
71
|
+
# ...other metadata about the call...
|
72
|
+
# }
|
73
|
+
# }
|
74
|
+
# Response Expected:
|
75
|
+
# ```
|
76
|
+
# {
|
77
|
+
# "message": {
|
78
|
+
# "role": "assistant",
|
79
|
+
# "content": "The ocean is blue because water absorbs everything but blue.",
|
80
|
+
# }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK
|
81
|
+
# "documents": [
|
82
|
+
# {
|
83
|
+
# "content": "The ocean is blue primarily because water absorbs colors in
|
84
|
+
# the red part of the light spectrum and scatters the blue light, making it more
|
85
|
+
# visible to our eyes.",
|
86
|
+
# "similarity": 1
|
87
|
+
# },
|
88
|
+
# {
|
89
|
+
# "content": "Blue light is scattered more by the water molecules than other
|
90
|
+
# colors, enhancing the blue appearance of the ocean.",
|
91
|
+
# "similarity": .5
|
92
|
+
# }
|
93
|
+
# ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL
|
94
|
+
# }
|
95
|
+
# ```
|
96
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
97
|
+
# @return [Vapi::CreateCustomKnowledgeBaseDto]
|
98
|
+
def initialize(server:, additional_properties: nil)
|
99
|
+
@server = server
|
100
|
+
@additional_properties = additional_properties
|
101
|
+
@_field_set = { "server": server }
|
102
|
+
end
|
103
|
+
|
104
|
+
# Deserialize a JSON object to an instance of CreateCustomKnowledgeBaseDto
|
105
|
+
#
|
106
|
+
# @param json_object [String]
|
107
|
+
# @return [Vapi::CreateCustomKnowledgeBaseDto]
|
108
|
+
def self.from_json(json_object:)
|
109
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
110
|
+
parsed_json = JSON.parse(json_object)
|
111
|
+
if parsed_json["server"].nil?
|
112
|
+
server = nil
|
113
|
+
else
|
114
|
+
server = parsed_json["server"].to_json
|
115
|
+
server = Vapi::Server.from_json(json_object: server)
|
116
|
+
end
|
117
|
+
new(server: server, additional_properties: struct)
|
118
|
+
end
|
119
|
+
|
120
|
+
# Serialize an instance of CreateCustomKnowledgeBaseDto to a JSON object
|
121
|
+
#
|
122
|
+
# @return [String]
|
123
|
+
def to_json(*_args)
|
124
|
+
@_field_set&.to_json
|
125
|
+
end
|
126
|
+
|
127
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
128
|
+
# hash and check each fields type against the current object's property
|
129
|
+
# definitions.
|
130
|
+
#
|
131
|
+
# @param obj [Object]
|
132
|
+
# @return [Void]
|
133
|
+
def self.validate_raw(obj:)
|
134
|
+
Vapi::Server.validate_raw(obj: obj.server)
|
135
|
+
end
|
136
|
+
end
|
137
|
+
end
|
@@ -1,5 +1,6 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
+
require_relative "o_auth_2_authentication_plan"
|
3
4
|
require "ostruct"
|
4
5
|
require "json"
|
5
6
|
|
@@ -9,6 +10,11 @@ module Vapi
|
|
9
10
|
attr_reader :provider
|
10
11
|
# @return [String] This is not returned in the API.
|
11
12
|
attr_reader :api_key
|
13
|
+
# @return [Vapi::OAuth2AuthenticationPlan] This is the authentication plan. Currently supports OAuth2 RFC 6749. To use
|
14
|
+
# Bearer authentication, use apiKey
|
15
|
+
attr_reader :authentication_plan
|
16
|
+
# @return [String] This is the name of credential. This is just for your reference.
|
17
|
+
attr_reader :name
|
12
18
|
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
13
19
|
attr_reader :additional_properties
|
14
20
|
# @return [Object]
|
@@ -19,13 +25,25 @@ module Vapi
|
|
19
25
|
|
20
26
|
# @param provider [String]
|
21
27
|
# @param api_key [String] This is not returned in the API.
|
28
|
+
# @param authentication_plan [Vapi::OAuth2AuthenticationPlan] This is the authentication plan. Currently supports OAuth2 RFC 6749. To use
|
29
|
+
# Bearer authentication, use apiKey
|
30
|
+
# @param name [String] This is the name of credential. This is just for your reference.
|
22
31
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
23
32
|
# @return [Vapi::CreateCustomLlmCredentialDto]
|
24
|
-
def initialize(provider:, api_key:, additional_properties: nil)
|
33
|
+
def initialize(provider:, api_key:, authentication_plan: OMIT, name: OMIT, additional_properties: nil)
|
25
34
|
@provider = provider
|
26
35
|
@api_key = api_key
|
36
|
+
@authentication_plan = authentication_plan if authentication_plan != OMIT
|
37
|
+
@name = name if name != OMIT
|
27
38
|
@additional_properties = additional_properties
|
28
|
-
@_field_set = {
|
39
|
+
@_field_set = {
|
40
|
+
"provider": provider,
|
41
|
+
"apiKey": api_key,
|
42
|
+
"authenticationPlan": authentication_plan,
|
43
|
+
"name": name
|
44
|
+
}.reject do |_k, v|
|
45
|
+
v == OMIT
|
46
|
+
end
|
29
47
|
end
|
30
48
|
|
31
49
|
# Deserialize a JSON object to an instance of CreateCustomLlmCredentialDto
|
@@ -37,9 +55,18 @@ module Vapi
|
|
37
55
|
parsed_json = JSON.parse(json_object)
|
38
56
|
provider = parsed_json["provider"]
|
39
57
|
api_key = parsed_json["apiKey"]
|
58
|
+
if parsed_json["authenticationPlan"].nil?
|
59
|
+
authentication_plan = nil
|
60
|
+
else
|
61
|
+
authentication_plan = parsed_json["authenticationPlan"].to_json
|
62
|
+
authentication_plan = Vapi::OAuth2AuthenticationPlan.from_json(json_object: authentication_plan)
|
63
|
+
end
|
64
|
+
name = parsed_json["name"]
|
40
65
|
new(
|
41
66
|
provider: provider,
|
42
67
|
api_key: api_key,
|
68
|
+
authentication_plan: authentication_plan,
|
69
|
+
name: name,
|
43
70
|
additional_properties: struct
|
44
71
|
)
|
45
72
|
end
|
@@ -60,6 +87,8 @@ module Vapi
|
|
60
87
|
def self.validate_raw(obj:)
|
61
88
|
obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
|
62
89
|
obj.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key is not the expected type, validation failed.")
|
90
|
+
obj.authentication_plan.nil? || Vapi::OAuth2AuthenticationPlan.validate_raw(obj: obj.authentication_plan)
|
91
|
+
obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
63
92
|
end
|
64
93
|
end
|
65
94
|
end
|
@@ -9,6 +9,8 @@ module Vapi
|
|
9
9
|
attr_reader :provider
|
10
10
|
# @return [String] This is not returned in the API.
|
11
11
|
attr_reader :api_key
|
12
|
+
# @return [String] This is the name of credential. This is just for your reference.
|
13
|
+
attr_reader :name
|
12
14
|
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
13
15
|
attr_reader :additional_properties
|
14
16
|
# @return [Object]
|
@@ -19,13 +21,17 @@ module Vapi
|
|
19
21
|
|
20
22
|
# @param provider [String]
|
21
23
|
# @param api_key [String] This is not returned in the API.
|
24
|
+
# @param name [String] This is the name of credential. This is just for your reference.
|
22
25
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
23
26
|
# @return [Vapi::CreateDeepInfraCredentialDto]
|
24
|
-
def initialize(provider:, api_key:, additional_properties: nil)
|
27
|
+
def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
|
25
28
|
@provider = provider
|
26
29
|
@api_key = api_key
|
30
|
+
@name = name if name != OMIT
|
27
31
|
@additional_properties = additional_properties
|
28
|
-
@_field_set = { "provider": provider, "apiKey": api_key }
|
32
|
+
@_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
|
33
|
+
v == OMIT
|
34
|
+
end
|
29
35
|
end
|
30
36
|
|
31
37
|
# Deserialize a JSON object to an instance of CreateDeepInfraCredentialDto
|
@@ -37,9 +43,11 @@ module Vapi
|
|
37
43
|
parsed_json = JSON.parse(json_object)
|
38
44
|
provider = parsed_json["provider"]
|
39
45
|
api_key = parsed_json["apiKey"]
|
46
|
+
name = parsed_json["name"]
|
40
47
|
new(
|
41
48
|
provider: provider,
|
42
49
|
api_key: api_key,
|
50
|
+
name: name,
|
43
51
|
additional_properties: struct
|
44
52
|
)
|
45
53
|
end
|
@@ -60,6 +68,7 @@ module Vapi
|
|
60
68
|
def self.validate_raw(obj:)
|
61
69
|
obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
|
62
70
|
obj.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key is not the expected type, validation failed.")
|
71
|
+
obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
63
72
|
end
|
64
73
|
end
|
65
74
|
end
|
@@ -12,6 +12,8 @@ module Vapi
|
|
12
12
|
# @return [String] This can be used to point to an onprem Deepgram instance. Defaults to
|
13
13
|
# api.deepgram.com.
|
14
14
|
attr_reader :api_url
|
15
|
+
# @return [String] This is the name of credential. This is just for your reference.
|
16
|
+
attr_reader :name
|
15
17
|
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
16
18
|
attr_reader :additional_properties
|
17
19
|
# @return [Object]
|
@@ -24,14 +26,16 @@ module Vapi
|
|
24
26
|
# @param api_key [String] This is not returned in the API.
|
25
27
|
# @param api_url [String] This can be used to point to an onprem Deepgram instance. Defaults to
|
26
28
|
# api.deepgram.com.
|
29
|
+
# @param name [String] This is the name of credential. This is just for your reference.
|
27
30
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
28
31
|
# @return [Vapi::CreateDeepgramCredentialDto]
|
29
|
-
def initialize(provider:, api_key:, api_url: OMIT, additional_properties: nil)
|
32
|
+
def initialize(provider:, api_key:, api_url: OMIT, name: OMIT, additional_properties: nil)
|
30
33
|
@provider = provider
|
31
34
|
@api_key = api_key
|
32
35
|
@api_url = api_url if api_url != OMIT
|
36
|
+
@name = name if name != OMIT
|
33
37
|
@additional_properties = additional_properties
|
34
|
-
@_field_set = { "provider": provider, "apiKey": api_key, "apiUrl": api_url }.reject do |_k, v|
|
38
|
+
@_field_set = { "provider": provider, "apiKey": api_key, "apiUrl": api_url, "name": name }.reject do |_k, v|
|
35
39
|
v == OMIT
|
36
40
|
end
|
37
41
|
end
|
@@ -46,10 +50,12 @@ module Vapi
|
|
46
50
|
provider = parsed_json["provider"]
|
47
51
|
api_key = parsed_json["apiKey"]
|
48
52
|
api_url = parsed_json["apiUrl"]
|
53
|
+
name = parsed_json["name"]
|
49
54
|
new(
|
50
55
|
provider: provider,
|
51
56
|
api_key: api_key,
|
52
57
|
api_url: api_url,
|
58
|
+
name: name,
|
53
59
|
additional_properties: struct
|
54
60
|
)
|
55
61
|
end
|
@@ -71,6 +77,7 @@ module Vapi
|
|
71
77
|
obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
|
72
78
|
obj.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key is not the expected type, validation failed.")
|
73
79
|
obj.api_url&.is_a?(String) != false || raise("Passed value for field obj.api_url is not the expected type, validation failed.")
|
80
|
+
obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
74
81
|
end
|
75
82
|
end
|
76
83
|
end
|
@@ -9,6 +9,8 @@ module Vapi
|
|
9
9
|
attr_reader :provider
|
10
10
|
# @return [String] This is not returned in the API.
|
11
11
|
attr_reader :api_key
|
12
|
+
# @return [String] This is the name of credential. This is just for your reference.
|
13
|
+
attr_reader :name
|
12
14
|
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
13
15
|
attr_reader :additional_properties
|
14
16
|
# @return [Object]
|
@@ -19,13 +21,17 @@ module Vapi
|
|
19
21
|
|
20
22
|
# @param provider [String]
|
21
23
|
# @param api_key [String] This is not returned in the API.
|
24
|
+
# @param name [String] This is the name of credential. This is just for your reference.
|
22
25
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
23
26
|
# @return [Vapi::CreateElevenLabsCredentialDto]
|
24
|
-
def initialize(provider:, api_key:, additional_properties: nil)
|
27
|
+
def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
|
25
28
|
@provider = provider
|
26
29
|
@api_key = api_key
|
30
|
+
@name = name if name != OMIT
|
27
31
|
@additional_properties = additional_properties
|
28
|
-
@_field_set = { "provider": provider, "apiKey": api_key }
|
32
|
+
@_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
|
33
|
+
v == OMIT
|
34
|
+
end
|
29
35
|
end
|
30
36
|
|
31
37
|
# Deserialize a JSON object to an instance of CreateElevenLabsCredentialDto
|
@@ -37,9 +43,11 @@ module Vapi
|
|
37
43
|
parsed_json = JSON.parse(json_object)
|
38
44
|
provider = parsed_json["provider"]
|
39
45
|
api_key = parsed_json["apiKey"]
|
46
|
+
name = parsed_json["name"]
|
40
47
|
new(
|
41
48
|
provider: provider,
|
42
49
|
api_key: api_key,
|
50
|
+
name: name,
|
43
51
|
additional_properties: struct
|
44
52
|
)
|
45
53
|
end
|
@@ -60,6 +68,7 @@ module Vapi
|
|
60
68
|
def self.validate_raw(obj:)
|
61
69
|
obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
|
62
70
|
obj.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key is not the expected type, validation failed.")
|
71
|
+
obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
63
72
|
end
|
64
73
|
end
|
65
74
|
end
|