Package google.developers.knowledge.v1alpha

אינדקס

DeveloperKnowledge

‫Developer Knowledge API מספק גישה פרוגרמטית לתיעוד הפומבי של Google למפתחים, ומאפשר לכם לשלב את בסיס הידע הזה באפליקציות ובזרימות העבודה שלכם.

ה-API נועד להיות המקור הקנוני לגישה לקריאת מכונה למסמכי התיעוד למפתחים של Google.

תרחיש שימוש אופייני הוא קודם להשתמש ב-DeveloperKnowledge.SearchDocumentChunks כדי למצוא כתובות URI רלוונטיות של דפים על סמך שאילתה, ואז להשתמש ב-DeveloperKnowledge.GetDocument או ב-DeveloperKnowledge.BatchGetDocuments כדי לאחזר את התוכן המלא של התוצאות המובילות.

כל תוכן המסמך מסופק בפורמט Markdown.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

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

rpc GetDocument(GetDocumentRequest) returns (Document)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

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

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

חיפוש ידע למפתחים במסמכי התיעוד למפתחים של Google. הפונקציה מחזירה DocumentChunks על סמך השאילתה של המשתמש. יכול להיות שיש הרבה נתונים מאותו Document. כדי לאחזר מסמכים מלאים, משתמשים בפונקציות DeveloperKnowledge.GetDocument או DeveloperKnowledge.BatchGetDocuments עם הערך DocumentChunk.parent שמוחזר ב-SearchDocumentChunksResponse.results.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

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

BatchGetDocumentsRequest

בקשה לשליחת הודעה אל DeveloperKnowledge.BatchGetDocuments.

שדות
names[]

string

חובה. מציינת את השמות של המסמכים שיש לאחזר. אפשר לאחזר עד 20 מסמכים באצווה. המסמכים מוחזרים באותו סדר שבו הם מופיעים בבקשה names.

פורמט: documents/{uri_without_scheme} דוגמה: documents/docs.cloud.google.com/storage/docs/creating-buckets

BatchGetDocumentsResponse

הודעת תגובה אל DeveloperKnowledge.BatchGetDocuments.

שדות
documents[]

Document

ההודעה מכילה את המסמכים המבוקשים.

מסמך

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

שדות
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

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

DocumentChunk

‫DocumentChunk מייצג חלק מהתוכן מתוך Document במאגר המידע DeveloperKnowledge. כדי לאחזר את כל תוכן המסמך, מעבירים את parent אל DeveloperKnowledge.GetDocument או אל DeveloperKnowledge.BatchGetDocuments.

שדות
parent

string

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

string

פלט בלבד. מציין את המזהה של החלק הזה במסמך. מזהה החלק ייחודי במסמך, אבל לא ייחודי באופן גלובלי בין מסמכים. מזהה החלק לא יציב ועשוי להשתנות עם הזמן.
content

string

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

GetDocumentRequest

בקשה לשליחת הודעה אל DeveloperKnowledge.GetDocument.

שדות
name

string

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

SearchDocumentChunksRequest

בקשה לשליחת הודעה אל DeveloperKnowledge.SearchDocumentChunks.

שדות
query

string

חובה. השדה הזה מכיל את מחרוזת השאילתה הגולמית שהמשתמש סיפק, למשל 'איך יוצרים קטגוריה של Cloud Storage?'.
page_size

int32

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

אם לא מציינים ערך, יוצגו לכל היותר 5 תוצאות.

הערך המקסימלי הוא 20. ערכים מעל 20 יגרמו לשגיאה INVALID_ARGUMENT.
page_token

string

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

SearchDocumentChunksResponse

הודעת תגובה אל DeveloperKnowledge.SearchDocumentChunks.

שדות
results[]

DocumentChunk

מכיל את תוצאות החיפוש של השאילתה שצוינה. כל DocumentChunk ברשימה הזו מכיל קטע תוכן שרלוונטי לשאילתת החיפוש. כדי לאחזר את התוכן המלא של המסמך, משתמשים בשדה DocumentChunk.parent של כל תוצאה עם DeveloperKnowledge.GetDocument או DeveloperKnowledge.BatchGetDocuments.
next_page_token

string

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