Skip to content

🌿 Fern Regeneration -- December 15, 2025 #706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PaulAsjes merged 1 commit into from
Dec 15, 2025
Merged

🌿 Fern Regeneration -- December 15, 2025 #706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ dynamic = ["version"]

[tool.poetry]
name = "elevenlabs"
version = "v2.26.1"
version = "v2.27.0"
description = ""
readme = "README.md"
authors = []
Expand Down
252 changes: 224 additions & 28 deletions reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6477,7 +6477,7 @@ typing.Optional[core.File]` — See core.File for more documentation
</dl>
</details>

<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">get_document_rag_indexes</a>(...)</code></summary>
<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">rag_index_overview</a>()</code></summary>
<dl>
<dd>

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

Provides information about all RAG indexes of the specified knowledgebase document.
Provides total size and other information of RAG indexes used by knowledgebase documents
</dd>
</dl>
</dd>
Expand All @@ -6509,9 +6509,7 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_document_rag_indexes(
documentation_id="21m00Tcm4TlvDq8ikWAM",
)
client.conversational_ai.rag_index_overview()

```
</dd>
Expand All @@ -6527,14 +6525,6 @@ client.conversational_ai.get_document_rag_indexes(
<dl>
<dd>

**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand All @@ -6547,7 +6537,7 @@ client.conversational_ai.get_document_rag_indexes(
</dl>
</details>

<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">delete_document_rag_index</a>(...)</code></summary>
<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">get_document_rag_indexes</a>(...)</code></summary>
<dl>
<dd>

Expand All @@ -6559,7 +6549,7 @@ client.conversational_ai.get_document_rag_indexes(
<dl>
<dd>

Delete RAG index for the knowledgebase document.
Provides information about all RAG indexes of the specified knowledgebase document.
</dd>
</dl>
</dd>
Expand All @@ -6579,9 +6569,8 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.delete_document_rag_index(
client.conversational_ai.get_document_rag_indexes(
documentation_id="21m00Tcm4TlvDq8ikWAM",
rag_index_id="21m00Tcm4TlvDq8ikWAM",
)

```
Expand All @@ -6606,14 +6595,6 @@ client.conversational_ai.delete_document_rag_index(
<dl>
<dd>

**rag_index_id:** `str` — The id of RAG index of document from the knowledge base.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand All @@ -6626,7 +6607,7 @@ client.conversational_ai.delete_document_rag_index(
</dl>
</details>

<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">rag_index_overview</a>()</code></summary>
<details><summary><code>client.conversational_ai.<a href="src/elevenlabs/conversational_ai/client.py">delete_document_rag_index</a>(...)</code></summary>
<dl>
<dd>

Expand All @@ -6638,7 +6619,7 @@ client.conversational_ai.delete_document_rag_index(
<dl>
<dd>

Provides total size and other information of RAG indexes used by knowledgebase documents
Delete RAG index for the knowledgebase document.
</dd>
</dl>
</dd>
Expand All @@ -6658,7 +6639,10 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.rag_index_overview()
client.conversational_ai.delete_document_rag_index(
documentation_id="21m00Tcm4TlvDq8ikWAM",
rag_index_id="21m00Tcm4TlvDq8ikWAM",
)

```
</dd>
Expand All @@ -6674,6 +6658,22 @@ client.conversational_ai.rag_index_overview()
<dl>
<dd>

**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.

</dd>
</dl>

<dl>
<dd>

**rag_index_id:** `str` — The id of RAG index of document from the knowledge base.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -9770,6 +9770,9 @@ client.conversational_ai.knowledge_base.list(
page_size=1,
search="search",
show_only_owned_documents=True,
parent_folder_id="parent_folder_id",
ancestor_folder_id="ancestor_folder_id",
folders_first=True,
sort_direction="asc",
sort_by="name",
use_typesense=True,
Expand Down Expand Up @@ -9826,6 +9829,30 @@ client.conversational_ai.knowledge_base.list(
<dl>
<dd>

**parent_folder_id:** `typing.Optional[str]` — If set, the endpoint will return only documents that are direct children of the given folder.

</dd>
</dl>

<dl>
<dd>

**ancestor_folder_id:** `typing.Optional[str]` — If set, the endpoint will return only documents that are descendants of the given folder.

</dd>
</dl>

<dl>
<dd>

**folders_first:** `typing.Optional[bool]` — Whether folders should be returned first in the list of documents.

</dd>
</dl>

<dl>
<dd>

**sort_direction:** `typing.Optional[SortDirection]` — The direction to sort the results

</dd>
Expand Down Expand Up @@ -9866,6 +9893,82 @@ client.conversational_ai.knowledge_base.list(
</dl>


</dd>
</dl>
</details>

<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>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieves and/or creates RAG indexes for multiple knowledge base documents in a single request.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from elevenlabs import ElevenLabs, GetOrCreateRagIndexRequestModel

client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.knowledge_base.get_or_create_rag_indexes(
items=[
GetOrCreateRagIndexRequestModel(
document_id="document_id",
create_if_missing=True,
model="e5_mistral_7b_instruct",
)
],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**items:** `typing.Sequence[GetOrCreateRagIndexRequestModel]` — List of requested RAG indexes.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>
Expand Down Expand Up @@ -12499,6 +12602,14 @@ client.conversational_ai.knowledge_base.documents.create_from_url(
<dl>
<dd>

**parent_folder_id:** `typing.Optional[str]` — If set, the created document or folder will be placed inside the given folder.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -12577,6 +12688,14 @@ core.File` — See core.File for more documentation
<dl>
<dd>

**parent_folder_id:** `typing.Optional[str]` — If set, the created document or folder will be placed inside the given folder.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -12655,6 +12774,14 @@ client.conversational_ai.knowledge_base.documents.create_from_text(
<dl>
<dd>

**parent_folder_id:** `typing.Optional[str]` — If set, the created document or folder will be placed inside the given folder.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -13138,6 +13265,75 @@ client.conversational_ai.knowledge_base.document.compute_rag_index(
</dl>


</dd>
</dl>
</details>

## ConversationalAi KnowledgeBase Documents Summaries
<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>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Gets multiple knowledge base document summaries by their IDs.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from elevenlabs import ElevenLabs

client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.knowledge_base.documents.summaries.get()

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**document_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — The ids of knowledge base documents.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>
Expand Down
Loading