Corpora

שיטה: corpora.create

יוצרת Corpus ריקה.

נקודת קצה

post https://generativelanguage.googleapis.com/v1beta/corpora

גוף הבקשה

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

Fields
name string

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

displayName string

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

גוף התשובה

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

שיטה: corpora.query

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

נקודת קצה

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

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

name string

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

גוף הבקשה

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

Fields
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 object list: 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

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

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

גוף התשובה

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

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

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

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

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

נקודת קצה

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

Fields
displayName string

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

גוף התשובה

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

שיטה: corpora.delete

מחיקת Corpus.

נקודת קצה

delete 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

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

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 = drama OR genre = action): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Fields
key string

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

conditions[] object (Condition)

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

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

תנאי

תנאי סינון שחל על מקש יחיד.

Fields
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

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

Fields
chunkRelevanceScore number

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

chunk object (Chunk)

Chunk שמשויכים לשאילתה.

document object (Document)

‫Document שמשויך לחלק.

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

משאב REST: ‏ corpora

משאב: מאגר

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

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים מלבד 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 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים מלבד 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
}