שימוש בחיפוש בסוכן כקצה עורפי לאחזור באמצעות מנוע RAG

REST

כדי ליצור מאגר מידע של RAG באמצעות שורת הפקודה, מבצעים את הפעולות הבאות:

1. יצירת מאגר מידע של RAG

   מחליפים את המשתנים הבאים שמופיעים בדוגמת הקוד:

   • ‫PROJECT_ID: מזהה הפרויקט ב- Cloud de Confiance by S3NS .
   • ‫LOCATION: האזור שבו הבקשה תעובד.
   • ‫DISPLAY_NAME: השם המוצג של מאגר המידע של RAG שרוצים ליצור.
   • ‫ENGINE_NAME: שם המשאב המלא של מנוע החיפוש של Agent או של מאגר המידע של Agent Search. לדוגמה,

     projects/PROJECT_NUMBER/locations/LOCATION/collections/default_collection/engines/ENGINE_NAME/servingConfigs/default_search

   curl -X POST \
   -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/ragCorpora" \
   -d '{
     "display_name" : "DISPLAY_NAME",
     "vertex_ai_search_config" : {
       "serving_config": "ENGINE_NAME/servingConfigs/default_search"
     }
   }'
   

2. מעקב אחרי ההתקדמות

   מחליפים את המשתנים הבאים שמופיעים בדוגמת הקוד:

   • ‫PROJECT_ID: מזהה הפרויקט ב- Cloud de Confiance by S3NS .
   • ‫LOCATION: האזור שבו הבקשה תעובד.
   • ‫OPERATION_ID: המזהה של פעולת היצירה של מאגר המידע של RAG.

   curl -X GET \
   -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID"
   

Python

לפני שמנסים את הדוגמה הזו, צריך לפעול לפי הוראות ההגדרה של Python במדריך למתחילים של Agent Platform באמצעות ספריות לקוח.

כדי לבצע אימות בפלטפורמת הסוכן, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.

לפני שמריצים דוגמאות קוד, צריך להגדיר את משתנה הסביבה GOOGLE_CLOUD_UNIVERSE_DOMAIN לערך s3nsapis.fr.

import agentplatform
from agentplatform import types

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# vertex_ai_search_engine_name = "projects/{PROJECT_ID}/locations/{LOCATION}/collections/default_collection/engines/{ENGINE_ID}"
# display_name = "test_corpus"
# description = "Corpus Description"

# Initialize Agent Platform client once per session
client = agentplatform.Client(project=PROJECT_ID, location="us-central1")

# Configure Search
vertex_ai_search_config = types.VertexAiSearchConfig(
    serving_config=f"{vertex_ai_search_engine_name}/servingConfigs/default_search",
)

corpus = client.rag.create_corpus(
    rag_corpus=types.RagCorpus(
        display_name=display_name,
        description=description,
        vertex_ai_search_config=vertex_ai_search_config,
    ),
)
print(corpus)
# Example response:
# RagCorpus(name='projects/1234567890/locations/us-central1/ragCorpora/1234567890',
# display_name='test_corpus', description='Corpus Description'.
# ...

REST

בדוגמת הקוד הזו אפשר לראות איך מאחזרים הקשרים באמצעות REST.

מחליפים את המשתנים הבאים שמופיעים בדוגמת הקוד:

• ‫PROJECT_ID: מזהה הפרויקט ב- Cloud de Confiance by S3NS .
• ‫LOCATION: האזור שבו הבקשה תעובד.
• ‫RAG_CORPUS_RESOURCE: השם של משאב קורפוס ה-RAG.

  פורמט: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.

• ‫TEXT: טקסט השאילתה כדי לקבל הקשרים רלוונטיים.

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:retrieveContexts" \
  -d '{
    "vertex_rag_store": {
      "rag_resources": {
        "rag_corpus": "RAG_CORPUS_RESOURCE"
      }
    },
    "query": {
      "text": "TEXT"
    }
  }'

Python

במאמר התקנת Vertex AI SDK ל-Python מוסבר איך להתקין או לעדכן את Vertex AI SDK ל-Python. מידע נוסף מופיע ב מאמרי העזרה של ה-API מבוסס-Python.

import agentplatform

from agentplatform import types
from google.genai import types as genai_types

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# corpus_name = "projects/[PROJECT_ID]/locations/us-central1/ragCorpora/[rag_corpus_id]"

# Initialize Agent Platform client once per session
client = agentplatform.Client(project=PROJECT_ID, location="us-east4")

response = client.rag.retrieve_contexts(
    vertex_rag_store=genai_types.VertexRagStore(
        rag_resources=[
            genai_types.VertexRagStoreRagResource(
                rag_corpus=corpus_name,
                # Optional: supply IDs from `rag.list_files()`.
                # rag_file_ids=["rag-file-1", "rag-file-2", ...],
            )
        ],
    ),
    query=types.RagQuery(
        text="Hello World!",
        rag_retrieval_config=genai_types.RagRetrievalConfig(
            top_k=10,
            filter=genai_types.RagRetrievalConfigFilter(
                vector_distance_threshold=0.5
            ),
        ),
    )
)
print(response)
# Example response:
# contexts {
#   contexts {
#     source_uri: "gs://your-bucket-name/file.txt"
#     text: "....
#   ....

REST

כדי ליצור תוכן באמצעות מודלים של Gemini, צריך לבצע קריאה ל-API של פלטפורמת הסוכנים GenerateContent. כשמציינים את RAG_CORPUS_RESOURCE בבקשה, הנתונים נשלפים אוטומטית מ-Agent Search.

מחליפים את המשתנים הבאים שמופיעים בקוד לדוגמה:

• ‫PROJECT_ID: מזהה הפרויקט ב- Cloud de Confiance by S3NS .

• ‫LOCATION: האזור שבו הבקשה תעובד.

• ‫MODEL_ID: מודל LLM ליצירת תוכן. לדוגמה, gemini-3.8-flash.

• ‫GENERATION_METHOD: שיטת LLM ליצירת תוכן. לדוגמה, generateContent, ‏ streamGenerateContent.

• ‫INPUT_PROMPT: הטקסט שנשלח ל-LLM ליצירת תוכן. כדאי לנסות להשתמש בפרומפט שרלוונטי למסמכים בחיפוש הסוכן.

• ‫RAG_CORPUS_RESOURCE: השם של משאב קורפוס ה-RAG. פורמט: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.

• ‫SIMILARITY_TOP_K: אופציונלי: מספר ההקשרים המובילים לאחזור.

  curl -X POST \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/publishers/google/models/MODEL_ID:GENERATION_METHOD" \
  -d '{
    "contents": {
      "role": "user",
      "parts": {
        "text": "INPUT_PROMPT"
      }
    },
    "tools": {
      "retrieval": {
        "disable_attribution": false,
        "vertex_rag_store": {
          "rag_resources": {
              "rag_corpus": "RAG_CORPUS_RESOURCE"
            },
          "similarity_top_k": SIMILARITY_TOP_K
        }
      }
    }
  }'
  

Python

במאמר התקנת Vertex AI SDK ל-Python מוסבר איך להתקין או לעדכן את Vertex AI SDK ל-Python. מידע נוסף מופיע ב מאמרי העזרה של ה-API מבוסס-Python.

from google import genai
from google.genai import types as genai_types

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# corpus_name = "projects/{PROJECT_ID}/locations/us-central1/ragCorpora/{rag_corpus_id}"

rag_retrieval_tool = genai_types.Tool(
    retrieval=genai_types.Retrieval(
        vertex_rag_store=genai_types.VertexRagStore(
            rag_resources=[
                genai_types.VertexRagStoreRagResource(
                    rag_corpus=corpus_name
                )
            ],
            rag_retrieval_config=genai_types.RagRetrievalConfig(
                top_k=10,
                filter=genai_types.RagRetrievalConfigFilter(
                    vector_distance_threshold=0.5
                ),
            ),
        ),
    )
)

# Create a GenAI SDK client to make a generate_content request
genai_client = genai.Client(enterprise=True, project=PROJECT_ID, location="us-central1")

response = genai_client.models.generate_content(
    model="gemini-2.5-pro",
    contents="Why is the sky blue?",
    config=genai_types.GenerateContentConfig(
        tools=[rag_retrieval_tool]
    )
)
print(response.text)
# Example response:
#   The sky appears blue due to a phenomenon called Rayleigh scattering.
#   Sunlight, which contains all colors of the rainbow, is scattered
#   by the tiny particles in the Earth's atmosphere....
#   ...