Download data/src/elevenlabs/conversational_ai/knowledge_base/raw_client.py from introvoyz045/elevenlabs-python: direct link, hf CLI and curl.
- Browser
- Download file 23.6 kB
-
https://huggingface.co/datasets/introvoyz045/elevenlabs-python/resolve/main/data/src/elevenlabs/conversational_ai/knowledge_base/raw_client.py
- Command line
-
hf download hf://datasets/introvoyz045/elevenlabs-python/data/src/elevenlabs/conversational_ai/knowledge_base/raw_client.py
-
curl -L -o raw_client.py https://huggingface.co/datasets/introvoyz045/elevenlabs-python/resolve/main/data/src/elevenlabs/conversational_ai/knowledge_base/raw_client.py
23.6 kB
| # This file was auto-generated by Fern from our API Definition. | |
| import typing | |
| from json.decoder import JSONDecodeError | |
| from ...core.api_error import ApiError | |
| from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper | |
| from ...core.http_response import AsyncHttpResponse, HttpResponse | |
| from ...core.parse_error import ParsingError | |
| from ...core.request_options import RequestOptions | |
| from ...core.serialization import convert_and_respect_annotation_metadata | |
| from ...core.unchecked_base_model import construct_type | |
| from ...errors.unprocessable_entity_error import UnprocessableEntityError | |
| from ...types.get_knowledge_base_list_response_model import GetKnowledgeBaseListResponseModel | |
| from ...types.get_or_create_rag_index_request_model import GetOrCreateRagIndexRequestModel | |
| from ...types.knowledge_base_content_search_response_model import KnowledgeBaseContentSearchResponseModel | |
| from ...types.knowledge_base_document_type import KnowledgeBaseDocumentType | |
| from ...types.knowledge_base_sort_by import KnowledgeBaseSortBy | |
| from ...types.sort_direction import SortDirection | |
| from .types.knowledge_base_get_or_create_rag_indexes_response_value import ( | |
| KnowledgeBaseGetOrCreateRagIndexesResponseValue, | |
| ) | |
| from pydantic import ValidationError | |
| # this is used as the default value for optional parameters | |
| OMIT = typing.cast(typing.Any, ...) | |
| class RawKnowledgeBaseClient: | |
| def __init__(self, *, client_wrapper: SyncClientWrapper): | |
| self._client_wrapper = client_wrapper | |
| def list( | |
| self, | |
| *, | |
| page_size: typing.Optional[int] = None, | |
| search: typing.Optional[str] = None, | |
| show_only_owned_documents: typing.Optional[bool] = None, | |
| created_by_user_id: typing.Optional[str] = None, | |
| types: typing.Optional[ | |
| typing.Union[KnowledgeBaseDocumentType, typing.Sequence[KnowledgeBaseDocumentType]] | |
| ] = None, | |
| parent_folder_id: typing.Optional[str] = None, | |
| ancestor_folder_id: typing.Optional[str] = None, | |
| folders_first: typing.Optional[bool] = None, | |
| sort_direction: typing.Optional[SortDirection] = None, | |
| sort_by: typing.Optional[KnowledgeBaseSortBy] = None, | |
| cursor: typing.Optional[str] = None, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> HttpResponse[GetKnowledgeBaseListResponseModel]: | |
| """ | |
| Get a list of available knowledge base documents | |
| Parameters | |
| ---------- | |
| page_size : typing.Optional[int] | |
| How many documents to return at maximum. Can not exceed 100, defaults to 30. | |
| search : typing.Optional[str] | |
| If specified, the endpoint returns only such knowledge base documents whose names start with this string. | |
| show_only_owned_documents : typing.Optional[bool] | |
| If set to true, the endpoint will return only documents owned by you (and not shared from somebody else). Deprecated: use created_by_user_id instead. | |
| created_by_user_id : typing.Optional[str] | |
| Filter documents by creator user ID. When set, only documents created by this user are returned. Takes precedence over show_only_owned_documents. Use '@me' to refer to the authenticated user. | |
| types : typing.Optional[typing.Union[KnowledgeBaseDocumentType, typing.Sequence[KnowledgeBaseDocumentType]]] | |
| If present, the endpoint will return only documents of the given types. | |
| parent_folder_id : typing.Optional[str] | |
| If set, the endpoint will return only documents that are direct children of the given folder. | |
| ancestor_folder_id : typing.Optional[str] | |
| If set, the endpoint will return only documents that are descendants of the given folder. | |
| folders_first : typing.Optional[bool] | |
| Whether folders should be returned first in the list of documents. | |
| sort_direction : typing.Optional[SortDirection] | |
| The direction to sort the results | |
| sort_by : typing.Optional[KnowledgeBaseSortBy] | |
| The field to sort the results by | |
| cursor : typing.Optional[str] | |
| Used for fetching next page. Cursor is returned in the response. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| HttpResponse[GetKnowledgeBaseListResponseModel] | |
| Successful Response | |
| """ | |
| _response = self._client_wrapper.httpx_client.request( | |
| "v1/convai/knowledge-base", | |
| method="GET", | |
| params={ | |
| "page_size": page_size, | |
| "search": search, | |
| "show_only_owned_documents": show_only_owned_documents, | |
| "created_by_user_id": created_by_user_id, | |
| "types": types, | |
| "parent_folder_id": parent_folder_id, | |
| "ancestor_folder_id": ancestor_folder_id, | |
| "folders_first": folders_first, | |
| "sort_direction": sort_direction, | |
| "sort_by": sort_by, | |
| "cursor": cursor, | |
| }, | |
| request_options=request_options, | |
| ) | |
| try: | |
| if 200 <= _response.status_code < 300: | |
| _data = typing.cast( | |
| GetKnowledgeBaseListResponseModel, | |
| construct_type( | |
| type_=GetKnowledgeBaseListResponseModel, # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ) | |
| return HttpResponse(response=_response, data=_data) | |
| if _response.status_code == 422: | |
| raise UnprocessableEntityError( | |
| headers=dict(_response.headers), | |
| body=typing.cast( | |
| typing.Any, | |
| construct_type( | |
| type_=typing.Any, # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ), | |
| ) | |
| _response_json = _response.json() | |
| except JSONDecodeError: | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) | |
| except ValidationError as e: | |
| raise ParsingError( | |
| status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e | |
| ) | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) | |
| def get_or_create_rag_indexes( | |
| self, | |
| *, | |
| items: typing.Sequence[GetOrCreateRagIndexRequestModel], | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> HttpResponse[typing.Dict[str, KnowledgeBaseGetOrCreateRagIndexesResponseValue]]: | |
| """ | |
| Retrieves and/or creates RAG indexes for multiple knowledge base documents in a single request. Maximum 100 items per request. | |
| Parameters | |
| ---------- | |
| items : typing.Sequence[GetOrCreateRagIndexRequestModel] | |
| List of requested RAG indexes. Minimum 1, maximum 100 items. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| HttpResponse[typing.Dict[str, KnowledgeBaseGetOrCreateRagIndexesResponseValue]] | |
| Successful Response | |
| """ | |
| _response = self._client_wrapper.httpx_client.request( | |
| "v1/convai/knowledge-base/rag-index", | |
| method="POST", | |
| json={ | |
| "items": convert_and_respect_annotation_metadata( | |
| object_=items, annotation=typing.Sequence[GetOrCreateRagIndexRequestModel], direction="write" | |
| ), | |
| }, | |
| headers={ | |
| "content-type": "application/json", | |
| }, | |
| request_options=request_options, | |
| omit=OMIT, | |
| ) | |
| try: | |
| if 200 <= _response.status_code < 300: | |
| _data = typing.cast( | |
| typing.Dict[str, KnowledgeBaseGetOrCreateRagIndexesResponseValue], | |
| construct_type( | |
| type_=typing.Dict[str, KnowledgeBaseGetOrCreateRagIndexesResponseValue], # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ) | |
| return HttpResponse(response=_response, data=_data) | |
| if _response.status_code == 422: | |
| raise UnprocessableEntityError( | |
| headers=dict(_response.headers), | |
| body=typing.cast( | |
| typing.Any, | |
| construct_type( | |
| type_=typing.Any, # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ), | |
| ) | |
| _response_json = _response.json() | |
| except JSONDecodeError: | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) | |
| except ValidationError as e: | |
| raise ParsingError( | |
| status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e | |
| ) | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) | |
| def search( | |
| self, | |
| *, | |
| query: str, | |
| page_size: typing.Optional[int] = None, | |
| types: typing.Optional[ | |
| typing.Union[KnowledgeBaseDocumentType, typing.Sequence[KnowledgeBaseDocumentType]] | |
| ] = None, | |
| cursor: typing.Optional[str] = None, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> HttpResponse[KnowledgeBaseContentSearchResponseModel]: | |
| """ | |
| Fuzzy text search over knowledge base document content | |
| Parameters | |
| ---------- | |
| query : str | |
| The search query text | |
| page_size : typing.Optional[int] | |
| How many documents to return at maximum. Can not exceed 100, defaults to 30. | |
| types : typing.Optional[typing.Union[KnowledgeBaseDocumentType, typing.Sequence[KnowledgeBaseDocumentType]]] | |
| If present, the endpoint will return only documents of the given types. | |
| cursor : typing.Optional[str] | |
| Used for fetching next page. Cursor is returned in the response. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| HttpResponse[KnowledgeBaseContentSearchResponseModel] | |
| Successful Response | |
| """ | |
| _response = self._client_wrapper.httpx_client.request( | |
| "v1/convai/knowledge-base/search", | |
| method="GET", | |
| params={ | |
| "query": query, | |
| "page_size": page_size, | |
| "types": types, | |
| "cursor": cursor, | |
| }, | |
| request_options=request_options, | |
| ) | |
| try: | |
| if 200 <= _response.status_code < 300: | |
| _data = typing.cast( | |
| KnowledgeBaseContentSearchResponseModel, | |
| construct_type( | |
| type_=KnowledgeBaseContentSearchResponseModel, # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ) | |
| return HttpResponse(response=_response, data=_data) | |
| if _response.status_code == 422: | |
| raise UnprocessableEntityError( | |
| headers=dict(_response.headers), | |
| body=typing.cast( | |
| typing.Any, | |
| construct_type( | |
| type_=typing.Any, # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ), | |
| ) | |
| _response_json = _response.json() | |
| except JSONDecodeError: | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) | |
| except ValidationError as e: | |
| raise ParsingError( | |
| status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e | |
| ) | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) | |
| class AsyncRawKnowledgeBaseClient: | |
| def __init__(self, *, client_wrapper: AsyncClientWrapper): | |
| self._client_wrapper = client_wrapper | |
| async def list( | |
| self, | |
| *, | |
| page_size: typing.Optional[int] = None, | |
| search: typing.Optional[str] = None, | |
| show_only_owned_documents: typing.Optional[bool] = None, | |
| created_by_user_id: typing.Optional[str] = None, | |
| types: typing.Optional[ | |
| typing.Union[KnowledgeBaseDocumentType, typing.Sequence[KnowledgeBaseDocumentType]] | |
| ] = None, | |
| parent_folder_id: typing.Optional[str] = None, | |
| ancestor_folder_id: typing.Optional[str] = None, | |
| folders_first: typing.Optional[bool] = None, | |
| sort_direction: typing.Optional[SortDirection] = None, | |
| sort_by: typing.Optional[KnowledgeBaseSortBy] = None, | |
| cursor: typing.Optional[str] = None, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> AsyncHttpResponse[GetKnowledgeBaseListResponseModel]: | |
| """ | |
| Get a list of available knowledge base documents | |
| Parameters | |
| ---------- | |
| page_size : typing.Optional[int] | |
| How many documents to return at maximum. Can not exceed 100, defaults to 30. | |
| search : typing.Optional[str] | |
| If specified, the endpoint returns only such knowledge base documents whose names start with this string. | |
| show_only_owned_documents : typing.Optional[bool] | |
| If set to true, the endpoint will return only documents owned by you (and not shared from somebody else). Deprecated: use created_by_user_id instead. | |
| created_by_user_id : typing.Optional[str] | |
| Filter documents by creator user ID. When set, only documents created by this user are returned. Takes precedence over show_only_owned_documents. Use '@me' to refer to the authenticated user. | |
| types : typing.Optional[typing.Union[KnowledgeBaseDocumentType, typing.Sequence[KnowledgeBaseDocumentType]]] | |
| If present, the endpoint will return only documents of the given types. | |
| parent_folder_id : typing.Optional[str] | |
| If set, the endpoint will return only documents that are direct children of the given folder. | |
| ancestor_folder_id : typing.Optional[str] | |
| If set, the endpoint will return only documents that are descendants of the given folder. | |
| folders_first : typing.Optional[bool] | |
| Whether folders should be returned first in the list of documents. | |
| sort_direction : typing.Optional[SortDirection] | |
| The direction to sort the results | |
| sort_by : typing.Optional[KnowledgeBaseSortBy] | |
| The field to sort the results by | |
| cursor : typing.Optional[str] | |
| Used for fetching next page. Cursor is returned in the response. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| AsyncHttpResponse[GetKnowledgeBaseListResponseModel] | |
| Successful Response | |
| """ | |
| _response = await self._client_wrapper.httpx_client.request( | |
| "v1/convai/knowledge-base", | |
| method="GET", | |
| params={ | |
| "page_size": page_size, | |
| "search": search, | |
| "show_only_owned_documents": show_only_owned_documents, | |
| "created_by_user_id": created_by_user_id, | |
| "types": types, | |
| "parent_folder_id": parent_folder_id, | |
| "ancestor_folder_id": ancestor_folder_id, | |
| "folders_first": folders_first, | |
| "sort_direction": sort_direction, | |
| "sort_by": sort_by, | |
| "cursor": cursor, | |
| }, | |
| request_options=request_options, | |
| ) | |
| try: | |
| if 200 <= _response.status_code < 300: | |
| _data = typing.cast( | |
| GetKnowledgeBaseListResponseModel, | |
| construct_type( | |
| type_=GetKnowledgeBaseListResponseModel, # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ) | |
| return AsyncHttpResponse(response=_response, data=_data) | |
| if _response.status_code == 422: | |
| raise UnprocessableEntityError( | |
| headers=dict(_response.headers), | |
| body=typing.cast( | |
| typing.Any, | |
| construct_type( | |
| type_=typing.Any, # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ), | |
| ) | |
| _response_json = _response.json() | |
| except JSONDecodeError: | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) | |
| except ValidationError as e: | |
| raise ParsingError( | |
| status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e | |
| ) | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) | |
| async def get_or_create_rag_indexes( | |
| self, | |
| *, | |
| items: typing.Sequence[GetOrCreateRagIndexRequestModel], | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> AsyncHttpResponse[typing.Dict[str, KnowledgeBaseGetOrCreateRagIndexesResponseValue]]: | |
| """ | |
| Retrieves and/or creates RAG indexes for multiple knowledge base documents in a single request. Maximum 100 items per request. | |
| Parameters | |
| ---------- | |
| items : typing.Sequence[GetOrCreateRagIndexRequestModel] | |
| List of requested RAG indexes. Minimum 1, maximum 100 items. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| AsyncHttpResponse[typing.Dict[str, KnowledgeBaseGetOrCreateRagIndexesResponseValue]] | |
| Successful Response | |
| """ | |
| _response = await self._client_wrapper.httpx_client.request( | |
| "v1/convai/knowledge-base/rag-index", | |
| method="POST", | |
| json={ | |
| "items": convert_and_respect_annotation_metadata( | |
| object_=items, annotation=typing.Sequence[GetOrCreateRagIndexRequestModel], direction="write" | |
| ), | |
| }, | |
| headers={ | |
| "content-type": "application/json", | |
| }, | |
| request_options=request_options, | |
| omit=OMIT, | |
| ) | |
| try: | |
| if 200 <= _response.status_code < 300: | |
| _data = typing.cast( | |
| typing.Dict[str, KnowledgeBaseGetOrCreateRagIndexesResponseValue], | |
| construct_type( | |
| type_=typing.Dict[str, KnowledgeBaseGetOrCreateRagIndexesResponseValue], # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ) | |
| return AsyncHttpResponse(response=_response, data=_data) | |
| if _response.status_code == 422: | |
| raise UnprocessableEntityError( | |
| headers=dict(_response.headers), | |
| body=typing.cast( | |
| typing.Any, | |
| construct_type( | |
| type_=typing.Any, # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ), | |
| ) | |
| _response_json = _response.json() | |
| except JSONDecodeError: | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) | |
| except ValidationError as e: | |
| raise ParsingError( | |
| status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e | |
| ) | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) | |
| async def search( | |
| self, | |
| *, | |
| query: str, | |
| page_size: typing.Optional[int] = None, | |
| types: typing.Optional[ | |
| typing.Union[KnowledgeBaseDocumentType, typing.Sequence[KnowledgeBaseDocumentType]] | |
| ] = None, | |
| cursor: typing.Optional[str] = None, | |
| request_options: typing.Optional[RequestOptions] = None, | |
| ) -> AsyncHttpResponse[KnowledgeBaseContentSearchResponseModel]: | |
| """ | |
| Fuzzy text search over knowledge base document content | |
| Parameters | |
| ---------- | |
| query : str | |
| The search query text | |
| page_size : typing.Optional[int] | |
| How many documents to return at maximum. Can not exceed 100, defaults to 30. | |
| types : typing.Optional[typing.Union[KnowledgeBaseDocumentType, typing.Sequence[KnowledgeBaseDocumentType]]] | |
| If present, the endpoint will return only documents of the given types. | |
| cursor : typing.Optional[str] | |
| Used for fetching next page. Cursor is returned in the response. | |
| request_options : typing.Optional[RequestOptions] | |
| Request-specific configuration. | |
| Returns | |
| ------- | |
| AsyncHttpResponse[KnowledgeBaseContentSearchResponseModel] | |
| Successful Response | |
| """ | |
| _response = await self._client_wrapper.httpx_client.request( | |
| "v1/convai/knowledge-base/search", | |
| method="GET", | |
| params={ | |
| "query": query, | |
| "page_size": page_size, | |
| "types": types, | |
| "cursor": cursor, | |
| }, | |
| request_options=request_options, | |
| ) | |
| try: | |
| if 200 <= _response.status_code < 300: | |
| _data = typing.cast( | |
| KnowledgeBaseContentSearchResponseModel, | |
| construct_type( | |
| type_=KnowledgeBaseContentSearchResponseModel, # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ) | |
| return AsyncHttpResponse(response=_response, data=_data) | |
| if _response.status_code == 422: | |
| raise UnprocessableEntityError( | |
| headers=dict(_response.headers), | |
| body=typing.cast( | |
| typing.Any, | |
| construct_type( | |
| type_=typing.Any, # type: ignore | |
| object_=_response.json(), | |
| ), | |
| ), | |
| ) | |
| _response_json = _response.json() | |
| except JSONDecodeError: | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) | |
| except ValidationError as e: | |
| raise ParsingError( | |
| status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e | |
| ) | |
| raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) | |