Module: retriever

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from abc import ABC
from abc import abstractmethod
from dataclasses import dataclass
from typing import List
from cl.runtime import RecordMixin
from cl.convince.retrievers.retriever_key import RetrieverKey


@dataclass(slots=True, kw_only=True)
class Retriever(RetrieverKey, RecordMixin[RetrieverKey], ABC):
    """Retrieves the requested data from the text."""

    def get_key(self) -> RetrieverKey:
        return RetrieverKey(retriever_id=self.retriever_id)

    # TODO: Use keyword params
    @abstractmethod
    def retrieve(
        self,
        entry_id: str,  # TODO: Generate instead
        input_text: str,
        param_description: str,
        param_samples: List[str] | None = None,
    ) -> str:
        """
        Retrieve the specified parameter from the entry and return it as a smaller entry.

        Args:
            entry_id: The identifier of the entry from which the data is extracted
            input_text: The text from which the data is extracted
            param_description: Parameter description
            param_samples: Optional parameter value samples for a few-shot prompt
        """

Classes

class Retriever (*, retriever_id: str = None)

Retrieves the requested data from the text.

Expand source code

@dataclass(slots=True, kw_only=True)
class Retriever(RetrieverKey, RecordMixin[RetrieverKey], ABC):
    """Retrieves the requested data from the text."""

    def get_key(self) -> RetrieverKey:
        return RetrieverKey(retriever_id=self.retriever_id)

    # TODO: Use keyword params
    @abstractmethod
    def retrieve(
        self,
        entry_id: str,  # TODO: Generate instead
        input_text: str,
        param_description: str,
        param_samples: List[str] | None = None,
    ) -> str:
        """
        Retrieve the specified parameter from the entry and return it as a smaller entry.

        Args:
            entry_id: The identifier of the entry from which the data is extracted
            input_text: The text from which the data is extracted
            param_description: Parameter description
            param_samples: Optional parameter value samples for a few-shot prompt
        """

Ancestors

RetrieverKey
KeyMixin
RecordMixin
abc.ABC
typing.Generic

Subclasses

AnnotatingRetriever

Static methods

def get_key_type() -> Type: Inherited from: RetrieverKey.get_key_type

Return key type even when called from a record.

Fields

var retriever_id -> str: Inherited from: RetrieverKey.retriever_id

Unique retriever identifier.

Methods

def get_key(self) -> RetrieverKey

Inherited from: RecordMixin.get_key

Return a new key object whose fields populated from self, do not return self.

def init_all(self) -> None

Inherited from: RecordMixin.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.

def retrieve(self, entry_id: str, input_text: str, param_description: str, param_samples: Optional[List[str]] = None) -> str

Retrieve the specified parameter from the entry and return it as a smaller entry.

Args

entry_id: The identifier of the entry from which the data is extracted
input_text: The text from which the data is extracted
param_description: Parameter description
param_samples: Optional parameter value samples for a few-shot prompt