Method: corpora.query

מבצע חיפוש סמנטי ב-Corpus.

בקשת HTTP

POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
name

string

חובה. שם ה-Corpus שיש להריץ עליו שאילתה. לדוגמה: corpora/my-corpus-123

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON
{
  "query": string,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "resultsCount": integer
}
שדות
query

string

חובה. מחרוזת שאילתה לביצוע חיפוש סמנטי.

metadataFilters[]

object (MetadataFilter)

אפשרות. סינון לפי מטא-נתונים מסוג Chunk ו-Document. כל אובייקט MetadataFilter צריך להתאים למפתח ייחודי. כמה אובייקטים מסוג MetadataFilter מצורפים באמצעות פונקציות "AND" לוגיות.

שאילתה לדוגמה ברמת המסמך: (שנה >= 2020 OR שנה < 2010) AND (ז'אנר = דרמה OR ז'אנר = פעולה)

MetadataFilterObject list: meta_valueActivity = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, action = GREATER_EQUAL}, {int_value = 2010, Action = LESS}]}, {key = "document.custom_metadata.{int_0 condition" = [meta_value} תנאים.{int_value}

שאילתה לדוגמה ברמת קבוצת הנתונים, עבור טווח מספרי של ערכים: (שנה > 2015 וגם שנה <= 2020)

MetadataFilter אובייקטים מסוג: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, action = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, action = LESS_EQUAL}

הערה: תווי AND עבור אותו מקש נתמכים רק עבור ערכים מספריים. ערכי מחרוזת תומכים רק ב-OR (או) לאותו מפתח.

resultsCount

integer

אפשרות. המספר המרבי של Chunk שניות להחזרה. השירות עשוי להחזיר פחות Chunk שניות.

אם לא צוין, יוחזרו עד 10 ערכי Chunk. ניתן לציין עד 100 תוצאות.

גוף התשובה

תשובה מ-corpora.query שמכילה רשימה של מקטעים רלוונטיים.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}
שדות
relevantChunks[]

object (RelevantChunk)

המקטעים הרלוונטיים.

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

למידע נוסף, קראו את הסקירה הכללית על אימות.