@elevenlabs/elevenlabs-js 2.0.1 → 2.2.0

package/.mock/definition/conversationalAi/agents/knowledgeBase.yml

@@ -0,0 +1,32 @@
+imports:
+  root: ../../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    size:
+      path: /v1/convai/agent/{agent_id}/knowledge-base/size
+      method: GET
+      auth: false
+      docs: Returns the number of pages in the agent's knowledge base.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        agent_id: string
+      display-name: Returns The Size Of The Agent'S Knowledge Base
+      response:
+        docs: Successful Response
+        type: root.GetAgentKnowledgebaseSizeResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            agent_id: agent_id
+          response:
+            body:
+              number_of_pages: 1.1
+      audiences:
+        - convai
+  source:
+    openapi: openapi.json

package/.mock/definition/conversationalAi/agents/link.yml

@@ -29,9 +29,10 @@ service:
             body:
               agent_id: J3Pbu5gP6NNKBscdCdwB
               token:
-                agent_id: J3Pbu5gP6NNKBscdCdwB
+                agent_id: agent_J3Pbu5gP6NNKBscdCdwB
                 conversation_token: '1234567890'
                 expiration_time_unix_secs: 1716153600
+                conversation_id: conv_J3Pbu5gP6NNKBscdCdwB
                 purpose: signed_url
       audiences:
         - convai

package/.mock/definition/conversationalAi/agents/llmUsage.yml

@@ -0,0 +1,51 @@
+imports:
+  root: ../../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    calculate:
+      path: /v1/convai/agent/{agent_id}/llm-usage/calculate
+      method: POST
+      auth: false
+      docs: Calculates expected number of LLM tokens needed for the specified agent.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        agent_id: string
+      display-name: Calculate Expected Llm Usage For An Agent
+      request:
+        name: LlmUsageCalculatorRequestModel
+        body:
+          properties:
+            prompt_length:
+              type: optional<integer>
+              docs: Length of the prompt in characters.
+            number_of_pages:
+              type: optional<integer>
+              docs: >-
+                Pages of content in pdf documents OR urls in agent's Knowledge
+                Base.
+            rag_enabled:
+              type: optional<boolean>
+              docs: Whether RAG is enabled.
+        content-type: application/json
+      response:
+        docs: Successful Response
+        type: root.LlmUsageCalculatorResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            agent_id: agent_id
+          request: {}
+          response:
+            body:
+              llm_prices:
+                - llm: gpt-4o-mini
+                  price_per_minute: 1.1
+      audiences:
+        - convai
+  source:
+    openapi: openapi.json

package/.mock/definition/conversationalAi/agents/widget.yml

@@ -39,6 +39,7 @@ service:
               agent_id: agent_id
               widget_config:
                 variant: full
+                placement: top-left
                 expandable: never
                 avatar:
                   color_1: '#2792dc'
@@ -68,9 +69,38 @@ service:
                 disable_banner: false
                 override_link: override_link
                 mic_muting_enabled: false
+                transcript_enabled: true
+                text_input_enabled: true
+                text_contents:
+                  main_label: main_label
+                  start_call: start_call
+                  new_call: new_call
+                  end_call: end_call
+                  mute_microphone: mute_microphone
+                  change_language: change_language
+                  collapse: collapse
+                  expand: expand
+                  copied: copied
+                  accept_terms: accept_terms
+                  dismiss_terms: dismiss_terms
+                  listening_status: listening_status
+                  speaking_status: speaking_status
+                  connecting_status: connecting_status
+                  input_label: input_label
+                  input_placeholder: input_placeholder
+                  user_ended_conversation: user_ended_conversation
+                  agent_ended_conversation: agent_ended_conversation
+                  conversation_id: conversation_id
+                  error_occurred: error_occurred
+                  copy_id: copy_id
                 language: language
                 supported_language_overrides:
                   - supported_language_overrides
+                language_presets:
+                  key: {}
+                text_only: true
+                supports_text_only: true
+                first_message: first_message
       audiences:
         - convai
   source:

package/.mock/definition/conversationalAi/agents.yml

@@ -85,6 +85,9 @@ service:
                 tts:
                   model_id: eleven_turbo_v2
                   voice_id: cjVigY5qzO86Huf0OWal
+                  supported_voices:
+                    - label: label
+                      voice_id: voice_id
                   agent_output_audio_format: pcm_16000
                   optimize_streaming_latency: 3
                   stability: 0.5
@@ -100,7 +103,16 @@ service:
                     - interruption
                 language_presets:
                   key:
-                    overrides: {}
+                    overrides:
+                      tts:
+                        voice_id: cjVigY5qzO86Huf0OWal
+                      agent:
+                        first_message: Hello, how can I help you today?
+                        language: en
+                        prompt:
+                          prompt: >-
+                            You are a helpful assistant that can answer
+                            questions about the topic of the conversation.
                 agent:
                   first_message: Hello, how can I help you today?
                   language: en
@@ -146,7 +158,8 @@ service:
                         about the topic of the conversation.
                       use_knowledge_base: false
                 widget:
-                  variant: compact
+                  variant: tiny
+                  placement: top-left
                   expandable: never
                   avatar:
                     color_1: '#2792dc'
@@ -176,8 +189,13 @@ service:
                   disable_banner: true
                   override_link: override_link
                   mic_muting_enabled: true
+                  transcript_enabled: true
+                  text_input_enabled: true
                   language_selector: false
+                  supports_text_only: true
                   custom_avatar_path: https://example.com/avatar.png
+                  language_presets:
+                    key: {}
                 data_collection:
                   key:
                     type: boolean
@@ -185,16 +203,6 @@ service:
                     dynamic_variable: Dynamic variable
                     constant_value: Constant value
                 overrides:
-                  conversation_config_override:
-                    agent:
-                      prompt:
-                        prompt: false
-                      first_message: false
-                      language: false
-                    tts:
-                      voice_id: false
-                    conversation:
-                      text_only: false
                   custom_llm_extra_body: true
                   enable_conversation_initiation_client_data_from_webhook: true
                 call_limits:
@@ -274,9 +282,13 @@ service:
         body:
           properties:
             conversation_config:
-              type: optional<unknown>
+              type: optional<root.ConversationalConfig>
+              docs: Conversation configuration for an agent
             platform_settings:
-              type: optional<unknown>
+              type: optional<root.AgentPlatformSettingsRequestModel>
+              docs: >-
+                Platform settings for the agent are all settings that aren't
+                related to the conversation orchestration and content.
             name:
               type: optional<string>
               docs: A name to make the agent easier to find
@@ -313,6 +325,9 @@ service:
                 tts:
                   model_id: eleven_turbo_v2
                   voice_id: cjVigY5qzO86Huf0OWal
+                  supported_voices:
+                    - label: label
+                      voice_id: voice_id
                   agent_output_audio_format: pcm_16000
                   optimize_streaming_latency: 3
                   stability: 0.5
@@ -328,7 +343,16 @@ service:
                     - interruption
                 language_presets:
                   key:
-                    overrides: {}
+                    overrides:
+                      tts:
+                        voice_id: cjVigY5qzO86Huf0OWal
+                      agent:
+                        first_message: Hello, how can I help you today?
+                        language: en
+                        prompt:
+                          prompt: >-
+                            You are a helpful assistant that can answer
+                            questions about the topic of the conversation.
                 agent:
                   first_message: Hello, how can I help you today?
                   language: en
@@ -374,7 +398,8 @@ service:
                         about the topic of the conversation.
                       use_knowledge_base: false
                 widget:
-                  variant: compact
+                  variant: tiny
+                  placement: top-left
                   expandable: never
                   avatar:
                     color_1: '#2792dc'
@@ -404,8 +429,13 @@ service:
                   disable_banner: true
                   override_link: override_link
                   mic_muting_enabled: true
+                  transcript_enabled: true
+                  text_input_enabled: true
                   language_selector: false
+                  supports_text_only: true
                   custom_avatar_path: https://example.com/avatar.png
+                  language_presets:
+                    key: {}
                 data_collection:
                   key:
                     type: boolean
@@ -413,16 +443,6 @@ service:
                     dynamic_variable: Dynamic variable
                     constant_value: Constant value
                 overrides:
-                  conversation_config_override:
-                    agent:
-                      prompt:
-                        prompt: false
-                      first_message: false
-                      language: false
-                    tts:
-                      voice_id: false
-                    conversation:
-                      text_only: false
                   custom_llm_extra_body: true
                   enable_conversation_initiation_client_data_from_webhook: true
                 call_limits:
@@ -578,7 +598,6 @@ service:
                     score: like
                     time_in_call_secs: 1
                   llm_override: llm_override
-                  source_medium: audio
                   time_in_call_secs: 1
                   rag_retrieval_info:
                     chunks:
@@ -590,6 +609,7 @@ service:
                     rag_latency_secs: 1.1
                   interrupted: true
                   original_message: original_message
+                  source_medium: audio
               analysis:
                 evaluation_criteria_results:
                   key:

package/.mock/definition/conversationalAi/batchCalls.yml

@@ -133,6 +133,89 @@ service:
                   created_at_unix: 1
                   updated_at_unix: 1
                   conversation_id: conversation_id
+                  conversation_initiation_client_data:
+                    conversation_config_override:
+                      tts:
+                        voice_id: cjVigY5qzO86Huf0OWal
+                      agent:
+                        first_message: Hello, how can I help you today?
+                        language: en
+                        prompt:
+                          prompt: >-
+                            You are a helpful assistant that can answer
+                            questions about the topic of the conversation.
+      audiences:
+        - convai
+    cancel:
+      path: /v1/convai/batch-calling/{batch_id}/cancel
+      method: POST
+      auth: false
+      docs: Cancel a running batch call and set all recipients to cancelled status.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        batch_id: string
+      display-name: Cancel A Batch Call.
+      response:
+        docs: Successful Response
+        type: root.BatchCallResponse
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            batch_id: batch_id
+          response:
+            body:
+              id: id
+              phone_number_id: phone_number_id
+              phone_provider: twilio
+              name: name
+              agent_id: agent_id
+              created_at_unix: 1
+              scheduled_time_unix: 1
+              total_calls_dispatched: 1
+              total_calls_scheduled: 1
+              last_updated_at_unix: 1
+              status: pending
+              agent_name: agent_name
+      audiences:
+        - convai
+    retry:
+      path: /v1/convai/batch-calling/{batch_id}/retry
+      method: POST
+      auth: false
+      docs: >-
+        Retry a batch call by setting completed recipients back to pending
+        status.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        batch_id: string
+      display-name: Retry A Batch Call.
+      response:
+        docs: Successful Response
+        type: root.BatchCallResponse
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            batch_id: batch_id
+          response:
+            body:
+              id: id
+              phone_number_id: phone_number_id
+              phone_provider: twilio
+              name: name
+              agent_id: agent_id
+              created_at_unix: 1
+              scheduled_time_unix: 1
+              total_calls_dispatched: 1
+              total_calls_scheduled: 1
+              last_updated_at_unix: 1
+              status: pending
+              agent_name: agent_name
       audiences:
         - convai
   source:

package/.mock/definition/conversationalAi/knowledgeBase/document.yml

@@ -29,7 +29,7 @@ service:
         content-type: application/json
       response:
         docs: Successful Response
-        type: root.RagIndexResponseModel
+        type: root.RagDocumentIndexResponseModel
         status-code: 200
       errors:
         - root.UnprocessableEntityError
@@ -40,8 +40,12 @@ service:
             model: e5_mistral_7b_instruct
           response:
             body:
+              id: id
+              model: e5_mistral_7b_instruct
               status: created
               progress_percentage: 1.1
+              document_model_index_usage:
+                used_bytes: 1
       audiences:
         - convai
   source:

package/.mock/definition/conversationalAi/knowledgeBase/documents.yml

@@ -42,7 +42,6 @@ service:
             body:
               id: id
               name: name
-              prompt_injectable: true
       audiences:
         - convai
     create_from_file:
@@ -80,7 +79,6 @@ service:
             body:
               id: id
               name: name
-              prompt_injectable: true
       audiences:
         - convai
     create_from_text:
@@ -117,7 +115,6 @@ service:
             body:
               id: id
               name: name
-              prompt_injectable: true
       audiences:
         - convai
     get:
@@ -153,7 +150,8 @@ service:
                 created_at_unix_secs: 1
                 last_updated_at_unix_secs: 1
                 size_bytes: 1
-              prompt_injectable: true
+              supported_usages:
+                - prompt
               access_info:
                 is_creator: true
                 creator_name: John Doe
@@ -178,6 +176,16 @@ service:
             The id of a document from the knowledge base. This is returned on
             document addition.
       display-name: Delete Knowledge Base Document
+      request:
+        name: DocumentsDeleteRequest
+        query-parameters:
+          force:
+            type: optional<boolean>
+            default: false
+            docs: >-
+              If set to true, the document will be deleted regardless of whether
+              it is used by any agents and it will be deleted from the dependent
+              agents.
       response:
         docs: Successful Response
         type: unknown
@@ -235,7 +243,8 @@ service:
                 created_at_unix_secs: 1
                 last_updated_at_unix_secs: 1
                 size_bytes: 1
-              prompt_injectable: true
+              supported_usages:
+                - prompt
               access_info:
                 is_creator: true
                 creator_name: John Doe

package/.mock/definition/conversationalAi/knowledgeBase.yml

@@ -66,7 +66,8 @@ service:
                     created_at_unix_secs: 1
                     last_updated_at_unix_secs: 1
                     size_bytes: 1
-                  prompt_injectable: true
+                  supported_usages:
+                    - prompt
                   access_info:
                     is_creator: true
                     creator_name: John Doe

package/.mock/definition/conversationalAi/llmUsage.yml

@@ -0,0 +1,52 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    calculate:
+      path: /v1/convai/llm-usage/calculate
+      method: POST
+      auth: false
+      docs: >-
+        Returns a list of LLM models and the expected cost for using them based
+        on the provided values.
+      source:
+        openapi: openapi.json
+      display-name: Calculate Expected Llm Usage
+      request:
+        name: LlmUsageCalculatorPublicRequestModel
+        body:
+          properties:
+            prompt_length:
+              type: integer
+              docs: Length of the prompt in characters.
+            number_of_pages:
+              type: integer
+              docs: >-
+                Pages of content in PDF documents or URLs in the agent's
+                knowledge base.
+            rag_enabled:
+              type: boolean
+              docs: Whether RAG is enabled.
+        content-type: application/json
+      response:
+        docs: Successful Response
+        type: root.LlmUsageCalculatorResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - request:
+            prompt_length: 1
+            number_of_pages: 1
+            rag_enabled: true
+          response:
+            body:
+              llm_prices:
+                - llm: gpt-4o-mini
+                  price_per_minute: 1.1
+      audiences:
+        - convai
+  source:
+    openapi: openapi.json

package/.mock/definition/conversationalAi.yml

@@ -50,7 +50,105 @@ service:
             body:
               id: id
               name: name
-              prompt_injectable: true
+    get_document_rag_indexes:
+      path: /v1/convai/knowledge-base/{documentation_id}/rag-index
+      method: GET
+      auth: false
+      docs: >-
+        Provides information about all RAG indexes of the specified
+        knowledgebase document.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        documentation_id:
+          type: string
+          docs: >-
+            The id of a document from the knowledge base. This is returned on
+            document addition.
+      display-name: Get Rag Indexes Of The Specified Knowledgebase Document.
+      response:
+        docs: Successful Response
+        type: root.RagDocumentIndexesResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            documentation_id: 21m00Tcm4TlvDq8ikWAM
+          response:
+            body:
+              indexes:
+                - id: id
+                  model: e5_mistral_7b_instruct
+                  status: created
+                  progress_percentage: 1.1
+                  document_model_index_usage:
+                    used_bytes: 1
+      audiences:
+        - convai
+    delete_document_rag_index:
+      path: /v1/convai/knowledge-base/{documentation_id}/rag-index/{rag_index_id}
+      method: DELETE
+      auth: false
+      docs: Delete RAG index for the knowledgebase document.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        documentation_id:
+          type: string
+          docs: >-
+            The id of a document from the knowledge base. This is returned on
+            document addition.
+        rag_index_id:
+          type: string
+          docs: The id of RAG index of document from the knowledge base.
+      display-name: Delete Rag Index.
+      response:
+        docs: Successful Response
+        type: root.RagDocumentIndexResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            documentation_id: 21m00Tcm4TlvDq8ikWAM
+            rag_index_id: 21m00Tcm4TlvDq8ikWAM
+          response:
+            body:
+              id: id
+              model: e5_mistral_7b_instruct
+              status: created
+              progress_percentage: 1.1
+              document_model_index_usage:
+                used_bytes: 1
+      audiences:
+        - convai
+    rag_index_overview:
+      path: /v1/convai/knowledge-base/rag-index
+      method: GET
+      auth: false
+      docs: >-
+        Provides total size and other information of RAG indexes used by
+        knowledgebase documents
+      source:
+        openapi: openapi.json
+      display-name: Get Rag Index Overview.
+      response:
+        docs: Successful Response
+        type: root.RagIndexOverviewResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - response:
+            body:
+              total_used_bytes: 1
+              total_max_bytes: 1
+              models:
+                - model: e5_mistral_7b_instruct
+                  used_bytes: 1
+      audiences:
+        - convai
     update_secret:
       path: /v1/convai/secrets/{secret_id}
       method: PATCH

package/.mock/definition/history.yml

@@ -103,6 +103,10 @@ service:
                         - 1.1
                       character_end_times_seconds:
                         - 1.1
+                  dialogue:
+                    - text: text
+                      voice_id: voice_id
+                      voice_name: voice_name
               last_history_item_id: ja9xsmfGhxYcymxGcOGB
               has_more: true
     get:
@@ -174,6 +178,10 @@ service:
                     - 1.1
                   character_end_times_seconds:
                     - 1.1
+              dialogue:
+                - text: text
+                  voice_id: voice_id
+                  voice_name: voice_name
     delete:
       path: /v1/history/{history_item_id}
       method: DELETE

package/.mock/definition/pronunciationDictionaries.yml

@@ -44,7 +44,7 @@ service:
       docs: Creates a new pronunciation dictionary from a lexicon .PLS file
       source:
         openapi: openapi.json
-      display-name: Create a pronunciation dictionary
+      display-name: Create a pronunciation dictionary from a file
       request:
         name: >-
           Body_Add_a_pronunciation_dictionary_v1_pronunciation_dictionaries_add_from_file_post
@@ -98,7 +98,7 @@ service:
       docs: Creates a new pronunciation dictionary from provided rules.
       source:
         openapi: openapi.json
-      display-name: Add A Pronunciation Dictionary
+      display-name: Create a pronunciation dictionary from rules
       request:
         name: >-
           BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPost