Перейти к основному содержимому

Пакет langchain_compressa

  • Субмодули​

    • langchain_compressa.chat_models Чат модели Compressa
    • langchain_compressa.embeddings Embedding модели Compressa
    • langchain_compressa.reranks Rerank модели Compressa

  • Классы​

    • ChatCompressa​

      • client
      • compressa_api_key
      • model_kwargs
      • model_name
      • streaming
      • temperature

    • CompressaEmbeddings​

      • client
      • compressa_api_key
      • embed_documents
      • embed_query
      • model
      • model_kwargs
      • tiktoken_enabled
      • tiktoken_model_name

    • CompressaRerank​

      • client
      • compress_documents
      • compressa_api_key
      • model
      • top_n

ChatCompressa​

Интеграция чат моделей.

Установка: Установите пакетlangchain_compressa и переменную окружения COMPRESSA_API_KEY.

pip install langchain-compressa
export COMPRESSA_API_KEY="ваш-ключ-здесь"

Ключевые аргументы инициализации — параметры для комплишн:
model: str Имя модели Compressa для использования.
temperature: float Температура выборки.

Ключевые аргументы инициализации — параметры клиента:
api_key: Optional[str] Ключ Compressa API. Если не передан то будет читаться из переменной окружения COMPRESSA_API_KEY.

Полный список поддерживаемых аргументов инициализации и их описания см. в разделе параметров.

Создание экземпляра:

        from langchain_compressa import ChatCompressa
    
        llm = ChatCompressa(
            model="...",
            temperature=0,
            # api_key="...",
        )

Вызов:

        messages = [
            ("system", "Ты полезный переводчик. Переведи предложение пользователя на французский."),
            ("human", "Я люблю программирование."),
        ]
        llm.invoke(messages)

Стриминг:

        for chunk in llm.stream(messages):
            print(chunk)
    
        stream = llm.stream(messages)
        full = next(stream)
        for chunk in stream:
            full += chunk
        full

Создайте новую модель путем анализа и проверки входных данных на основе ключевых аргументов.
Вызывает ValidationError, если входные данные невозможно проанализировать для формирования допустимой модели.

Родительские классы​

  • langchain_core.language_models.chat_models.BaseChatModel
  • langchain_core.language_models.base.BaseLanguageModel
  • langchain_core.runnables.base.RunnableSerializable
  • langchain_core.load.serializable.Serializable
  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation
  • langchain_core.runnables.base.Runnable
  • typing.Generic
  • abc.ABC

Переменные класса​

var client : Any
Создаётся внутри класса автоматически для обращения к API Compressa.

var compressa_api_key : Optional[pydantic.v1.types.SecretStr]
Автоматически берётся из переменной окружения COMPRESSA_API_KEY если не предоставлен.

var model_kwargs : Dict[str, Any]
Содержит любые параметры модели, действительные для вызова create, которые не указаны явно.

var model_name : str
Имя чат модели для использования.

var streaming : bool
Выполнять стриминг результатов или нет

var temperature : float
Температура для использования.

CompressaEmbeddings​

Для использования вам необходимо иметь переменную окружения COMPRESSA_API_KEY с установленным вашим ключом Compressa API, или передать ключ как именованный параметр конструктора.

Пример:

from langchain_compressa import CompressaEmbeddings
model = CompressaEmbeddings()

Создайте новую модель путем анализа и проверки входных данных на основе ключевых аргументов.
Вызывает ValidationError, если входные данные невозможно проанализировать для формирования допустимой модели.

Родительские классы​

  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation
  • langchain_core.embeddings.embeddings.Embeddings
  • abc.ABC

Переменные класса​

var client : Any
Создаётся внутри класса автоматически для обращения к API Compressa.

var compressa_api_key : Optional[pydantic.v1.types.SecretStr]
Автоматически берётся из переменной окружения COMPRESSA_API_KEY если не предоставлен.

var model : str
Имя embedding модели для использования.

var model_kwargs : Dict[str, Any]
Содержит любые параметры модели, действительные для вызова create, которые не указаны явно.

var tiktoken_enabled : bool
По умолчанию False

var tiktoken_model_name : Optional[str]
Имя tiktoken модели для использования.

Методы​

def embed_documents(self, texts: List[str]) ‑> List[List[float]]
Embed для списка документов

def embed_query(self, text: str) ‑> List[float]
Embed для строкового запроса

CompressaRerank​

Компрессор документов который использует Compressa Rerank API.

Создайте новую модель путем анализа и проверки входных данных на основе ключевых аргументов.
Вызывает ValidationError, если входные данные невозможно проанализировать для формирования допустимой модели.

Родительские классы​

  • langchain_core.documents.compressor.BaseDocumentCompressor
  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation
  • abc.ABC

Переменные класса​

var client : Any
Создаётся внутри класса автоматически для обращения к API Compressa.

var compressa_api_key : Optional[pydantic.v1.types.SecretStr]
Ключ Compressa API. Может быть определён непосредственно или путём установки переменной окружения COMPRESSA_API_KEY.

var model : str
Модель Compressa, используемая для реранка

var top_n : Optional[int]
Количество возвращаемых документов.

Методы​

compress_documents
Сжатие (compress) документов с использованием Compressa rerank API.

Args​

documents
Последовательность документов для сжатия.
query
Запрос, используемый для компрессии документов.
callbacks
Обратные вызовы для запуска во время процесса сжатия.

Returns​

Последовательность сжатых документов.