SearchResult

מייצג את תוצאות החיפוש.

ייצוג ב-JSON 
{
  "id": string,
  "document": {
    object (Document)
  },
  "chunk": {
    object (Chunk)
  },
  "modelScores": {
    string: {
      object (DoubleList)
    },
    ...
  },
  "rankSignals": {
    object (RankSignals)
  }
}
שדות
id

string

Document.id מתוך Document שחיפשתם.
document

object (Document)

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

object (Chunk)

נתוני החלק בתגובה לחיפוש אם הערך של SearchRequest.ContentSearchSpec.search_result_mode הוא CHUNKS.
modelScores

map (key: string, value: object (DoubleList))

פלט בלבד. Google סיפקה ציונים זמינים.
rankSignals

object (RankSignals)

זה שינוי אופציונלי. קבוצה של אותות דירוג שמשויכים לתוצאה.

גושים

החלק הזה כולל את כל פרטי המטא-נתונים הגולמיים של הפריטים שיומלצו או ייכללו בחיפוש במצב החלק.

ייצוג ב-JSON 
{
  "name": string,
  "id": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "derivedStructData": {
    object
  },
  "pageSpan": {
    object (PageSpan)
  },
  "chunkMetadata": {
    object (ChunkMetadata)
  },
  "dataUrls": [
    string
  ],
  "annotationContents": [
    string
  ],
  "annotationMetadata": [
    {
      object (AnnotationMetadata)
    }
  ],
  "relevanceScore": number
}
שדות
name

string

השם המלא של המשאב של הנתח. פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}

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

string

מזהה ייחודי של החלק הנוכחי.
content

string

התוכן הוא מחרוזת ממסמך (תוכן שנותח).
documentMetadata

object (DocumentMetadata)

מטא-נתונים של המסמך מהחלק הנוכחי.
derivedStructData

object (Struct format)

פלט בלבד. השדה הזה הוא OUTPUT_ONLY. הוא מכיל נתונים נגזרים שלא מופיעים במסמך המקורי.
pageSpan

object (PageSpan)

טווח הדפים של החלק.
chunkMetadata

object (ChunkMetadata)

פלט בלבד. מטא-נתונים של הנתח הנוכחי.
dataUrls[]

string

פלט בלבד. כתובות URL של נתוני תמונות אם הצ'אנק הנוכחי מכיל תמונות. כתובות URL של נתונים מורכבות מארבעה חלקים: קידומת (data:‎), סוג MIME שמציין את סוג הנתונים, אסימון base64 אופציונלי אם הנתונים לא טקסטואליים, והנתונים עצמם: data:[][;base64],
annotationContents[]

string

פלט בלבד. תוכן ההערה אם החלק הנוכחי מכיל הערות.
annotationMetadata[]

object (AnnotationMetadata)

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

number

פלט בלבד. מייצג את ציון הרלוונטיות על סמך הדמיון. ציון גבוה יותר מצביע על רלוונטיות גבוהה יותר של המקטע. הציון הוא בטווח [‎-1.0, 1.0]. המאפיין הזה מאוכלס רק ב-SearchResponse.

DocumentMetadata

המטא-נתונים של המסמך מכילים את המידע של המסמך של החלק הנוכחי.

ייצוג ב-JSON 
{
  "uri": string,
  "title": string,
  "mimeType": string,
  "structData": {
    object
  }
}
שדות
uri

string

כתובת ה-URI של המסמך.
title

string

שם המסמך.
mimeType

string

סוג ה-MIME של המסמך. https://www.iana.org/assignments/media-types/media-types.xhtml.
structData

object (Struct format)

ייצוג נתונים. נתוני ה-JSON המובְנים של המסמך. הערך צריך להיות תואם לערך הרשום Schema, אחרת מוצגת שגיאת INVALID_ARGUMENT.

PageSpan

טווח הדפים של החלק.

ייצוג ב-JSON 
{
  "pageStart": integer,
  "pageEnd": integer
}
שדות
pageStart

integer

דף ההתחלה של החלק.
pageEnd

integer

דף הסיום של קבוצת הנתונים.

ChunkMetadata

מטא-נתונים של הנתח הנוכחי. השדה הזה מאוכלס רק ב-SearchService.Search API.

ייצוג ב-JSON 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
שדות
previousChunks[]

object (Chunk)

החלקים הקודמים של החלק הנוכחי. המספר נשלט על ידי SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. השדה הזה מאוכלס רק ב-SearchService.Search API.
nextChunks[]

object (Chunk)

החלקים הבאים של החלק הנוכחי. המספר נשלט על ידי SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. השדה הזה מאוכלס רק ב-SearchService.Search API.

AnnotationMetadata

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

ייצוג ב-JSON 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
שדות
structuredContent

object (StructuredContent)

פלט בלבד. פרטי התוכן המובנה.
imageId

string

פלט בלבד. מזהה התמונה מסופק אם התוכן המובנה מבוסס על תמונה.

StructuredContent

פרטי התוכן המובנה.

ייצוג ב-JSON 
{
  "structureType": enum (StructureType),
  "content": string
}
שדות
structureType

enum (StructureType)

פלט בלבד. סוג המבנה של התוכן המובנה.
content

string

פלט בלבד. התוכן של התוכן המובנה.

StructureType

הגדרת סוגי התוכן המובנה שאפשר לחלץ.

טיפוסים בני מנייה (enum)
STRUCTURE_TYPE_UNSPECIFIED ערך ברירת המחדל.
SHAREHOLDER_STRUCTURE מבנה בעלי המניות.
SIGNATURE_STRUCTURE מבנה החתימה.
CHECKBOX_STRUCTURE מבנה תיבת הסימון.

DoubleList

רשימה כפולה.

ייצוג ב-JSON 
{
  "values": [
    number
  ]
}
שדות
values[]

number

ערכים כפולים.

RankSignals

קבוצה של אותות דירוג.

ייצוג ב-JSON 
{
  "defaultRank": number,
  "customSignals": [
    {
      object (CustomSignal)
    }
  ],
  "keywordSimilarityScore": number,
  "relevanceScore": number,
  "semanticSimilarityScore": number,
  "pctrRank": number,
  "topicalityRank": number,
  "documentAge": number,
  "boostingFactor": number
}
שדות
defaultRank

number

זה שינוי אופציונלי. הדירוג שמוגדר כברירת מחדל לתוצאה.
customSignals[]

object (CustomSignal)

זה שינוי אופציונלי. רשימה של אותות clearbox בהתאמה אישית.
keywordSimilarityScore

number

זה שינוי אופציונלי. התאמה למילות מפתח.
relevanceScore

number

זה שינוי אופציונלי. התאמה של הרלוונטיות הסמנטית.
semanticSimilarityScore

number

זה שינוי אופציונלי. התאמה של דמיון סמנטי.
pctrRank

number

זה שינוי אופציונלי. התאמה של שיעור ההמרה הצפוי כמדד.
topicalityRank

number

זה שינוי אופציונלי. התאמה לפי נושא כדרגה.
documentAge

number

זה שינוי אופציונלי. גיל המסמך בשעות.
boostingFactor

number

זה שינוי אופציונלי. שילוב של הגברות מותאמות אישית למסמך.

CustomSignal

אות clearbox מותאם אישית שמיוצג על ידי צמד שם/ערך.

ייצוג ב-JSON 
{
  "name": string,
  "value": number
}
שדות
name

string

אופציונלי. שם האות.
value

number

זה שינוי אופציונלי. ערך מסוג float שמייצג את אות הסיווג (למשל 1.25 עבור BM25).