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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע חדש של 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' לוגית.

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

רשימת אובייקטים של MetadataFilter: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

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

MetadataFilter object list: metadataFilters = [ {key = &quot;chunk.custom_metadata.year&quot; תנאים = [{int_value = 2015, Action = GREATER}]}, {key = "chunk.custom_metadata.year" תנאים = [{int_value = 2020, Action = 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 תווים לכל היותר, כולל רווחים. דוגמה: "מסמכים בנושא אחזור סמנטי"

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של 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. דוגמה (genre = דרמה או genre = פעולה): key = "document.custom_metadata.genre" conditions = [{stringValue = "דרמה", operation = EQUAL}, {stringValue = "פעולה", operation = EQUAL}]

שדות
key string

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

conditions[] object (Condition)

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

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

תנאי

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

שדות
operation enum (Operator)

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

שדה איחוד value. סוג הערך חייב להיות תואם לסוג הערך שמוגדר בשדה של המפתח התואם. אם סוגי הערכים לא עקביים, התוצאה תהיה קבוצה ריקה. כשהערך של CustomMetadata הוא מסוג StringList, צריך להשתמש ב-string_value בשילוב עם פעולת INCLUDES/EXCLUDES בתנאי הסינון, אחרת התוצאה תהיה גם קבוצה ריקה. 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 נתמך באמצעות מספרים.
EQUAL יש תמיכה במספרים ובמחרוזות.
GREATER_EQUAL נתמך על ידי numeric.
GREATER נתמך באמצעות מספרים.
NOT_EQUAL יש תמיכה במספרים ובמחרוזות.
INCLUDES נתמכת במחרוזת רק כאשר סוג הערך של CustomMetadata למפתח הנתון מכיל stringListValue.
EXCLUDES נתמכת במחרוזת רק כאשר סוג הערך של CustomMetadata למפתח הנתון מכיל stringListValue.

RelevantChunk

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

שדות
chunkRelevanceScore number

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

chunk object (Chunk)

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

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

REST Resource: 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
}