|
1 | 1 | # Reference |
2 | | -<details><summary><code>client.<a href="src/elevenlabs/base_client.py">post_v_1_convai_whatsapp_accounts</a>()</code></summary> |
3 | | -<dl> |
4 | | -<dd> |
5 | | - |
6 | | -#### 🔌 Usage |
7 | | - |
8 | | -<dl> |
9 | | -<dd> |
10 | | - |
11 | | -<dl> |
12 | | -<dd> |
13 | | - |
14 | | -```python |
15 | | -from elevenlabs import ElevenLabs |
16 | | - |
17 | | -client = ElevenLabs( |
18 | | - api_key="YOUR_API_KEY", |
19 | | -) |
20 | | -client.post_v_1_convai_whatsapp_accounts() |
21 | | - |
22 | | -``` |
23 | | -</dd> |
24 | | -</dl> |
25 | | -</dd> |
26 | | -</dl> |
27 | | - |
28 | | -#### ⚙️ Parameters |
29 | | - |
30 | | -<dl> |
31 | | -<dd> |
32 | | - |
33 | | -<dl> |
34 | | -<dd> |
35 | | - |
36 | | -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. |
37 | | - |
38 | | -</dd> |
39 | | -</dl> |
40 | | -</dd> |
41 | | -</dl> |
42 | | - |
43 | | - |
44 | | -</dd> |
45 | | -</dl> |
46 | | -</details> |
47 | | - |
48 | 2 | <details><summary><code>client.<a href="src/elevenlabs/base_client.py">delete_v_1_convai_agents_agent_id_branches_branch_id</a>(...)</code></summary> |
49 | 3 | <dl> |
50 | 4 | <dd> |
@@ -6406,15 +6360,15 @@ typing.Optional[core.File]` — See core.File for more documentation |
6406 | 6360 | <dl> |
6407 | 6361 | <dd> |
6408 | 6362 |
|
6409 | | -**entity_detection:** `typing.Optional[SpeechToTextConvertRequestEntityDetection]` — Detect entities in the transcript. Can be 'all' to detect all entities, a single entity type or category string, or a list of entity types/categories. Categories include 'pii', 'phi', 'pci', 'other', 'offensive_language'. When enabled, detected entities will be returned in the 'entities' field with their text, type, and character positions. |
| 6363 | +**entity_detection:** `typing.Optional[SpeechToTextConvertRequestEntityDetection]` — Detect entities in the transcript. Can be 'all' to detect all entities, a single entity type or category string, or a list of entity types/categories. Categories include 'pii', 'phi', 'pci', 'other', 'offensive_language'. When enabled, detected entities will be returned in the 'entities' field with their text, type, and character positions. Usage of this parameter will incur additional costs. |
6410 | 6364 |
|
6411 | 6365 | </dd> |
6412 | 6366 | </dl> |
6413 | 6367 |
|
6414 | 6368 | <dl> |
6415 | 6369 | <dd> |
6416 | 6370 |
|
6417 | | -**keyterms:** `typing.Optional[typing.List[str]]` — A list of keyterms to bias the transcription towards. The keyterms are words or phrases you want the model to recognise more accurately. The number of keyterms cannot exceed 100. The length of each keyterm must be less than 50 characters. Keyterms can contain at most 5 words (after normalisation). For example ["hello", "world", "technical term"] |
| 6371 | +**keyterms:** `typing.Optional[typing.List[str]]` — A list of keyterms to bias the transcription towards. The keyterms are words or phrases you want the model to recognise more accurately. The number of keyterms cannot exceed 100. The length of each keyterm must be less than 50 characters. Keyterms can contain at most 5 words (after normalisation). For example ["hello", "world", "technical term"]. Usage of this parameter will incur additional costs. |
6418 | 6372 |
|
6419 | 6373 | </dd> |
6420 | 6374 | </dl> |
@@ -8078,6 +8032,142 @@ client.conversational_ai.whatsapp.outbound_call( |
8078 | 8032 | </dl> |
8079 | 8033 |
|
8080 | 8034 |
|
| 8035 | +</dd> |
| 8036 | +</dl> |
| 8037 | +</details> |
| 8038 | + |
| 8039 | +<details><summary><code>client.conversational_ai.whatsapp.<a href="src/elevenlabs/conversational_ai/whatsapp/client.py">outbound_message</a>(...)</code></summary> |
| 8040 | +<dl> |
| 8041 | +<dd> |
| 8042 | + |
| 8043 | +#### 📝 Description |
| 8044 | + |
| 8045 | +<dl> |
| 8046 | +<dd> |
| 8047 | + |
| 8048 | +<dl> |
| 8049 | +<dd> |
| 8050 | + |
| 8051 | +Send an outbound message via WhatsApp |
| 8052 | +</dd> |
| 8053 | +</dl> |
| 8054 | +</dd> |
| 8055 | +</dl> |
| 8056 | + |
| 8057 | +#### 🔌 Usage |
| 8058 | + |
| 8059 | +<dl> |
| 8060 | +<dd> |
| 8061 | + |
| 8062 | +<dl> |
| 8063 | +<dd> |
| 8064 | + |
| 8065 | +```python |
| 8066 | +from elevenlabs import ElevenLabs, WhatsAppTemplateTextParam |
| 8067 | +from elevenlabs.conversational_ai.whatsapp import ( |
| 8068 | + BodySendAnOutboundMessageViaWhatsAppV1ConvaiWhatsappOutboundMessagePostTemplateParamsItem_Body, |
| 8069 | +) |
| 8070 | + |
| 8071 | +client = ElevenLabs( |
| 8072 | + api_key="YOUR_API_KEY", |
| 8073 | +) |
| 8074 | +client.conversational_ai.whatsapp.outbound_message( |
| 8075 | + whatsapp_phone_number_id="whatsapp_phone_number_id", |
| 8076 | + whatsapp_user_id="whatsapp_user_id", |
| 8077 | + template_name="template_name", |
| 8078 | + template_language_code="template_language_code", |
| 8079 | + template_params=[ |
| 8080 | + BodySendAnOutboundMessageViaWhatsAppV1ConvaiWhatsappOutboundMessagePostTemplateParamsItem_Body( |
| 8081 | + parameters=[ |
| 8082 | + WhatsAppTemplateTextParam( |
| 8083 | + text="text", |
| 8084 | + ) |
| 8085 | + ], |
| 8086 | + ) |
| 8087 | + ], |
| 8088 | + agent_id="agent_id", |
| 8089 | +) |
| 8090 | + |
| 8091 | +``` |
| 8092 | +</dd> |
| 8093 | +</dl> |
| 8094 | +</dd> |
| 8095 | +</dl> |
| 8096 | + |
| 8097 | +#### ⚙️ Parameters |
| 8098 | + |
| 8099 | +<dl> |
| 8100 | +<dd> |
| 8101 | + |
| 8102 | +<dl> |
| 8103 | +<dd> |
| 8104 | + |
| 8105 | +**whatsapp_phone_number_id:** `str` |
| 8106 | + |
| 8107 | +</dd> |
| 8108 | +</dl> |
| 8109 | + |
| 8110 | +<dl> |
| 8111 | +<dd> |
| 8112 | + |
| 8113 | +**whatsapp_user_id:** `str` |
| 8114 | + |
| 8115 | +</dd> |
| 8116 | +</dl> |
| 8117 | + |
| 8118 | +<dl> |
| 8119 | +<dd> |
| 8120 | + |
| 8121 | +**template_name:** `str` |
| 8122 | + |
| 8123 | +</dd> |
| 8124 | +</dl> |
| 8125 | + |
| 8126 | +<dl> |
| 8127 | +<dd> |
| 8128 | + |
| 8129 | +**template_language_code:** `str` |
| 8130 | + |
| 8131 | +</dd> |
| 8132 | +</dl> |
| 8133 | + |
| 8134 | +<dl> |
| 8135 | +<dd> |
| 8136 | + |
| 8137 | +**template_params:** `typing.Sequence[ |
| 8138 | + BodySendAnOutboundMessageViaWhatsAppV1ConvaiWhatsappOutboundMessagePostTemplateParamsItem |
| 8139 | +]` |
| 8140 | + |
| 8141 | +</dd> |
| 8142 | +</dl> |
| 8143 | + |
| 8144 | +<dl> |
| 8145 | +<dd> |
| 8146 | + |
| 8147 | +**agent_id:** `str` |
| 8148 | + |
| 8149 | +</dd> |
| 8150 | +</dl> |
| 8151 | + |
| 8152 | +<dl> |
| 8153 | +<dd> |
| 8154 | + |
| 8155 | +**conversation_initiation_client_data:** `typing.Optional[ConversationInitiationClientDataRequestInput]` |
| 8156 | + |
| 8157 | +</dd> |
| 8158 | +</dl> |
| 8159 | + |
| 8160 | +<dl> |
| 8161 | +<dd> |
| 8162 | + |
| 8163 | +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. |
| 8164 | + |
| 8165 | +</dd> |
| 8166 | +</dl> |
| 8167 | +</dd> |
| 8168 | +</dl> |
| 8169 | + |
| 8170 | + |
8081 | 8171 | </dd> |
8082 | 8172 | </dl> |
8083 | 8173 | </details> |
@@ -19525,6 +19615,76 @@ client.studio.projects.convert( |
19525 | 19615 | </dl> |
19526 | 19616 |
|
19527 | 19617 |
|
| 19618 | +</dd> |
| 19619 | +</dl> |
| 19620 | +</details> |
| 19621 | + |
| 19622 | +<details><summary><code>client.studio.projects.<a href="src/elevenlabs/studio/projects/client.py">get_muted_tracks</a>(...)</code></summary> |
| 19623 | +<dl> |
| 19624 | +<dd> |
| 19625 | + |
| 19626 | +#### 📝 Description |
| 19627 | + |
| 19628 | +<dl> |
| 19629 | +<dd> |
| 19630 | + |
| 19631 | +<dl> |
| 19632 | +<dd> |
| 19633 | + |
| 19634 | +Returns a list of chapter IDs that have muted tracks in a project. |
| 19635 | +</dd> |
| 19636 | +</dl> |
| 19637 | +</dd> |
| 19638 | +</dl> |
| 19639 | + |
| 19640 | +#### 🔌 Usage |
| 19641 | + |
| 19642 | +<dl> |
| 19643 | +<dd> |
| 19644 | + |
| 19645 | +<dl> |
| 19646 | +<dd> |
| 19647 | + |
| 19648 | +```python |
| 19649 | +from elevenlabs import ElevenLabs |
| 19650 | + |
| 19651 | +client = ElevenLabs( |
| 19652 | + api_key="YOUR_API_KEY", |
| 19653 | +) |
| 19654 | +client.studio.projects.get_muted_tracks( |
| 19655 | + project_id="21m00Tcm4TlvDq8ikWAM", |
| 19656 | +) |
| 19657 | + |
| 19658 | +``` |
| 19659 | +</dd> |
| 19660 | +</dl> |
| 19661 | +</dd> |
| 19662 | +</dl> |
| 19663 | + |
| 19664 | +#### ⚙️ Parameters |
| 19665 | + |
| 19666 | +<dl> |
| 19667 | +<dd> |
| 19668 | + |
| 19669 | +<dl> |
| 19670 | +<dd> |
| 19671 | + |
| 19672 | +**project_id:** `str` — The ID of the Studio project. |
| 19673 | + |
| 19674 | +</dd> |
| 19675 | +</dl> |
| 19676 | + |
| 19677 | +<dl> |
| 19678 | +<dd> |
| 19679 | + |
| 19680 | +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. |
| 19681 | + |
| 19682 | +</dd> |
| 19683 | +</dl> |
| 19684 | +</dd> |
| 19685 | +</dl> |
| 19686 | + |
| 19687 | + |
19528 | 19688 | </dd> |
19529 | 19689 | </dl> |
19530 | 19690 | </details> |
|
0 commit comments