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 
{

  // Union field metadata can be only one of the following:
  "googleDocsMetadata": {
    object (GoogleDocsSourceMetadata)
  },
  "youtubeMetadata": {
    object (YoutubeMetadata)
  },
  "agentspaceMetadata": {
    object (AgentspaceMetadata)
  }
  // End of list of possible types for union field metadata.
  "wordCount": integer,
  "tokenCount": integer,
  "sourceAddedTimestamp": string
}
שדות
שדה איחוד metadata. מטא-נתונים של המקור. הערך metadata יכול להיות רק אחד מהבאים:
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 
{

  // Union field error can be only one of the following:
  "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 list of possible types for union field error.
}
שדות
שדה איחוד error. השגיאה הספציפית. הערך error יכול להיות רק אחד מהבאים:
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 
{

  // Union field error can be only one of the following:
  "downloadPrevented": {
    object (DownloadPrevented)
  }
  // End of list of possible types for union field error.
}
שדות
שדה איחוד error. השגיאה הספציפית ל-Drive. הערך error יכול להיות רק אחד מהבאים:
downloadPrevented

object (DownloadPrevented)

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

DownloadPrevented

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

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

YoutubeError

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

ייצוג ב-JSON 
{

  // Union field error can be only one of the following:
  "videoDeleted": {
    object (VideoDeleted)
  }
  // End of list of possible types for union field error.
}
שדות
שדה איחוד error. השגיאה הספציפית ל-YouTube. הערך error יכול להיות רק אחד מהבאים:
videoDeleted

object (VideoDeleted)

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

VideoDeleted

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

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

AudioTranscriptionError

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

ייצוג ב-JSON 
{

  // Union field error can be only one of the following:
  "languageDetectionFailed": {
    object (LanguageDetectionFailed)
  },
  "noAudioDetected": {
    object (NoAudioDetected)
  }
  // End of list of possible types for union field error.
}
שדות
שדה איחוד error. השגיאה הספציפית בתמלול קובץ האודיו. הערך error יכול להיות רק אחד מהבאים:
languageDetectionFailed

object (LanguageDetectionFailed)

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

object (NoAudioDetected)

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

LanguageDetectionFailed

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

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

NoAudioDetected

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

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

SourceLimitExceeded

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

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

DomainBlocked

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

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

MimeTypeBlocked

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

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

PolicyCheckFailed

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

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

Methods

batchCreate

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

batchDelete

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

get

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