superwise_api.entities.knowledge

class KnowledgeApi(superwise_api.entities.base.BaseApi):

This class provides methods to interact with the KnowledgeApi API.

Attributes:
  • api_client (ApiClient): An instance of the ApiClient to make requests.
  • _model_name (str): The name of the model.
  • _resource_path (str): The path of the resource.
  • _model_class (KnowledgeApi): The model class.
def get_by_id(self, knowledge_id: str, with_deleted: bool = False, **kwargs) -> dict:

Gets knowledge by id.

Arguments:
  • knowledge_id (str): The id of the knowledge.
  • with_deleted: Whether to include deleted knowledge.
  • **kwargs: Arbitrary keyword arguments.
Returns:

Knowledge: The knowledge.

def delete(self, knowledge_id: str, **kwargs) -> None:

Deletes knowledge.

Arguments:
  • knowledge_id (str): The id of the knowledge.
  • **kwargs: Arbitrary keyword arguments.
def create( self, name: str, knowledge_metadata: typing.Annotated[superwise_api.models.tool.tool.UrlKnowledgeMetadata | superwise_api.models.tool.tool.FileKnowledgeMetadata, Discriminator(discriminator='type', custom_error_type=None, custom_error_message=None, custom_error_context=None)], embedding_model: superwise_api.models.tool.tool.EmbeddingModel, **kwargs) -> pydantic.main.BaseModel:

Creates new knowledge.

Arguments:
  • name (str): The name of the knowledge.
  • knowledge_metadata (superwise_api.models.tool.tool.KnowledgeMetadata): knowledge params.
  • embedding_model (EmbeddingModel): The parameters of the embedding model.
  • **kwargs: Arbitrary keyword arguments.
Returns:

Knowledge: The created knowledge.

def get( self, page: Optional[int] = None, size: Optional[int] = None, with_deleted: bool = False, **kwargs) -> superwise_api.client.models.page.Page:

Retrieves knowledge. Filter if any of the parameters are provided.

Arguments:
  • page (int, optional): The page number.
  • size (int, optional): The size of the page.
  • with_deleted: Whether to include deleted knowledge.
  • **kwargs: Arbitrary keyword arguments.
Returns:

Page: A page of knowledge.

def update( self, knowledge_id: str, name: Optional[str] = None, **kwargs) -> pydantic.main.BaseModel:

Updates knowledge.

Arguments:
  • knowledge_id (str): The id of the knowledge.
  • name (str, optional): The new name of the knowledge.
  • **kwargs: Arbitrary keyword arguments.
Returns:

Knowledge: The updated knowledge.

def get_files_info( self, file_ids: list[str], **kwargs) -> list[superwise_api.models.tool.tool.FileInfo]:

Retrieves file info.

Arguments:
  • file_ids: list of file ids to receive info about.
  • **kwargs: Arbitrary keyword arguments.
Returns:

list[FileInfo]: A list of FileInfo for each requested id.

def reindex_url_knowledge( self, knowledge_id: str, **kwargs) -> superwise_api.models.knowledge.knowledge.Knowledge:

Reindex url knowledge.

Arguments:
  • knowledge_id: id of the knowledge to reindex.
  • **kwargs: Arbitrary keyword arguments.
Returns:

Knowledge: the reindexed knowledge

Inherited Members
superwise_api.entities.base.BaseApi
BaseApi
api_client
wrap_api_calls
raise_exception