REST Resource: documents

משאב: מסמך

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

ייצוג ב-JSON
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "title": string
}
שדות
name

string

מזהה. מכיל את שם המשאב של המסמך. פורמט: documents/{uri_without_scheme} דוגמה: documents/docs.cloud.google.com/storage/docs/creating-buckets

uri

string

פלט בלבד. התג הזה מספק את ה-URI של התוכן, למשל docs.cloud.google.com/storage/docs/creating-buckets.

content

string

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

description

string

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

title

string

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

Methods

batchGet

מאחזר מספר מסמכים, כל אחד עם תוכן Markdown מלא.

get

מאחזר מסמך יחיד עם תוכן Markdown מלא.

searchDocumentChunks

חיפוש ידע למפתחים במסמכי התיעוד למפתחים של Google.