BigDL-LLM LangChain API
=====================

llm.langchain.embeddings.bigdlllm
----------------------------------------

.. autoclass:: bigdl.llm.langchain.embeddings.bigdlllm.LlamaEmbeddings
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: ggml_model , ggml_module

    .. automethod:: validate_environment
    .. automethod:: embed_documents
    .. automethod:: embed_query 


.. autoclass:: bigdl.llm.langchain.embeddings.bigdlllm.BloomEmbeddings
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: ggml_model , ggml_module

    .. automethod:: validate_environment
    .. automethod:: embed_documents
    .. automethod:: embed_query


.. autoclass:: bigdl.llm.langchain.embeddings.bigdlllm.GptneoxEmbeddings
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: ggml_model , ggml_module

    .. automethod:: validate_environment
    .. automethod:: embed_documents
    .. automethod:: embed_query


.. autoclass:: bigdl.llm.langchain.embeddings.bigdlllm.ChatGLMEmbeddings
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: ggml_model , ggml_module

    .. automethod:: validate_environment
    .. automethod:: embed_documents
    .. automethod:: embed_query


.. autoclass:: bigdl.llm.langchain.embeddings.bigdlllm.StarcoderEmbeddings
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: ggml_model , ggml_module

    .. automethod:: validate_environment
    .. automethod:: embed_documents
    .. automethod:: embed_query


llm.langchain.embeddings.transformersembeddings
--------------------------------------------------

.. automodule:: bigdl.llm.langchain.embeddings.transformersembeddings
    :members:
    :undoc-members:
    :show-inheritance:


llm.langchain.llms.bigdlllm
----------------------------------------

.. autoclass:: bigdl.llm.langchain.llms.bigdlllm.LlamaLLM
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: ggml_model , ggml_module

    .. automethod:: validate_environment
    .. automethod:: stream
    .. automethod:: get_num_tokens


.. autoclass:: bigdl.llm.langchain.llms.bigdlllm.BloomLLM
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: ggml_model , ggml_module

    .. automethod:: validate_environment
    .. automethod:: stream
    .. automethod:: get_num_tokens 


.. autoclass:: bigdl.llm.langchain.llms.bigdlllm.GptneoxLLM
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: ggml_model , ggml_module

    .. automethod:: validate_environment
    .. automethod:: stream
    .. automethod:: get_num_tokens


.. autoclass:: bigdl.llm.langchain.llms.bigdlllm.ChatGLMLLM
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: ggml_model , ggml_module

    .. automethod:: validate_environment
    .. automethod:: stream
    .. automethod:: get_num_tokens


.. autoclass:: bigdl.llm.langchain.llms.bigdlllm.StarcoderLLM
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: ggml_model , ggml_module

    .. automethod:: validate_environment
    .. automethod:: stream
    .. automethod:: get_num_tokens


llm.langchain.llms.transformersllm
----------------------------------------

.. automodule:: bigdl.llm.langchain.llms.transformersllm
    :members:
    :undoc-members:
    :show-inheritance:


llm.langchain.llms.transformerspipelinellm
---------------------------------------------

.. automodule:: bigdl.llm.langchain.llms.transformerspipelinellm
    :members:
    :undoc-members:
    :show-inheritance: