Corpora

שיטה: corpora.create

הפונקציה יוצרת Corpus ריק.

נקודת קצה

פרסום https://generativelanguage.googleapis.com/v1beta/corpora

גוף הבקשה

גוף הבקשה מכיל מופע של Corpus.

שדות
name string

קבוע. מזהה. שם המשאב Corpus. המזהה (השם, לא כולל הקידומת 'corpora/‎') יכול להכיל עד 40 תווים אלפאנומריים באותיות קטנות או מקפים (-). המזהה לא יכול להתחיל או להסתיים במקף. אם השם ריק בזמן היצירה, המערכת תיצור שם ייחודי מ-displayName עם סיומת אקראית באורך 12 תווים. לדוגמה: corpora/my-awesome-corpora-123a456b789c

displayName string

זה שינוי אופציונלי. שם תצוגה קריא לאנשים של Corpus. אורך השם לתצוגה חייב להיות עד 512 תווים, כולל רווחים. דוגמה: "Docs on Semantic Retriever"

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של Corpus.

שיטה: corpora.query

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

נקודת קצה

פרסום https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

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

name string

חובה. השם של Corpus שרוצים לשלוח אליו שאילתה. דוגמה: corpora/my-corpus-123 הוא בפורמט corpora/{corpora}.

גוף הבקשה

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

שדות
query string

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

metadataFilters[] object (MetadataFilter)

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

שאילתה לדוגמה ברמת המסמך: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter object list: metadataFilters = [ {key = &quot;document.custom_metadata.year&quot; תנאים = [{int_value = 2020, Action = GREATER_EQUAL}, {int_value = 2010, Action = LESS}]}, {key = "document.custom_metadata.year" תנאים = [{int_value = 2020, Action = GREATER_EQUAL}, {int_value = 2010, action = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, operation = EQUAL}]}]

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

רשימת אובייקטים של MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

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

resultsCount integer

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

אם לא צוין ערך, יוחזרו עד 10 ערכים של Chunk. המספר המקסימלי של תוצאות שאפשר לציין הוא 100.

גוף התשובה

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

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

שדות
relevantChunks[] object (RelevantChunk)

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

ייצוג ב-JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

שיטה: corpora.list

בתיבת הדו-שיח הזו מפורטים כל Corpora שבבעלות המשתמש.

נקודת קצה

הורדה https://generativelanguage.googleapis.com/v1beta/corpora

פרמטרים של שאילתה

pageSize integer

זה שינוי אופציונלי. המספר המקסימלי של Corpora להחזרה (לכל דף). השירות עשוי להחזיר פחות Corpora.

אם לא צוין, יוחזרו לכל היותר 10 Corpora. מגבלת הגודל המקסימלית היא 20 Corpora לכל דף.

pageToken string

זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת ב-corpora.list.

צריך לספק את ה-nextPageToken שהוחזר בתשובה כארגומנט לבקשה הבאה כדי לאחזר את הדף הבא.

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-corpora.list חייבים להתאים לקריאה שסיפקה את אסימון הדף.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

תגובה מ-corpora.list שמכילה רשימה מחולקת לדפים של Corpora. התוצאות ממוינות לפי corpus.create_time עולה.

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

שדות
corpora[] object (Corpus)

מאגרי הנתונים שהוחזרו.

nextPageToken string

אסימון שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא. אם השדה הזה לא יצוין, לא יהיו דפים נוספים.

ייצוג ב-JSON 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

שיטה: corpora.get

קבלת מידע על Corpus ספציפי.

נקודת קצה

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

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

name string

חובה. השם של Corpus. דוגמה: corpora/my-corpus-123 הוא בפורמט corpora/{corpora}.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

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

שיטה: corpora.patch

מתבצע עדכון של Corpus.

נקודת קצה

תיקון https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

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

corpus.name string

קבוע. מזהה. שם המשאב Corpus. המזהה (שם לא כולל התחילית 'corpora/ ') יכול להכיל עד 40 תווים אלפאנומריים או מקפים (-). המזהה לא יכול להתחיל או להסתיים במקף. אם השם יהיה ריק בזמן היצירה, המערכת תיצור שם ייחודי מ-displayName יחד עם סיומת אקראית בת 12 תווים. לדוגמה: corpora/my-awesome-corpora-123a456b789c היא מופיעה בצורה corpora/{corpora}.

פרמטרים של שאילתה

updateMask string (FieldMask format)

חובה. רשימת השדות שרוצים לעדכן. נכון לעכשיו, הגרסה הזו תומכת רק בעדכון של displayName.

זוהי רשימה של שמות שדות מוגדרים במלואם, שמופרדים בפסיקים. דוגמה: "user.displayName,photo"

גוף הבקשה

גוף הבקשה מכיל מופע של Corpus.

שדות
displayName string

זה שינוי אופציונלי. השם המוצג של ה-Corpus, שקריא לבני אדם. השם המוצג יכול להיות באורך של 512 תווים לכל היותר, כולל רווחים. דוגמה: "Docs on Semantic Retriever"

גוף התשובה

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

שיטה: corpora.delete

מתבצעת מחיקה של Corpus.

נקודת קצה

מחיקת https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

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

name string

חובה. שם המשאב של ה-Corpus. דוגמה: corpora/my-corpus-123 הוא בפורמט corpora/{corpora}.

פרמטרים של שאילתה

force boolean

זה שינוי אופציונלי. אם המדיניות מוגדרת כ-True, כל הפריטים מסוג 'Document' ו'אובייקטים' שקשורים ל-Corpus הזה יימחקו גם הם.

אם הערך הוא False (ברירת המחדל), תוחזר שגיאת FAILED_PRECONDITION אם הערך של Corpus מכיל ערכים מסוג Document.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.

משאב REST: corpora.permissions

משאב: הרשאה

משאב ההרשאה מעניק למשתמש, לקבוצה או לשאר העולם גישה למשאב של PaLM API (למשל, מודל מכוונן, קורפוס).

תפקיד הוא אוסף של פעולות מותרות שמאפשרות למשתמשים לבצע פעולות ספציפיות במשאבי PaLM API. כדי שיהיו זמינים למשתמשים, לקבוצות או לחשבונות שירות, צריך להקצות תפקידים. כשאתם מקצים תפקיד, אתם מעניקים לו את ההרשאות שהתפקיד כולל.

יש שלושה תפקידים קונצנטריים. כל תפקיד הוא קבוצת-על של הפעולות המותרות של התפקיד הקודם:

  • הקורא יכול להשתמש במשאב (למשל מודל מותאם, קורפוס) להסקה
  • לכותב יש הרשאות של קורא, וגם אפשרות לערוך ולשתף
  • לבעלים יש הרשאות כתיבה וגם למחוק
שדות
name string

פלט בלבד. מזהה. שם ההרשאה. שם ייחודי ייווצר בזמן היצירה. דוגמאות: AdjustModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} פלט בלבד.

granteeType enum (GranteeType)

זה שינוי אופציונלי. בלתי ניתן לשינוי. הסוג של מקבל המענק.

emailAddress string

זה שינוי אופציונלי. קבוע. כתובת האימייל של משתמש הקבוצה שאליה ההרשאה הזו מתייחסת. השדה לא מוגדר כשסוג המקבל של ההרשאה הוא 'הכול'.

role enum (Role)

חובה. התפקיד שההרשאה הזו מעניקה.

ייצוג ב-JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

הגדרת הסוגים של מקבל ההרשאה הזו.

טיפוסים בני מנייה (enum)
GRANTEE_TYPE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
USER מייצג משתמש. כשמגדירים את השדה, צריך לציין את כתובת האימייל של המשתמש.
GROUP מייצג קבוצה. כשמגדירים את השדה, צריך לציין את כתובת האימייל של הקבוצה.
EVERYONE מייצג גישה לכולם. אין צורך במידע נוסף.

תפקיד

מגדיר את התפקיד שההרשאה הזו מעניקה.

טיפוסים בני מנייה (enum)
ROLE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
OWNER הבעלים יכול להשתמש במשאב, לעדכן אותו, לשתף אותו ולמחוק אותו.
WRITER הכותבים יכולים להשתמש במשאב, לעדכן אותו ולשתף אותו.
READER הקוראים יכולים להשתמש במשאב.

MetadataFilter

מסנן שהמשתמש סיפק כדי להגביל את אחזור הנתונים על סמך ערכי מטא-נתונים ברמה Chunk או Document. דוגמה (ז'אנר = דרמה או ז'אנר = פעולה): key = "document.custom_metadata.genre" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, operation = EQUAL}]

שדות
key string

חובה. המפתח של המטא-נתונים שלפיו רוצים לסנן.

conditions[] object (Condition)

חובה. ערכי Condition של המפתח הנתון שיפעילו את המסנן הזה. כמה פונקציות Condition מצורפות באמצעות אופרטורים לוגיים מסוג OR.

ייצוג JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

תנאי

תנאי סינון שרלוונטי למפתח יחיד.

שדות
operation enum (Operator)

חובה. האופרטור הוחל על צמד המפתח/ערך הנתון כדי להפעיל את התנאי.

שדה האיחוד value. סוג הערך חייב להיות תואם לסוג הערך שמוגדר בשדה של המפתח התואם. אם סוגי הערכים לא עקביים, התוצאה תהיה קבוצה ריקה. כשהערך של CustomMetadata כולל ערך מסוג StringList, תנאי הסינון צריך להשתמש ב-string_value בשילוב עם פעולת הכללה/החרגה, אחרת התוצאה תהיה גם קבוצה ריקה. value יכול להיות רק אחת מהאפשרויות הבאות:
stringValue string

ערך המחרוזת שלפיו יש לסנן את המטא-נתונים.

numericValue number

הערך המספרי שלפיו יתבצע סינון המטא-נתונים.

ייצוג ב-JSON 
{
  "operation": enum (Operator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}

מפעיל

מגדירה את האופרטורים החוקיים שאפשר להחיל על צמד מפתח/ערך.

טיפוסים בני מנייה (enum)
OPERATOR_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
LESS נתמך על ידי numeric.
LESS_EQUAL נתמך על ידי numeric.
EQUAL נתמך באמצעות מספרי & String.
GREATER_EQUAL נתמך על ידי numeric.
GREATER נתמך על ידי numeric.
NOT_EQUAL יש תמיכה במספרים ובמחרוזות.
INCLUDES נתמך באמצעות מחרוזת רק אם לסוג הערך CustomMetadata למפתח הנתון יש stringListValue.
EXCLUDES נתמכת במחרוזת רק כאשר סוג הערך של CustomMetadata למפתח הנתון מכיל stringListValue.

RelevantChunk

המידע על מקטע שרלוונטי לשאילתה.

שדות
chunkRelevanceScore number

הרלוונטיות של Chunk לשאילתה.

chunk object (Chunk)

Chunk משויך לשאילתה.

ייצוג JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

משאב REST: corpora

מקור מידע: Corpus

Corpus הוא אוסף של Document. אפשר ליצור עד 5 קורפוסים בפרויקט.

שדות
name string

קבוע. מזהה. שם המשאב Corpus. המזהה (השם, לא כולל הקידומת 'corpora/‎') יכול להכיל עד 40 תווים אלפאנומריים באותיות קטנות או מקפים (-). המזהה לא יכול להתחיל או להסתיים במקף. אם השם ריק בזמן היצירה, המערכת תיצור שם ייחודי מ-displayName עם סיומת אקראית באורך 12 תווים. דוגמה: corpora/my-awesome-corpora-123a456b789c

displayName string

זה שינוי אופציונלי. השם המוצג של ה-Corpus, שקריא לבני אדם. אורך השם לתצוגה חייב להיות עד 512 תווים, כולל רווחים. דוגמה: "Docs on Semantic Retriever"

createTime string (Timestamp format)

פלט בלבד. חותמת הזמן של מועד היצירה של Corpus.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

פלט בלבד. חותמת הזמן של מועד העדכון האחרון של Corpus.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}