メインコンテンツへスキップ
見出し画像

LlamaIndex の VectorIndexAutoRetriever を試す

    「LlamaIndex」の「VectorIndexAutoRetriever」を試したので、まとめました。

    1. VectorIndexAutoRetriever

    「VectorIndexAutoRetriever」は、LLM を使用して、クエリ文字列とメタデータフィルタを自動生成して検索を実行するリトリバーです。これにより、top-k セマンティック検索を超えた、より動的で表現力豊かな形式の検索が可能になります。

    画像

    一般的なベクトルデータベースの多くは、セマンティック検索用のクエリ文字列に加えて、一連のメタデータフィルタをサポートしています。

    画像

    2. セットアップ

    Colabでのセットアップ手順は、次のとおりです。

    (1) パッケージのインストール。
    今回は、ベクトルデータベースとしてChromaを使います。

    # パッケージのインストール
    !pip install llama-index
    !pip install chromadb

    (2) 環境変数の準備。
    以下のコードの <OpenAI_APIのトークン> にはOpenAI APIのトークンを指定します。(有料)

    import os
    
    # 環境変数の設定
    openai.api_key = "<OpenAI_APIのトークン>"

    (3) ログレベルの設定。

    import logging
    import sys
    
    # ログレベルの設定
    logging.basicConfig(stream=sys.stdout, level=logging.DEBUG, force=True)

    (4) Chromaのコレクションの準備。

    import chromadb
    
    # chromaコレクションを定義
    chroma_client = chromadb.EphemeralClient()
    chroma_collection = chroma_client.create_collection("quickstart")

    3. VectorStoreIndexの準備

    ColabでのVectorStoreIndexの準備手順は、次のとおりです。

    (1) ノード群の準備。
    メタデータ (yearとcountry) も設定します。

    from llama_index.schema import TextNode
    
    # ノード群の準備
    nodes = [
        TextNode(
            text="「魔法少女まどか☆マギカ」は、シャフト制作による日本のアニメーション作品。",
            metadata={
                "year": "2011",
                "country": "Japan",
            },
        ),
        TextNode(
            text="「RWBY」は、アメリカのルースター・ティース・プロダクションが制作したWEBアニメシリーズ。",
            metadata={
                "year": "2013",
                "country": "United States",
            },
        ),
        TextNode(
            text="「リコリス・リコイル」は、A-1 Pictures制作による日本のアニメーション作品。",
            metadata={
                "year": "2022",
                "country": "Japan",
            },
        ),
    ]

    (2) VectorStoreIndexの準備。

    from llama_index import VectorStoreIndex, StorageContext
    from llama_index.vector_stores import ChromaVectorStore
    
    # VectorStoreIndexの準備
    vector_store = ChromaVectorStore(chroma_collection=chroma_collection)
    storage_context = StorageContext.from_defaults(vector_store=vector_store)
    index = VectorStoreIndex(nodes, storage_context=storage_context)

    4. VectorIndexAutoRetrieverの準備

    Colabでの「VectorIndexAutoRetriever」の準備手順は、次のとおりです。

    (1) 日本語版のVectorQueryStoreプロンプトの定義。
    LlamaIndexの英語版のVectorQueryStoreプロンプトの直訳になります。

    # VectorQueryStoreプロンプトの定義
    VECTOR_STORE_QUERY_PROMPT = """あなたの目標は、以下に示すリクエストスキーマと一致するようにユーザーのクエリを構造化することです。
    
    << Structured Request Schema >>
    レスポンスには、次のスキーマでフォーマットされたJSONオブジェクトを含むMarkdownコードを使用します。
    
    {schema_str}
    
    クエリ文字列には、ドキュメントの内容と一致すると予想されるテキストのみを含める必要があります。フィルタ内の条件はクエリ内でも言及しないでください。
    
    フィルタがデータソースに存在する属性のみを参照するようにしてください。
    フィルタが属性の説明を考慮していることを確認してください。
    フィルタは必要な場合にのみ使用するようにしてください。適用するフィルタがない場合は、フィルタ値として [] を返します。
    ユーザーのクエリで取得する文書の数が明示的に指定されている場合は、top_k をその数に設定します。それ以外の場合は、top_k を設定しないでください。
    
    << Example 1. >>
    Data Source:
    ```json
    {{
        "metadata_info": [
            {{
                "name": "artist",
                "type": "str",
                "description": "Name of the song artist"
            }},
            {{
                "name": "genre",
                "type": "str",
                "description": "The song genre, one of \"pop\", \"rock\" or \"rap\""
            }}
        ],
        "content_info": "Lyrics of a song"
    }}
    ```
    
    User Query:
    ダンスポップジャンルのテイラー・スウィフトやケイティ・ペリーの曲は何ですか?
    
    Structured Request:
    ```json
    {{"query": "ダンスポップジャンルのテイラー・スウィフトやケイティ・ペリーの曲は何ですか?", "filters": [{{"key": "artist", "value": "Taylor Swift"}}, {{"key": "artist", "value": "Katy Perry"}}, {{"key": "genre", "value": "pop"}}], "top_k": null}}
    ```
    
    << Example 2. >>
    Data Source:
    ```json
    {info_str}
    ```
    
    User Query:
    {query_str}
    
    Structured Request:"""

    (2) VectorIndexAutoRetrieverの準備。
    VectorStore情報には、メタデータの情報を仕様します。

    from llama_index.indices.vector_store.retrievers import VectorIndexAutoRetriever
    from llama_index.vector_stores.types import MetadataInfo, VectorStoreInfo
    
    # VectorStore情報の準備
    vector_store_info = VectorStoreInfo(
        content_info="アニメ作品の情報",
        metadata_info=[
            MetadataInfo(
                name="year",
                type="str",
                description="アニメ作品の放送開始年。[2010, 2011, 2012, 2013]など",
            ),
            MetadataInfo(
                name="country",
                type="str",
                description="アニメ作品の制作国。[United States, Japan]など",
            ),
        ],
    )
    
    # VectorIndexAutoRetrieverの準備
    retriever = VectorIndexAutoRetriever(
        index, 
        prompt_template_str=VECTOR_STORE_QUERY_PROMPT,
        vector_store_info=vector_store_info
    )

    5. 質問応答の実行

    Colabでの質問応答の実行手順は、次のとおりです。

    (1) 日本語版のQAプロンプトの定義。
    LlamaIndexの英語版のQAプロンプトの直訳になります。

    from llama_index.llms.base import ChatMessage, MessageRole
    from llama_index.prompts.base import ChatPromptTemplate
    
    # QAシステムプロンプトの定義
    TEXT_QA_SYSTEM_PROMPT = ChatMessage(
        content=(
            "あなたは世界中で信頼されているQAシステムです。\n"
            "事前知識ではなく、常に提供されたコンテキスト情報を使用してクエリに回答してください。\n"
            "従うべきいくつかのルール:\n"
            "1. 回答内で指定されたコンテキストを直接参照しないでください。\n"
            "2. 「コンテキストに基づいて、...」や「コンテキスト情報は...」、またはそれに類するような記述は避けてください。"
        ),
        role=MessageRole.SYSTEM,
    )
    
    # QAプロンプトテンプレートメッセージの定義
    TEXT_QA_PROMPT_TMPL_MSGS = [
        TEXT_QA_SYSTEM_PROMPT,
        ChatMessage(
            content=(
                "コンテキスト情報は以下のとおりです。\n"
                "---------------------\n"
                "{context_str}\n"
                "---------------------\n"
                "事前知識ではなくコンテキスト情報を考慮して、クエリに答えます。\n"
                "Query: {query_str}\n"
                "Answer: "
            ),
            role=MessageRole.USER,
        ),
    ]
    
    # QAプロンプトの定義
    CHAT_TEXT_QA_PROMPT = ChatPromptTemplate(message_templates=TEXT_QA_PROMPT_TMPL_MSGS)

    (2) クエリエンジンの準備。

    from llama_index.query_engine import RetrieverQueryEngine
    from llama_index.response_synthesizers import get_response_synthesizer
    
    # ResponseSynthesizerの準備
    response_synthesizer = get_response_synthesizer(
        response_mode="compact",
        text_qa_template=CHAT_TEXT_QA_PROMPT,
    )
    
    # クエリエンジンの準備
    query_engine = RetrieverQueryEngine.from_args(
        retriever,
        response_synthesizer=response_synthesizer
    )

    (3) メタデータ「year」を使用する質問応答。

    # 質問応答
    response = query_engine.query("2022年に放映開始されたアニメ作品を1つ教えてください。")
    print(response)
    2022年に放映開始されたアニメ作品の1つは、「リコリス・リコイル」です。


    ログを確認すると、VectorQueryStoreプロンプトで以下の結果が出力されています。

    ```json
    {"query": "2022年に放映開始されたアニメ作品を1つ教えてください。", "filters": [{"key": "year", "value": "2022"}], "top_k": 1}
    ```
    Using query str: 2022年に放映開始されたアニメ作品を1つ教えてください。
    Using filters: {'year': '2022'}
    Using top_k: 1

    (4) メタデータ「country」を使用する質問応答。

    # 質問応答
    response = query_engine.query("アメリカのアニメ作品を1つ教えてください。")
    print(response)
    「RWBY」はアメリカのアニメ作品です


    ログを確認すると、VectorQueryStoreプロンプトで以下の結果が出力されています。

    ```json
    {"query": "アメリカのアニメ作品を1つ教えてください。", "filters": [{"key": "country", "value": "United States"}], "top_k": 1}
    ```
    Using query str: アメリカのアニメ作品を1つ教えてください。
    Using filters: {'country': 'United States'}
    Using top_k: 1

    (5) メタデータを使用しない質問応答。

    # 質問応答
    response = retriever.retrieve("RWBVのことを教えてください。")
    print(response)
    「RWBY」は、アメリカのルースター・ティース・プロダクションが制作したWEBアニメシリーズです。


    ログを確認すると、VectorQueryStoreプロンプトで以下の結果が出力されています。

    ```json
    {"query": "RWBVのことを教えてください。", "filters": [], "top_k": null}
    ```
    Using query str: RWBVのことを教えてください。
    Using filters: {}
    Using top_k: 2



     
     

    npaka

     
     
    プログラマー。iPhone / Android / Unity / ROS / AI / AR / VR / RasPi / ロボット / ガジェット。年2冊ペースで技術書を執筆。アニソン / カラオケ / ギター / 猫 twitter : @npaka123

    あなたへのおすすめ