Skip to content

Commit 2860d51

Browse files
SDK regeneration
1 parent cb8f9d3 commit 2860d51

53 files changed

Lines changed: 1969 additions & 179 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ dynamic = ["version"]
44

55
[tool.poetry]
66
name = "elevenlabs"
7-
version = "v2.26.1"
7+
version = "v2.27.0"
88
description = ""
99
readme = "README.md"
1010
authors = []

reference.md

Lines changed: 224 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6477,7 +6477,7 @@ typing.Optional[core.File]` — See core.File for more documentation
64776477
</dl>
64786478
</details>
64796479

6480-
<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">get_document_rag_indexes</a>(...)</code></summary>
6480+
<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">rag_index_overview</a>()</code></summary>
64816481
<dl>
64826482
<dd>
64836483

@@ -6489,7 +6489,7 @@ typing.Optional[core.File]` — See core.File for more documentation
64896489
<dl>
64906490
<dd>
64916491

6492-
Provides information about all RAG indexes of the specified knowledgebase document.
6492+
Provides total size and other information of RAG indexes used by knowledgebase documents
64936493
</dd>
64946494
</dl>
64956495
</dd>
@@ -6509,9 +6509,7 @@ from elevenlabs import ElevenLabs
65096509
client = ElevenLabs(
65106510
api_key="YOUR_API_KEY",
65116511
)
6512-
client.conversational_ai.get_document_rag_indexes(
6513-
documentation_id="21m00Tcm4TlvDq8ikWAM",
6514-
)
6512+
client.conversational_ai.rag_index_overview()
65156513

65166514
```
65176515
</dd>
@@ -6527,14 +6525,6 @@ client.conversational_ai.get_document_rag_indexes(
65276525
<dl>
65286526
<dd>
65296527

6530-
**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
6531-
6532-
</dd>
6533-
</dl>
6534-
6535-
<dl>
6536-
<dd>
6537-
65386528
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
65396529

65406530
</dd>
@@ -6547,7 +6537,7 @@ client.conversational_ai.get_document_rag_indexes(
65476537
</dl>
65486538
</details>
65496539

6550-
<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">delete_document_rag_index</a>(...)</code></summary>
6540+
<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">get_document_rag_indexes</a>(...)</code></summary>
65516541
<dl>
65526542
<dd>
65536543

@@ -6559,7 +6549,7 @@ client.conversational_ai.get_document_rag_indexes(
65596549
<dl>
65606550
<dd>
65616551

6562-
Delete RAG index for the knowledgebase document.
6552+
Provides information about all RAG indexes of the specified knowledgebase document.
65636553
</dd>
65646554
</dl>
65656555
</dd>
@@ -6579,9 +6569,8 @@ from elevenlabs import ElevenLabs
65796569
client = ElevenLabs(
65806570
api_key="YOUR_API_KEY",
65816571
)
6582-
client.conversational_ai.delete_document_rag_index(
6572+
client.conversational_ai.get_document_rag_indexes(
65836573
documentation_id="21m00Tcm4TlvDq8ikWAM",
6584-
rag_index_id="21m00Tcm4TlvDq8ikWAM",
65856574
)
65866575

65876576
```
@@ -6606,14 +6595,6 @@ client.conversational_ai.delete_document_rag_index(
66066595
<dl>
66076596
<dd>
66086597

6609-
**rag_index_id:** `str` — The id of RAG index of document from the knowledge base.
6610-
6611-
</dd>
6612-
</dl>
6613-
6614-
<dl>
6615-
<dd>
6616-
66176598
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
66186599

66196600
</dd>
@@ -6626,7 +6607,7 @@ client.conversational_ai.delete_document_rag_index(
66266607
</dl>
66276608
</details>
66286609

6629-
<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">rag_index_overview</a>()</code></summary>
6610+
<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">delete_document_rag_index</a>(...)</code></summary>
66306611
<dl>
66316612
<dd>
66326613

@@ -6638,7 +6619,7 @@ client.conversational_ai.delete_document_rag_index(
66386619
<dl>
66396620
<dd>
66406621

6641-
Provides total size and other information of RAG indexes used by knowledgebase documents
6622+
Delete RAG index for the knowledgebase document.
66426623
</dd>
66436624
</dl>
66446625
</dd>
@@ -6658,7 +6639,10 @@ from elevenlabs import ElevenLabs
66586639
client = ElevenLabs(
66596640
api_key="YOUR_API_KEY",
66606641
)
6661-
client.conversational_ai.rag_index_overview()
6642+
client.conversational_ai.delete_document_rag_index(
6643+
documentation_id="21m00Tcm4TlvDq8ikWAM",
6644+
rag_index_id="21m00Tcm4TlvDq8ikWAM",
6645+
)
66626646

66636647
```
66646648
</dd>
@@ -6674,6 +6658,22 @@ client.conversational_ai.rag_index_overview()
66746658
<dl>
66756659
<dd>
66766660

6661+
**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
6662+
6663+
</dd>
6664+
</dl>
6665+
6666+
<dl>
6667+
<dd>
6668+
6669+
**rag_index_id:** `str` — The id of RAG index of document from the knowledge base.
6670+
6671+
</dd>
6672+
</dl>
6673+
6674+
<dl>
6675+
<dd>
6676+
66776677
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
66786678

66796679
</dd>
@@ -9770,6 +9770,9 @@ client.conversational_ai.knowledge_base.list(
97709770
page_size=1,
97719771
search="search",
97729772
show_only_owned_documents=True,
9773+
parent_folder_id="parent_folder_id",
9774+
ancestor_folder_id="ancestor_folder_id",
9775+
folders_first=True,
97739776
sort_direction="asc",
97749777
sort_by="name",
97759778
use_typesense=True,
@@ -9826,6 +9829,30 @@ client.conversational_ai.knowledge_base.list(
98269829
<dl>
98279830
<dd>
98289831

9832+
**parent_folder_id:** `typing.Optional[str]` — If set, the endpoint will return only documents that are direct children of the given folder.
9833+
9834+
</dd>
9835+
</dl>
9836+
9837+
<dl>
9838+
<dd>
9839+
9840+
**ancestor_folder_id:** `typing.Optional[str]` — If set, the endpoint will return only documents that are descendants of the given folder.
9841+
9842+
</dd>
9843+
</dl>
9844+
9845+
<dl>
9846+
<dd>
9847+
9848+
**folders_first:** `typing.Optional[bool]` — Whether folders should be returned first in the list of documents.
9849+
9850+
</dd>
9851+
</dl>
9852+
9853+
<dl>
9854+
<dd>
9855+
98299856
**sort_direction:** `typing.Optional[SortDirection]` — The direction to sort the results
98309857

98319858
</dd>
@@ -9866,6 +9893,82 @@ client.conversational_ai.knowledge_base.list(
98669893
</dl>
98679894

98689895

9896+
</dd>
9897+
</dl>
9898+
</details>
9899+
9900+
<details><summary><code>client.conversational_ai.knowledge_base.<a href="src/elevenlabs/conversational_ai/knowledge_base/client.py">get_or_create_rag_indexes</a>(...)</code></summary>
9901+
<dl>
9902+
<dd>
9903+
9904+
#### 📝 Description
9905+
9906+
<dl>
9907+
<dd>
9908+
9909+
<dl>
9910+
<dd>
9911+
9912+
Retrieves and/or creates RAG indexes for multiple knowledge base documents in a single request.
9913+
</dd>
9914+
</dl>
9915+
</dd>
9916+
</dl>
9917+
9918+
#### 🔌 Usage
9919+
9920+
<dl>
9921+
<dd>
9922+
9923+
<dl>
9924+
<dd>
9925+
9926+
```python
9927+
from elevenlabs import ElevenLabs, GetOrCreateRagIndexRequestModel
9928+
9929+
client = ElevenLabs(
9930+
api_key="YOUR_API_KEY",
9931+
)
9932+
client.conversational_ai.knowledge_base.get_or_create_rag_indexes(
9933+
items=[
9934+
GetOrCreateRagIndexRequestModel(
9935+
document_id="document_id",
9936+
create_if_missing=True,
9937+
model="e5_mistral_7b_instruct",
9938+
)
9939+
],
9940+
)
9941+
9942+
```
9943+
</dd>
9944+
</dl>
9945+
</dd>
9946+
</dl>
9947+
9948+
#### ⚙️ Parameters
9949+
9950+
<dl>
9951+
<dd>
9952+
9953+
<dl>
9954+
<dd>
9955+
9956+
**items:** `typing.Sequence[GetOrCreateRagIndexRequestModel]` — List of requested RAG indexes.
9957+
9958+
</dd>
9959+
</dl>
9960+
9961+
<dl>
9962+
<dd>
9963+
9964+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
9965+
9966+
</dd>
9967+
</dl>
9968+
</dd>
9969+
</dl>
9970+
9971+
98699972
</dd>
98709973
</dl>
98719974
</details>
@@ -12499,6 +12602,14 @@ client.conversational_ai.knowledge_base.documents.create_from_url(
1249912602
<dl>
1250012603
<dd>
1250112604

12605+
**parent_folder_id:** `typing.Optional[str]` — If set, the created document or folder will be placed inside the given folder.
12606+
12607+
</dd>
12608+
</dl>
12609+
12610+
<dl>
12611+
<dd>
12612+
1250212613
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1250312614

1250412615
</dd>
@@ -12577,6 +12688,14 @@ core.File` — See core.File for more documentation
1257712688
<dl>
1257812689
<dd>
1257912690

12691+
**parent_folder_id:** `typing.Optional[str]` — If set, the created document or folder will be placed inside the given folder.
12692+
12693+
</dd>
12694+
</dl>
12695+
12696+
<dl>
12697+
<dd>
12698+
1258012699
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1258112700

1258212701
</dd>
@@ -12655,6 +12774,14 @@ client.conversational_ai.knowledge_base.documents.create_from_text(
1265512774
<dl>
1265612775
<dd>
1265712776

12777+
**parent_folder_id:** `typing.Optional[str]` — If set, the created document or folder will be placed inside the given folder.
12778+
12779+
</dd>
12780+
</dl>
12781+
12782+
<dl>
12783+
<dd>
12784+
1265812785
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1265912786

1266012787
</dd>
@@ -13138,6 +13265,75 @@ client.conversational_ai.knowledge_base.document.compute_rag_index(
1313813265
</dl>
1313913266

1314013267

13268+
</dd>
13269+
</dl>
13270+
</details>
13271+
13272+
## ConversationalAi KnowledgeBase Documents Summaries
13273+
<details><summary><code>client.conversational_ai.knowledge_base.documents.summaries.<a href="src/elevenlabs/conversational_ai/knowledge_base/documents/summaries/client.py">get</a>(...)</code></summary>
13274+
<dl>
13275+
<dd>
13276+
13277+
#### 📝 Description
13278+
13279+
<dl>
13280+
<dd>
13281+
13282+
<dl>
13283+
<dd>
13284+
13285+
Gets multiple knowledge base document summaries by their IDs.
13286+
</dd>
13287+
</dl>
13288+
</dd>
13289+
</dl>
13290+
13291+
#### 🔌 Usage
13292+
13293+
<dl>
13294+
<dd>
13295+
13296+
<dl>
13297+
<dd>
13298+
13299+
```python
13300+
from elevenlabs import ElevenLabs
13301+
13302+
client = ElevenLabs(
13303+
api_key="YOUR_API_KEY",
13304+
)
13305+
client.conversational_ai.knowledge_base.documents.summaries.get()
13306+
13307+
```
13308+
</dd>
13309+
</dl>
13310+
</dd>
13311+
</dl>
13312+
13313+
#### ⚙️ Parameters
13314+
13315+
<dl>
13316+
<dd>
13317+
13318+
<dl>
13319+
<dd>
13320+
13321+
**document_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — The ids of knowledge base documents.
13322+
13323+
</dd>
13324+
</dl>
13325+
13326+
<dl>
13327+
<dd>
13328+
13329+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
13330+
13331+
</dd>
13332+
</dl>
13333+
</dd>
13334+
</dl>
13335+
13336+
1314113337
</dd>
1314213338
</dl>
1314313339
</details>

0 commit comments

Comments
 (0)