REST Resource: projects.locations.notebooks.sources

משאב: מקור

מקור מייצג מקור תוכן יחיד.

ייצוג ב-JSON 
{
  "name": string,
  "title": string,
  "sourceId": {
    object (SourceId)
  },
  "metadata": {
    object (SourceMetadata)
  },
  "settings": {
    object (SourceSettings)
  }
}
שדות
name

string

מזהה. השם המלא של משאב המקור. פורמט: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{sourceId}

השדה הזה חייב להיות מחרוזת עם קידוד UTF-8, באורך של עד 1,024 תווים.
title

string

זה שינוי אופציונלי. שם המקור.
sourceId

object (SourceId)

זה שינוי אופציונלי. פלט בלבד. מזהה המקור, שהוא הפלח האחרון של שם המשאב של המקור.
metadata

object (SourceMetadata)

פלט בלבד. מטא-נתונים על המקור.
settings

object (SourceSettings)

פלט בלבד. הסטטוס של המקור וסיבות לכשלים.

SourceMetadata

מייצג את המטא-נתונים של מקור ואת המידע הנוסף.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "googleDocsMetadata": {
    object (GoogleDocsSourceMetadata)
  },
  "youtubeMetadata": {
    object (YoutubeMetadata)
  },
  "agentspaceMetadata": {
    object (AgentspaceMetadata)
  }
  // End of mutually exclusive fields.
  "wordCount": integer,
  "tokenCount": integer,
  "sourceAddedTimestamp": string
}
שדות
מטא-נתונים של המקור. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
googleDocsMetadata

object (GoogleDocsSourceMetadata)

מטא-נתונים של מקור מסמך Google Docs.
youtubeMetadata

object (YoutubeMetadata)

מטא-נתונים של מקור סרטון ב-YouTube.
agentspaceMetadata

object (AgentspaceMetadata)

מטא-נתונים של מקור ב-Agentspace.
סוף השדות הבלעדיים.
wordCount

integer

ספירת המילים במקור.
tokenCount

integer

מספר הטוקנים במקור.
sourceAddedTimestamp

string (Timestamp format)

חותמת הזמן שבה המקור נוסף.

הפורמט הוא 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".

GoogleDocsSourceMetadata

מטא-נתונים על מקור של מסמך Google Docs.

ייצוג ב-JSON 
{
  "documentId": string,
  "revisionId": string
}
שדות
documentId

string

פלט בלבד. מזהה המסמך של מסמך Google Docs.
revisionId

string

פלט בלבד. מזהה הגרסה של המסמך.

YoutubeMetadata

מטא-נתונים על מקור של סרטון ב-YouTube.

ייצוג ב-JSON 
{
  "videoId": string,
  "channelName": string
}
שדות
videoId

string

פלט בלבד. המזהה של הסרטון ב-YouTube.
channelName

string

פלט בלבד. שם הערוץ של סרטון ב-YouTube.

AgentspaceMetadata

מטא-נתונים על מקור של Agentspace.

ייצוג ב-JSON 
{
  "documentName": string,
  "documentTitle": string
}
שדות
documentName

string

פלט בלבד. השם המלא של המסמך ב-Agentspace.
documentTitle

string

פלט בלבד. שם המסמך.

SourceSettings

מאפשר הרחבה של הגדרות המקור ב-sources.batchCreate (לשעבר בקשת AddSource).

ייצוג ב-JSON 
{
  "status": enum (SourceStatus),
  "failureReason": {
    object (FailureReason)
  }
}
שדות
status

enum (SourceStatus)

הסטטוס של המקור.
failureReason

object (FailureReason)

סיבת הכשל, שמכילה פרטים על הסיבה לכך שהטמעה של מקור נכשלה.

SourceStatus

רשימת הסטטוסים האפשריים של מקור.

טיפוסים בני מנייה (enum)
SOURCE_STATUS_UNSPECIFIED הסטטוס לא צוין.
SOURCE_STATUS_PENDING המקור ממתין להוספה.
SOURCE_STATUS_COMPLETE הוספת המקור הושלמה בהצלחה.
SOURCE_STATUS_ERROR הוספת המקור נכשלה באופן סופי.
SOURCE_STATUS_PENDING_DELETION המקור בהמתנה למחיקה.
SOURCE_STATUS_TENTATIVE המשתמש מנסה להוסיף מקור, אבל עדיין לא העלינו אותו או בדקנו את המגבלות של המשתמש. לא נספר במכסת המקור של המשתמש.

FailureReason

סיבת הכשל, שמכילה פרטים על הסיבה לכך שהטמעה של מקור נכשלה.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "unknown": {
    object (Unknown)
  },
  "sourceTooLong": {
    object (SourceTooLong)
  },
  "ingestionError": {
    object (IngestionError)
  },
  "sourceEmpty": {
    object (SourceEmpty)
  },
  "uploadError": {
    object (UploadError)
  },
  "paywallError": {
    object (PaywallError)
  },
  "sourceUnreachable": {
    object (SourceUnreachable)
  },
  "googleDriveError": {
    object (GoogleDriveError)
  },
  "youtubeError": {
    object (YoutubeError)
  },
  "audioTranscriptionError": {
    object (AudioTranscriptionError)
  },
  "sourceLimitExceeded": {
    object (SourceLimitExceeded)
  },
  "domainBlocked": {
    object (DomainBlocked)
  },
  "mimeTypeBlocked": {
    object (MimeTypeBlocked)
  },
  "policyCheckFailed": {
    object (PolicyCheckFailed)
  }
  // End of mutually exclusive fields.
}
שדות
השגיאה הספציפית. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
unknown

object (Unknown)

מציין שהתרחשה שגיאה לא ידועה.
sourceTooLong

object (SourceTooLong)

מציין שמספר המילים במקור חרג מהמגבלה של המשתמש.
ingestionError

object (IngestionError)

מציין שהייתה שגיאה במהלך ההטמעה של המקור.
sourceEmpty

object (SourceEmpty)

מציין שהמקור ריק.
uploadError

object (UploadError)

מציין שהייתה שגיאה במהלך העלאת המקור.
paywallError

object (PaywallError)

מציין שהמקור נמצא מאחורי חומת תשלום ואי אפשר להוסיף אותו.
sourceUnreachable

object (SourceUnreachable)

מציין שאין גישה למקור.
googleDriveError

object (GoogleDriveError)

שגיאה ספציפית ל-Google Drive.
youtubeError

object (YoutubeError)

שגיאה ספציפית ל-YouTube.
audioTranscriptionError

object (AudioTranscriptionError)

שגיאה ספציפית בתמלול של קובץ אודיו.
sourceLimitExceeded

object (SourceLimitExceeded)

שגיאה אם המשתמש מנסה לעדכן מעבר למגבלות שלו.
domainBlocked

object (DomainBlocked)

שגיאה אם המשתמש מנסה להוסיף מקור מדומיין חסום.
mimeTypeBlocked

object (MimeTypeBlocked)

מציין שסוג ה-MIME של המקור חסום.
policyCheckFailed

object (PolicyCheckFailed)

מציין שבדיקת המדיניות נכשלה.
סוף השדות הבלעדיים.

לא ידוע

בסוג הזה אין שדות.

מציין שהתרחשה שגיאה לא ידועה.

SourceTooLong

מציין שמספר המילים במקור חרג מהמגבלה של המשתמש.

ייצוג ב-JSON 
{
  "wordCount": integer,
  "wordLimit": integer
}
שדות
wordCount

integer

מספר המילים במקור.
wordLimit

integer

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

IngestionError

בסוג הזה אין שדות.

מציין שהייתה שגיאה במהלך ההטמעה של המקור.

SourceEmpty

בסוג הזה אין שדות.

מציין שהמקור ריק.

UploadError

בסוג הזה אין שדות.

מציין שהייתה שגיאה במהלך העלאת המקור.

PaywallError

בסוג הזה אין שדות.

מציין שהמקור נמצא מאחורי חומת תשלום ואי אפשר להוסיף אותו.

SourceUnreachable

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

ייצוג ב-JSON 
{
  "errorDetails": enum (SourceUnreachableErrorReason)
}
שדות
errorDetails

enum (SourceUnreachableErrorReason)

תיאור הסיבה לכך שאי אפשר להגיע למקור.

SourceUnreachableErrorReason

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

טיפוסים בני מנייה (enum)
ERROR_REASON_UNSPECIFIED ברירת מחדל
ERROR_REASON_INVALID_URL כתובת ה-URL של המקור לא תקינה.
ERROR_REASON_NOT_ACCESSIBLE אין גישה לכתובת ה-URL של המקור.
ERROR_REASON_NOT_REACHABLE אין גישה לכתובת ה-URL של המקור.
ERROR_REASON_URL_NOT_FOUND כתובת ה-URL של המקור החזירה שגיאה מסוג 404.
ERROR_REASON_TRANSIENT_ERROR אי אפשר להגיע לכתובת ה-URL של המקור בגלל שגיאה זמנית ברשת או פסק זמן של המארח וכו'.
ERROR_REASON_FETCH_FAILED לא ניתן לאחזר את כתובת ה-URL של המקור בגלל שגיאה פנימית.
ERROR_REASON_NOT_SUPPORTED כתובת ה-URL עדיין לא נתמכת. דוגמאות: התוכן שאוחזר חורג מהגודל המקסימלי לאחזור על ידי הכלי לסריקת תוכן, סוג התוכן שאוחזר עדיין לא נתמך וכו'.

GoogleDriveError

שגיאה ספציפית ל-Google Drive.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "downloadPrevented": {
    object (DownloadPrevented)
  }
  // End of mutually exclusive fields.
}
שדות
השגיאה הספציפית ל-Drive. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
downloadPrevented

object (DownloadPrevented)

למשתמש לא הייתה אפשרות להוריד את הקובץ.
סוף השדות הבלעדיים.

DownloadPrevented

בסוג הזה אין שדות.

למשתמש לא הייתה אפשרות להוריד את הקובץ.

YoutubeError

שגיאה ספציפית ל-YouTube.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "videoDeleted": {
    object (VideoDeleted)
  }
  // End of mutually exclusive fields.
}
שדות
השגיאה הספציפית ל-YouTube. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
videoDeleted

object (VideoDeleted)

שגיאה שמציינת שהמקור הוסר כי הסרטון נמחק.
סוף השדות הבלעדיים.

VideoDeleted

בסוג הזה אין שדות.

שגיאה שמציינת שהמקור הוסר כי הסרטון נמחק.

AudioTranscriptionError

שגיאה ספציפית בתמלול של קובץ אודיו.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "languageDetectionFailed": {
    object (LanguageDetectionFailed)
  },
  "noAudioDetected": {
    object (NoAudioDetected)
  }
  // End of mutually exclusive fields.
}
שדות
השגיאה הספציפית בתמלול קובץ האודיו. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
languageDetectionFailed

object (LanguageDetectionFailed)

לא הייתה אפשרות לזהות את השפה של הקובץ (יכול להיות שאין בו דיבור).
noAudioDetected

object (NoAudioDetected)

לא זוהה אודיו בקובץ הקלט (יכול להיות שזה היה סרטון).
סוף השדות הבלעדיים.

LanguageDetectionFailed

בסוג הזה אין שדות.

לא הייתה אפשרות לזהות את השפה של הקובץ (יכול להיות שאין בו דיבור).

NoAudioDetected

בסוג הזה אין שדות.

לא זוהה אודיו בקובץ הקלט.

SourceLimitExceeded

בסוג הזה אין שדות.

מציין שלמשתמש אין מקום למקור הזה.

DomainBlocked

בסוג הזה אין שדות.

שגיאה שמציינת שהמקור הוסר כי הדומיין נחסם.

MimeTypeBlocked

בסוג הזה אין שדות.

מציין שסוג ה-MIME של המקור חסום.

PolicyCheckFailed

בסוג הזה אין שדות.

מציין שבדיקת המדיניות נכשלה.

Methods

batchCreate

 יצירת רשימה של Source.

batchDelete

 מחיקת כמה מקורות

get

 הפונקציה מחזירה Source.