Method: documents.searchDocumentChunks

جستجوی دانش توسعه‌دهنده در اسناد توسعه‌دهندگان گوگل. بر اساس جستجوی کاربر، DocumentChunk ها را برمی‌گرداند. ممکن است تکه‌های زیادی از یک Document وجود داشته باشد. برای بازیابی اسناد کامل، DeveloperKnowledge.GetDocument یا DeveloperKnowledge.BatchGetDocuments با DocumentChunk.parent در SearchDocumentChunksResponse.results برگردانده شده است، استفاده کنید.

درخواست HTTP

GET https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای پرس و جو

پارامترها
query

string

الزامی. رشته پرس‌وجوی خام ارائه شده توسط کاربر، مانند «چگونه یک مخزن ذخیره‌سازی ابری ایجاد کنیم؟» را ارائه می‌دهد.

pageSize

integer

اختیاری. حداکثر تعداد نتایجی که باید برگردانده شود را مشخص می‌کند. سرویس ممکن است کمتر از این مقدار را برگرداند.

اگر مشخص نشده باشد، حداکثر ۵ نتیجه برگردانده خواهد شد.

حداکثر مقدار ۲۰ است؛ مقادیر بالاتر از ۲۰ منجر به خطای INVALID_ARGUMENT می‌شوند.

pageToken

string

اختیاری. شامل یک نشانه صفحه است که از فراخوانی قبلی documents.searchDocumentChunks دریافت شده است. برای بازیابی صفحه بعدی، این را ارائه دهید.

filter

string

اختیاری. یک فیلتر سختگیرانه بر روی نتایج جستجو اعمال می‌کند. این عبارت از زیرمجموعه‌ای از سینتکس شرح داده شده در https://google.aip.dev/160 پشتیبانی می‌کند.

در حالی که documents.searchDocumentChunks مقدار DocumentChunk برمی‌گرداند، فیلتر روی فیلدهای DocumentChunk.document اعمال می‌شود.

فیلدهای پشتیبانی شده برای فیلتر کردن:

  • dataSource (STRING): منبع سند، مثلاً docs.cloud.google.com . برای فهرست کامل منابع داده در مجموعه داده، به https://developers.google.com/knowledge/reference/corpus-reference مراجعه کنید.
  • updateTime (TIMESTAMP): مهر زمانی آخرین به‌روزرسانی معنادار سند. به‌روزرسانی معنادار، به‌روزرسانی‌ای است که محتوای markdown یا فراداده سند را تغییر می‌دهد.
  • uri (رشته): آدرس اینترنتی سند، مثلاً https://docs.cloud.google.com/bigquery/docs/tables .

فیلدهای STRING از عملگرهای = (برابر) و != (نه برابر) برای تطبیق دقیق در کل رشته پشتیبانی می‌کنند. تطبیق جزئی، تطبیق پیشوندی و تطبیق عبارت منظم پشتیبانی نمی‌شوند.

فیلدهای TIMESTAMP از عملگرهای = ، < ، <= ، > و >= پشتیبانی می‌کنند. مهرهای زمانی باید در قالب RFC-3339 باشند، مثلاً "2025-01-01T00:00:00Z" .

شما می‌توانید عبارات را با استفاده از عملگرهای منطقی AND ، OR و NOT (یا - ) ترکیب کنید. OR اولویت بالاتری نسبت به AND دارد. برای گروه‌بندی اولویت‌دار صریح، از پرانتز استفاده کنید.

مثال‌ها:

  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

رشته filter نباید بیش از ۵۰۰ کاراکتر باشد؛ مقادیر بیش از ۵۰۰ کاراکتر منجر به خطای INVALID_ARGUMENT می‌شوند.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پیام پاسخ برای DeveloperKnowledge.SearchDocumentChunks .

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
فیلدها
results[]

object ( DocumentChunk )

شامل نتایج جستجو برای عبارت جستجو شده است. هر DocumentChunk در این لیست شامل یک قطعه از محتوای مرتبط با عبارت جستجو است. برای بازیابی محتوای کامل سند، از فیلد DocumentChunk.parent هر نتیجه به همراه DeveloperKnowledge.GetDocument یا DeveloperKnowledge.BatchGetDocuments استفاده کنید.

nextPageToken

string

اختیاری. یک توکن ارائه می‌دهد که می‌تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این فیلد حذف شود، صفحات بعدی وجود نخواهند داشت.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

سندچانک

یک DocumentChunk نشان‌دهنده‌ی بخشی از محتوا از یک Document در مجموعه‌ی DeveloperKnowledge است. برای دریافت کل محتوای سند، parent به DeveloperKnowledge.GetDocument یا DeveloperKnowledge.BatchGetDocuments ارسال کنید.

نمایش JSON 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
فیلدها
parent

string

فقط خروجی. شامل نام منبع سندی است که این قطعه از آن است. قالب: documents/{uri_without_scheme} مثال: documents/docs.cloud.google.com/storage/docs/creating-buckets

id

string

فقط خروجی. شناسه این قطعه را در سند مشخص می‌کند. شناسه قطعه در یک سند منحصر به فرد است، اما به صورت جهانی در بین اسناد منحصر به فرد نیست. شناسه قطعه پایدار نیست و ممکن است با گذشت زمان تغییر کند.

content

string

فقط خروجی. شامل محتوای بخش سند است.

document

object ( Document )

فقط خروجی. نشان‌دهنده‌ی فراداده‌های مربوط به Document است که این بخش از آن است. پیام DocumentView این Document روی DOCUMENT_VIEW_BASIC تنظیم خواهد شد. این پیام برای راحتی در اینجا گنجانده شده است تا کلاینت‌ها در صورتی که فقط به فیلدهای فراداده نیاز دارند، نیازی به فراخوانی DeveloperKnowledge.GetDocument یا DeveloperKnowledge.BatchGetDocuments نداشته باشند. در غیر این صورت، کلاینت‌ها باید DeveloperKnowledge.GetDocument یا DeveloperKnowledge.BatchGetDocuments برای دریافت محتوای کامل سند استفاده کنند.