Download data/src/elevenlabs/conversational_ai/knowledge_base/document/client.py from introvoyz045/elevenlabs-python: direct link, hf CLI and curl.
- Browser
- Download file 9.07 kB
-
https://huggingface.co/datasets/introvoyz045/elevenlabs-python/resolve/main/data/src/elevenlabs/conversational_ai/knowledge_base/document/client.py
- Command line
-
hf download hf://datasets/introvoyz045/elevenlabs-python/data/src/elevenlabs/conversational_ai/knowledge_base/document/client.py
-
curl -L -o client.py https://huggingface.co/datasets/introvoyz045/elevenlabs-python/resolve/main/data/src/elevenlabs/conversational_ai/knowledge_base/document/client.py
9.07 kB
| # This file was auto-generated by Fern from our API Definition. | |
| import typing | |
| from .... import core | |
| from ....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper | |
| from ....core.request_options import RequestOptions | |
| from ....types.embedding_model_enum import EmbeddingModelEnum | |
| from ....types.rag_document_index_response_model import RagDocumentIndexResponseModel | |
| from .raw_client import AsyncRawDocumentClient, RawDocumentClient | |
| from .types.document_refresh_response import DocumentRefreshResponse | |
| from .types.document_update_file_response import DocumentUpdateFileResponse | |
| # this is used as the default value for optional parameters | |
| OMIT = typing.cast(typing.Any, ...) | |
| class DocumentClient: | |
| def __init__(self, *, client_wrapper: SyncClientWrapper): | |
| self._raw_client = RawDocumentClient(client_wrapper=client_wrapper) | |
| def with_raw_response(self) -> RawDocumentClient: | |
| """ | |
| Retrieves a raw implementation of this client that returns raw responses. | |
| Returns | |
| ------- | |
| RawDocumentClient | |
| """ | |
| return self._raw_client | |
| def update_file( | |
| self, documentation_id: str, *, file: core.File, request_options: typing.Optional[RequestOptions] = None | |
| ) -> DocumentUpdateFileResponse: | |
| """ | |
| Update the source file of a file document. The document name, content, and metadata are updated to reflect the new file. Any manual content edits will be overwritten. | |
| Parameters | |
| ---------- | |
| documentation_id : str | |
| The id of a document from the knowledge base. This is returned on document addition. | |
| file : core.File | |
| See core.File for more documentation | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| DocumentUpdateFileResponse | |
| Successful Response | |
| Examples | |
| -------- | |
| from elevenlabs import ElevenLabs | |
| client = ElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| client.conversational_ai.knowledge_base.document.update_file( | |
| documentation_id="21m00Tcm4TlvDq8ikWAM", | |
| ) | |
| """ | |
| _response = self._raw_client.update_file(documentation_id, file=file, request_options=request_options) | |
| return _response.data | |
| def refresh( | |
| self, documentation_id: str, *, request_options: typing.Optional[RequestOptions] = None | |
| ) -> DocumentRefreshResponse: | |
| """ | |
| Manually refresh a URL document by re-fetching its content from the source URL. | |
| Parameters | |
| ---------- | |
| documentation_id : str | |
| The id of a document from the knowledge base. This is returned on document addition. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| DocumentRefreshResponse | |
| Successful Response | |
| Examples | |
| -------- | |
| from elevenlabs import ElevenLabs | |
| client = ElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| client.conversational_ai.knowledge_base.document.refresh( | |
| documentation_id="21m00Tcm4TlvDq8ikWAM", | |
| ) | |
| """ | |
| _response = self._raw_client.refresh(documentation_id, request_options=request_options) | |
| return _response.data | |
| def compute_rag_index( | |
| self, | |
| documentation_id: str, | |
| *, | |
| model: EmbeddingModelEnum, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> RagDocumentIndexResponseModel: | |
| """ | |
| In case the document is not RAG indexed, it triggers rag indexing task, otherwise it just returns the current status. | |
| Parameters | |
| ---------- | |
| documentation_id : str | |
| The id of a document from the knowledge base. This is returned on document addition. | |
| model : EmbeddingModelEnum | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| RagDocumentIndexResponseModel | |
| Successful Response | |
| Examples | |
| -------- | |
| from elevenlabs import ElevenLabs | |
| client = ElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| client.conversational_ai.knowledge_base.document.compute_rag_index( | |
| documentation_id="21m00Tcm4TlvDq8ikWAM", | |
| model="e5_mistral_7b_instruct", | |
| ) | |
| """ | |
| _response = self._raw_client.compute_rag_index(documentation_id, model=model, request_options=request_options) | |
| return _response.data | |
| class AsyncDocumentClient: | |
| def __init__(self, *, client_wrapper: AsyncClientWrapper): | |
| self._raw_client = AsyncRawDocumentClient(client_wrapper=client_wrapper) | |
| def with_raw_response(self) -> AsyncRawDocumentClient: | |
| """ | |
| Retrieves a raw implementation of this client that returns raw responses. | |
| Returns | |
| ------- | |
| AsyncRawDocumentClient | |
| """ | |
| return self._raw_client | |
| async def update_file( | |
| self, documentation_id: str, *, file: core.File, request_options: typing.Optional[RequestOptions] = None | |
| ) -> DocumentUpdateFileResponse: | |
| """ | |
| Update the source file of a file document. The document name, content, and metadata are updated to reflect the new file. Any manual content edits will be overwritten. | |
| Parameters | |
| ---------- | |
| documentation_id : str | |
| The id of a document from the knowledge base. This is returned on document addition. | |
| file : core.File | |
| See core.File for more documentation | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| DocumentUpdateFileResponse | |
| Successful Response | |
| Examples | |
| -------- | |
| import asyncio | |
| from elevenlabs import AsyncElevenLabs | |
| client = AsyncElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| async def main() -> None: | |
| await client.conversational_ai.knowledge_base.document.update_file( | |
| documentation_id="21m00Tcm4TlvDq8ikWAM", | |
| ) | |
| asyncio.run(main()) | |
| """ | |
| _response = await self._raw_client.update_file(documentation_id, file=file, request_options=request_options) | |
| return _response.data | |
| async def refresh( | |
| self, documentation_id: str, *, request_options: typing.Optional[RequestOptions] = None | |
| ) -> DocumentRefreshResponse: | |
| """ | |
| Manually refresh a URL document by re-fetching its content from the source URL. | |
| Parameters | |
| ---------- | |
| documentation_id : str | |
| The id of a document from the knowledge base. This is returned on document addition. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| DocumentRefreshResponse | |
| Successful Response | |
| Examples | |
| -------- | |
| import asyncio | |
| from elevenlabs import AsyncElevenLabs | |
| client = AsyncElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| async def main() -> None: | |
| await client.conversational_ai.knowledge_base.document.refresh( | |
| documentation_id="21m00Tcm4TlvDq8ikWAM", | |
| ) | |
| asyncio.run(main()) | |
| """ | |
| _response = await self._raw_client.refresh(documentation_id, request_options=request_options) | |
| return _response.data | |
| async def compute_rag_index( | |
| self, | |
| documentation_id: str, | |
| *, | |
| model: EmbeddingModelEnum, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> RagDocumentIndexResponseModel: | |
| """ | |
| In case the document is not RAG indexed, it triggers rag indexing task, otherwise it just returns the current status. | |
| Parameters | |
| ---------- | |
| documentation_id : str | |
| The id of a document from the knowledge base. This is returned on document addition. | |
| model : EmbeddingModelEnum | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| RagDocumentIndexResponseModel | |
| Successful Response | |
| Examples | |
| -------- | |
| import asyncio | |
| from elevenlabs import AsyncElevenLabs | |
| client = AsyncElevenLabs( | |
| api_key="YOUR_API_KEY", | |
| ) | |
| async def main() -> None: | |
| await client.conversational_ai.knowledge_base.document.compute_rag_index( | |
| documentation_id="21m00Tcm4TlvDq8ikWAM", | |
| model="e5_mistral_7b_instruct", | |
| ) | |
| asyncio.run(main()) | |
| """ | |
| _response = await self._raw_client.compute_rag_index( | |
| documentation_id, model=model, request_options=request_options | |
| ) | |
| return _response.data | |