Package google.cloud.notebooklm.v1alpha

אינדקס

AudioOverviewService

שירות לניהול סקירות קוליות.

CreateAudioOverview

rpc CreateAudioOverview(CreateAudioOverviewRequest) returns (CreateAudioOverviewResponse)

יצירת סקירה קולית חדשה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.audioOverviews.create

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
DeleteAudioOverview

rpc DeleteAudioOverview(DeleteAudioOverviewRequest) returns (Empty)

מחיקת סקירה קולית.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • discoveryengine.audioOverviews.delete

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

DiscoverSourcesService

שירות לניהול משימות אסינכרוניות של חיפוש מקורות ב-Notebook.

כל שיטה מפעילה משימת גילוי חדשה ברקע בתוך מחברת (שיטות מותאמות אישית שמבוססות על אוסף, כמו DiscoverSourcesFastResearch ו-DiscoverSourcesDeepResearch) או פועלת על משימה קיימת שמזוהה על ידי source_discovery_job_id. בשינויים הבאים נוספו שאר בני המשפחה: ListDiscoverSourcesJob,‏ CancelDiscoverSourcesJob ו-FinishDiscoverSourcesRun.

NotebookService

שירות לניהול מחברות.

BatchDeleteNotebooks

rpc BatchDeleteNotebooks(BatchDeleteNotebooksRequest) returns (Empty)

מחיקה של כמה מחברות בפעולה אחת.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.
CreateNotebook

rpc CreateNotebook(CreateNotebookRequest) returns (Notebook)

יצירת מחברת.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.notebooks.create

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
GetNotebook

rpc GetNotebook(GetNotebookRequest) returns (Notebook)

מקבל נוטבוק.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • discoveryengine.notebooks.get

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
ListRecentlyViewedNotebooks

rpc ListRecentlyViewedNotebooks(ListRecentlyViewedNotebooksRequest) returns (ListRecentlyViewedNotebooksResponse)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.notebooks.list

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
ShareNotebook

rpc ShareNotebook(ShareNotebookRequest) returns (ShareNotebookResponse)

שיתוף נוטבוק עם חשבונות אחרים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשות ההרשאות הבאות ב-IAM במשאב name:

  • discoveryengine.notebooks.getIamPolicy
  • discoveryengine.notebooks.setIamPolicy

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

SourceService

שירות לניהול מקורות.

BatchCreateSources

rpc BatchCreateSources(BatchCreateSourcesRequest) returns (BatchCreateSourcesResponse)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.sources.create

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
BatchDeleteSources

rpc BatchDeleteSources(BatchDeleteSourcesRequest) returns (Empty)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.sources.delete

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
GetSource

rpc GetSource(GetSourceRequest) returns (Source)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • discoveryengine.sources.get

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

AccountAndRole

פרטים על החשבון ועל התפקיד.

שדות
email

string

חובה. כתובת האימייל שמשויכת לחשבון.
role

ProjectRole

חובה. התפקיד בנוטבוק.

AgentspaceMetadata

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

שדות
document_name

string

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

string

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

AudioOverview

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

שדות
name

string

מזהה. השם המלא של המשאב של המחברת. פורמט: projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}

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

string

פלט בלבד. המזהה הייחודי של סקירת האודיו.
status

AudioOverviewStatus

הסטטוס של הסקירה הקולית.
generation_options

AudioOverviewGenerationOptions

האפשרויות ששימשו ליצירת הסקירה הקולית.
mime_type

MimeType

סוג ה-MIME של סקירת האודיו.
language_code

string

קוד השפה של הסקירה הקולית שנוצרה. צריך להשתמש בקוד שפה לפי תקן BCP 47 (למשל, en,‏ es,‏ hi וכו').

MimeType

סוגי ה-MIME שנתמכים בסקירות קוליות.

טיפוסים בני מנייה (enum)
MIME_TYPE_UNKNOWN סוג ה-MIME לא הוגדר.
MIME_TYPE_WAV סוג ה-MIME הוא audio/wav.
MIME_TYPE_MP4 סוג ה-MIME הוא audio/mp4.

AudioOverviewGenerationOptions

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

שדות
source_ids[]

SourceId

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

string

במה המנחים של התוכנית צריכים להתמקד.
language_code

string

השפה שבה נשלחה הבקשה ליצירת הסקירה הקולית.

AudioOverviewStatus

הסטטוס של הסקירה הקולית.

טיפוסים בני מנייה (enum)
AUDIO_OVERVIEW_STATUS_UNSPECIFIED הסטטוס לא הוגדר.
AUDIO_OVERVIEW_STATUS_NOT_STARTED יצירת הסקירה הקולית עדיין לא התחילה.
AUDIO_OVERVIEW_STATUS_IN_PROGRESS הסקירה הקולית נמצאת בתהליך יצירה.
AUDIO_OVERVIEW_STATUS_COMPLETE הסקירה הקולית נוצרה וזמינה.
AUDIO_OVERVIEW_STATUS_FAILED יצירת הסקירה הקולית נכשלה.

BatchCreateSourcesRequest

בקשה לשיטת SourceService.BatchCreateSources.

שדות
parent

string

חובה. משאב האב שבו ייצרו המקורות. פורמט: projects/{project}/locations/{location}/notebooks/{notebook}
user_contents[]

UserContent

חובה. קובצי ה-UserContent שרוצים להעלות.

BatchCreateSourcesResponse

תגובה לשיטה SourceService.BatchCreateSources.

שדות
sources[]

Source

בשנות ה-Source.

BatchDeleteNotebooksRequest

בקשה לשיטת NotebookService.BatchDeleteNotebooks.

שדות
parent

string

חובה. שם המשאב של ענף ההורה, למשל projects/{project}/locations/{location}.
names[]

string

חובה. שמות מלאים של משאבים של Notebook, כמו projects/{project}/locations/{location}/notebooks/{notebook_id}.

BatchDeleteSourcesRequest

בקשה לשיטת BatchDeleteSourcesRequest.

שדות
parent

string

חובה. משאב האב שממנו יימחקו המקורות. פורמט: projects/{project}/locations/{location}/notebooks/{notebook}
names[]

string

חובה. שמות המקורות שרוצים למחוק. פורמט: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

CmekConfig

הגדרת הצפנה בניהול הלקוח ב-Notebooks.

שדות
kms_key

string

חובה. שם משאב מפתח KMS שישמש להצפנת משאבים projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

CreateAudioOverviewRequest

בקשה לשיטת AudioOverviewService.CreateAudioOverview.

שדות
parent

string

חובה. משאב האב שבו ייצור ה-Notebook. פורמט: projects/{project}/locations/{location}/notebooks/{notebook}
generation_options

AudioOverviewGenerationOptions

אפשרויות ליצירת סקירה קולית.

CreateAudioOverviewResponse

תגובה לשיטה AudioOverviewService.CreateAudioOverview.

שדות
audio_overview

AudioOverview

הסקירה הקולית שנוצרה.

CreateNotebookRequest

בקשה לשיטת NotebookService.CreateNotebook.

שדות
parent

string

חובה. שם משאב ההורה, למשל projects/{project}/locations/{location}.
notebook

Notebook

חובה. הנוטבוק שרוצים ליצור.

DeleteAudioOverviewRequest

בקשה לשיטת AudioOverviewService.DeleteAudioOverview.

שדות
name

string

חובה. שם המשאב המלא של AudioOverview, למשל projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}.

FailureReason

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

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

Unknown

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

SourceTooLong

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

IngestionError

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

SourceEmpty

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

UploadError

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

PaywallError

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

SourceUnreachable

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

GoogleDriveError

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

YoutubeError

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

AudioTranscriptionError

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

SourceLimitExceeded

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

DomainBlocked

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

MimeTypeBlocked

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

PolicyCheckFailed

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

AudioTranscriptionError

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

שדות
שדה איחוד error. השגיאה הספציפית בתמלול של קובץ האודיו. הערך error יכול להיות רק אחד מהבאים:
language_detection_failed

LanguageDetectionFailed

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

NoAudioDetected

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

LanguageDetectionFailed

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

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

NoAudioDetected

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

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

DomainBlocked

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

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

GoogleDriveError

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

שדות
שדה איחוד error. השגיאה הספציפית ל-Drive. הערך error יכול להיות רק אחד מהבאים:
download_prevented

DownloadPrevented

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

DownloadPrevented

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

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

IngestionError

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

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

MimeTypeBlocked

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

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

PaywallError

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

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

PolicyCheckFailed

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

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

SourceEmpty

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

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

SourceLimitExceeded

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

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

SourceTooLong

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

שדות
word_count

int32

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

int32

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

SourceUnreachable

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

שדות
error_details

SourceUnreachableErrorReason

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

לא ידוע

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

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

UploadError

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

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

YoutubeError

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

שדות
שדה איחוד error. השגיאה הספציפית ל-YouTube. הערך error יכול להיות רק אחד מהבאים:
video_deleted

VideoDeleted

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

VideoDeleted

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

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

GetNotebookRequest

בקשה לשיטת NotebookService.GetNotebook.

שדות
name

string

חובה. שם המשאב המלא של Notebook, כמו projects/{project}/locations/{location}/notebooks/{notebook_id}.

GetSourceRequest

בקשה לשיטת SourceService.GetSource.

שדות
name

string

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

GoogleDocsSourceMetadata

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

שדות
document_id

string

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

string

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

ListRecentlyViewedNotebooksRequest

בקשה לשיטת NotebookService.ListRecentlyViewedNotebooks.

שדות
parent

string

חובה. שם המשאב של ענף ההורה, למשל projects/{project}/locations/{location}.
page_size

int32

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

string

זה שינוי אופציונלי. טוקן הדף. צריך להזין אותו כדי לאחזר את הדף הבא.

ListRecentlyViewedNotebooksResponse

תגובה לשיטה NotebookService.ListRecentlyViewedNotebooks.

שדות
notebooks[]

Notebook

רשימת הנוטבוקים שנצפו לאחרונה.
next_page_token

string

טוקן הדף. צריך להזין אותו כדי לאחזר את הדף הבא.

Notebook

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

שדות
name

string

מזהה. המזהה של המחברת. פורמט: projects/{project}/locations/{location}/notebooks/{notebook_id}

השדה הזה חייב להיות מחרוזת בקידוד UTF-8.
sources[]

Source

פלט בלבד. רשימת המקורות ב-Notebook. זהו שדה פלט בלבד.
cmek_config

CmekConfig

פלט בלבד. מידע שקשור ל-CMEK ב-Notebook.
title

string

זה שינוי אופציונלי. השם של ה-notebook.
notebook_id

string

פלט בלבד. מזהה המחברת, שהוא הפלח האחרון בשם המשאב של המחברת.
emoji

string

פלט בלבד. האמוג'י של הנוטבוק.
metadata

NotebookMetadata

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

NotebookMetadata

מטא-נתונים של מחברת.

שדות
is_shared

bool

הערך הוא True אם הפרויקט הזה משותף כרגע עם אנשים אחרים, אחרת הערך הוא False.
is_shareable

bool

הערך הוא True אם אפשר לשתף את הפרויקט.
last_viewed

Timestamp

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

Timestamp

השעה שבה הפרויקט הזה נוצר.

ProjectRole

התפקיד בפרויקט.

טיפוסים בני מנייה (enum)
PROJECT_ROLE_UNKNOWN תפקיד לא ידוע.
PROJECT_ROLE_OWNER המשתמש הוא הבעלים של הפרויקט.
PROJECT_ROLE_WRITER למשתמש יש הרשאות כתיבה בפרויקט.
PROJECT_ROLE_READER למשתמש יש הרשאות קריאה בפרויקט.
PROJECT_ROLE_NOT_SHARED למשתמש אין גישה לפרויקט.

ShareNotebookRequest

בקשה לשיטת NotebookService.ShareNotebook.

שדות
name

string

חובה. שם המשאב המלא של Notebook, כמו projects/{project}/locations/{location}/notebooks/{notebook_id}.
account_and_roles[]

AccountAndRole

חובה. רשימת החשבונות והתפקידים שאיתם רוצים לשתף את ה-notebook.
notify_via_email

bool

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

ShareNotebookResponse

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

תגובה לשיטה NotebookService.ShareNotebook.

מקור

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

שדות
name

string

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

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

string

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

SourceId

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

SourceMetadata

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

SourceSettings

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

SourceId

‫SourceId הוא הפלח האחרון בשם המשאב של המקור.

שדות
id

string

המזהה של המקור.

SourceMetadata

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

שדות
שדה איחוד metadata. מטא-נתונים של המקור. הערך metadata יכול להיות רק אחד מהבאים:
google_docs_metadata

GoogleDocsSourceMetadata

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

YoutubeMetadata

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

AgentspaceMetadata

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

int32

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

int32

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

Timestamp

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

SourceSettings

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

שדות
status

SourceStatus

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

FailureReason

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

SourceStatus

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

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

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 עדיין לא נתמכת. דוגמאות: התוכן שאוחזר חורג מהגודל המקסימלי של אחזור התוכן על ידי הכלי לסריקת אתרים, סוג התוכן שאוחזר עדיין לא נתמך וכו'.

UserContent

ההודעות 'תוכן' מתייחסות לנתונים שהמשתמש רוצה להעלות.

שדות
שדה איחוד content. תוכן המשתמש. הערך content יכול להיות רק אחד מהבאים:
google_drive_content

GoogleDriveContent

התוכן מ-Google Drive.
text_content

TextContent

תוכן הטקסט שהועלה כמקור.
web_content

WebContent

תוכן האינטרנט שהועלה כמקור.
video_content

VideoContent

תוכן הסרטון שהועלה כמקור.
agentspace_content

AgentspaceContent

תוכן מ-AgentSpace הועלה כמקור.

AgentspaceContent

תוכן מ-AgentSpace הועלה כמקור.

שדות
document_name

string

זה שינוי אופציונלי. השם המלא של המשאב של מסמך Agentspace. פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}
engine_name

string

זה שינוי אופציונלי. מנוע לאימות ההרשאה של המסמך. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
ideaforge_idea_name

string

זה שינוי אופציונלי. שם המשאב של מופע Idea Forge. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}

GoogleDriveContent

התוכן מ-Google Drive.

שדות
document_id

string

מזהה המסמך של המסמך שנבחר.
mime_type

string

סוג ה-MIME של המסמך שנבחר.

אפשר להשתמש בפרמטר הזה כדי להבדיל בין סוגי התוכן שנבחרו בבוחר של Drive. משתמשים ב-application/vnd.google-apps.document ל-Google Docs או ב-application/vnd.google-apps.presentation ל-Google Slides.
source_name

string

השם שיוצג למקור.

TextContent

תוכן הטקסט שהועלה כמקור.

שדות
source_name

string

השם המוצג של מקור הטקסט.
content

string

השם שיוצג למקור.

VideoContent

תוכן וידאו שהועלה כמקור.

שדות
שדה איחוד format. מציין את הפורמט של תוכן הווידאו. הערך format יכול להיות רק אחד מהבאים:
youtube_url

string

כתובת ה-URL של תוכן הווידאו ב-YouTube.

WebContent

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

שדות
url

string

אם מספקים כתובת URL, המערכת מאחזרת את דף האינטרנט בקצה העורפי.
source_name

string

השם שיוצג למקור.

YoutubeMetadata

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

שדות
video_id

string

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

string

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