Corpora

REST Resource: corpora

משאב: Corpus

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

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
שדות
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.

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

שיטה: corpora.create

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

נקודת קצה

לשלוח https://generativelanguage.googleapis.com/v1beta/corpora

גוף הבקשה

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

גוף התשובה

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

שיטה: 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.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" תנאים = [{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" תנאים = [{stringValue = "drama", Action = EQUAL}, {stringValue = "action", action = EQUAL}]}]

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

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

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

resultsCount integer

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

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

גוף התשובה

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

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

שדות
relevantChunks[] object (RelevantChunk)

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

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

שיטה: corpora.get

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

נקודת קצה

הורדה 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.

גוף התשובה

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

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

  • יכול להשתמש במשאב (למשל, מודל מכוונן, קורפוס) לצורך הסקת מסקנות
  • לכותב יש הרשאות קורא וגם הוא יכול לערוך ולשתף
  • לבעלים יש הרשאות כתיבה וגם למחוק
ייצוג JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
שדות
name string

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

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" תנאים = [{stringValue = "drama", Action = EQUAL}, {stringValue = "action", Action = EQUAL}]

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

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

conditions[] object (Condition)

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

תנאי

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

ייצוג 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.
}
שדות
operation enum (Operator)

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

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

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

numericValue number

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

מפעיל

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

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

RelevantChunk

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

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

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

chunk object (Chunk)

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