Method: corpora.documents.query

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

בקשת HTTP

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

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

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

פרמטרים
name

string

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

גוף הבקשה

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

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

string

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

integer

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

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

object (MetadataFilter)

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

הערה: בבקשה הזו אין תמיכה בסינון ברמת Document כי כבר צוין שם Document.

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

MetadataFilter אובייקטים מסוג: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, action = GREATER_EQUAL}, {int_value = 2010, action = LESS}}, {key = "chunk.custom_metadata.drama" conditions = chunk.custom_metadata.drama

שאילתה לדוגמה עבור טווח מספרי של ערכים: (שנה > 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 (או) לאותו מפתח.

גוף התשובה

תשובה מ-documents.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

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