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' לוגי.

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

רשימת אובייקטים של 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: 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 שבבעלות המשתמש.

נקודת קצה

get 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.

גוף הבקשה

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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה הוא אובייקט JSON ריק.

משאב REST: corpora.permissions

משאב: הרשאה

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

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

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

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

פלט בלבד. מזהה. שם ההרשאה. שם ייחודי ייווצר בזמן היצירה. דוגמאות: tunedModels/{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 Union type
סוג הערך חייב להיות תואם לסוג הערך שמוגדר בשדה של המפתח התואם. אם סוגי הערכים לא עקביים, התוצאה תהיה קבוצה ריקה. כשהערך של CustomMetadata הוא מסוג StringList, צריך להשתמש ב-string_value בשילוב עם פעולת INCLUDES/EXCLUDES בתנאי הסינון, אחרת התוצאה תהיה גם קבוצה ריקה. הערך של value יכול להיות רק אחת מהאפשרויות הבאות:
stringValue string

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

numericValue number

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

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

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

מפעיל

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

טיפוסים בני מנייה (enum)
OPERATOR_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
LESS נתמך על ידי numeric.
LESS_EQUAL נתמך על ידי numeric.
EQUAL יש תמיכה במחרוזות ובמספרים.
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)
  }
}

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

שדות
name string

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

displayName string

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

createTime string (Timestamp format)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

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