REST Resource: settings.searchapplications

แหล่งข้อมูล: SearchApplication

SearchApplication

การแสดง JSON 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
ช่อง
name

string

ชื่อแอปพลิเคชันการค้นหา

รูปแบบ: searchapplications/{applicationId}
displayName

string

ชื่อที่แสดงของแอปพลิเคชันการค้นหา ความยาวสูงสุด 300 อักขระ
dataSourceRestrictions[]

object (DataSourceRestriction)

มีข้อจำกัดในการใช้การกำหนดค่า จำนวนองค์ประกอบสูงสุดคือ 10 รายการ
sourceConfig[]

object (SourceConfig)

การกําหนดค่าสําหรับแหล่งข้อมูลที่ระบุใน dataSourceRestrictions
scoringConfig

object (ScoringConfig)

การกําหนดค่าสําหรับการจัดอันดับผลการค้นหา
defaultSortOptions

object (SortOptions)

ตัวเลือกเริ่มต้นสำหรับการจัดเรียงผลการค้นหา
defaultFacetOptions[]

object (FacetOptions)

ช่องเริ่มต้นสำหรับการแสดงผลลัพธ์ของข้อมูลประกอบ แหล่งที่มาที่ระบุไว้ที่นี่จะรวมอยู่ใน dataSourceRestrictions ด้านบนด้วย
returnResultThumbnailUrls

boolean

ผลลัพธ์แต่ละรายการควรแสดง URI ของภาพปก (หากมี)
operationIds[]

string

เอาต์พุตเท่านั้น รหัสของการดำเนินการที่ใช้เวลานาน (LROs) ที่ทำงานอยู่สําหรับสคีมานี้ ช่องเอาต์พุตเท่านั้น
enableAuditLog

boolean

ระบุว่าการบันทึกการตรวจสอบเปิด/ปิดอยู่สำหรับคำขอที่ส่งสำหรับแอปพลิเคชันการค้นหาใน Query API หรือไม่
queryInterpretationConfig

object (QueryInterpretationConfig)

ตัวเลือกเริ่มต้นสำหรับการตีความคำค้นหา

DataSourceRestriction

ข้อจํากัดเกี่ยวกับแหล่งข้อมูล

การแสดง JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
ช่อง
source

object (Source)

แหล่งที่มาของการจํากัด
filterOptions[]

object (FilterOptions)

ตัวเลือกตัวกรองที่จำกัดผลลัพธ์ หากมีตัวกรองหลายรายการ ระบบจะจัดกลุ่มตัวกรองตามประเภทออบเจ็กต์ก่อนรวม ระบบจะรวมตัวกรองที่มีประเภทออบเจ็กต์เดียวกันเข้าด้วยกัน จากนั้นจะรวมนิพจน์ที่ได้แบบไม่รวม

จำนวนองค์ประกอบสูงสุดคือ 20 รายการ

หมายเหตุ: ขณะนี้ Suggest API รองรับตัวกรองเพียงไม่กี่รายการ ได้แก่ "objecttype", "type" และ "mimetype" ขณะนี้คุณใช้ตัวกรองเฉพาะสคีมาเพื่อกรองคำแนะนำไม่ได้

แหล่งที่มา

กําหนดแหล่งที่มาสําหรับ API การแนะนํา/การค้นหา

การแสดง JSON 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
ช่อง

ฟิลด์สหภาพ source

source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
name

string

ชื่อแหล่งที่มาของเนื้อหาที่จัดทําดัชนีโดย Indexing API
predefinedSource

enum (Source.PredefinedSource)

แหล่งที่มาของเนื้อหาที่กําหนดไว้ล่วงหน้าสําหรับแอป Google

Source.PredefinedSource

แหล่งที่มาที่กําหนดไว้ล่วงหน้า

Enum
NONE
QUERY_HISTORY แนะนำคำค้นหาที่ผู้ใช้เคยค้นหาในอดีต ใช้ได้เมื่อใช้กับ Suggest API เท่านั้น ระบบจะไม่สนใจเมื่อใช้ใน Query API
PERSON แนะนำบุคคลในองค์กร ใช้ได้เมื่อใช้กับ Suggest API เท่านั้น ทำให้เกิดข้อผิดพลาดเมื่อใช้ใน Query API
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

ตัวเลือกตัวกรองที่จะใช้กับข้อความค้นหา

การแสดง JSON 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
ช่อง
objectType

string

หากตั้งค่า objectType ระบบจะแสดงเฉพาะออบเจ็กต์ประเภทนั้น ซึ่งควรสอดคล้องกับชื่อออบเจ็กต์ที่ลงทะเบียนภายในคําจํากัดความของสคีมา ความยาวสูงสุดคือ 256 อักขระ
filter

object (Filter)

ตัวกรองทั่วไปเพื่อจํากัดการค้นหา เช่น lang:en, site:xyz

ตัวกรอง

วิธีทั่วไปในการแสดงตัวกรองในการค้นหา ซึ่งรองรับ 2 แนวทางดังนี้

1. การตั้งค่า ValueFilter ชื่อต้องตรงกับ operatorName ที่กําหนดไว้ในสคีมาสําหรับแหล่งข้อมูล

2. การตั้งค่า CompositeFilter ระบบจะประเมินตัวกรองโดยใช้โอเปอเรเตอร์เชิงตรรกะ โอเปอเรเตอร์ระดับบนสุดต้องเป็น AND หรือ NOT เท่านั้น AND จะปรากฏได้ในระดับบนสุดเท่านั้น OR จะปรากฏได้เฉพาะภายใต้ AND ระดับบนสุดเท่านั้น

การแสดง JSON 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
ช่อง

ฟิลด์สหภาพ filter

filter ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

การแสดง JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
ช่อง
operatorName

string

operatorName ที่ใช้กับคําค้นหา เช่น price_greater_than ตัวกรองนี้สามารถทํางานกับตัวกรองทั้ง 2 ประเภทที่กําหนดไว้ในสคีมาสําหรับแหล่งข้อมูลของคุณ ดังนี้

  1. operatorName ซึ่งการค้นหาจะกรองผลลัพธ์ตามพร็อพเพอร์ตี้ที่ตรงกับค่า

  2. greaterThanOperatorName หรือ lessThanOperatorName ในสคีมา คําค้นหาจะกรองผลลัพธ์สำหรับค่าพร็อพเพอร์ตี้ที่มากกว่าหรือน้อยกว่าค่าที่ระบุในคําค้นหา
value

object (Value)

ค่าที่จะเปรียบเทียบ

ค่า

คําจํากัดความของค่าเดี่ยวที่มีประเภททั่วไป

การแสดง JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
ช่อง
ฟิลด์สหภาพ value ค่าของพร็อพเพอร์ตี้ที่มีชื่อ value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

การประทับเวลาในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและทศนิยมสูงสุด 9 หลัก ตัวอย่างเช่น "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

การแสดง JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
ช่อง
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

โอเปอเรเตอร์ทางตรรกะของตัวกรองย่อย
subFilters[]

object (Filter)

ตัวกรองย่อย

Filter.CompositeFilter.LogicOperator

Enum
AND โอเปอเรเตอร์ทางตรรกะ ซึ่งใช้ได้กับตัวกรองย่อยเท่านั้น
OR
NOT NOT ใช้ได้กับตัวกรองย่อยรายการเดียวเท่านั้น

SourceConfig

การกําหนดค่าสําหรับแหล่งที่มาขณะประมวลผลคําขอ query.search หรือ query.suggest

การแสดง JSON 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
ช่อง
source

object (Source)

แหล่งที่มาที่จะใช้การกําหนดค่านี้
scoringConfig

object (SourceScoringConfig)

การกำหนดค่าการให้คะแนนสําหรับแหล่งที่มา
crowdingConfig

object (SourceCrowdingConfig)

การกําหนดค่าการแออัดสําหรับแหล่งที่มา

SourceScoringConfig

ตั้งค่าการกําหนดคะแนน ซึ่งช่วยให้แก้ไขการจัดอันดับของผลการค้นหาสําหรับแหล่งที่มาได้

การแสดง JSON 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
ช่อง
sourceImportance

enum (SourceScoringConfig.SourceImportance)

ความสำคัญของแหล่งที่มา

SourceScoringConfig.SourceImportance

ความสำคัญของแหล่งที่มาซึ่งสามารถใช้เพื่อระบุว่าควรให้แหล่งที่มาหนึ่งมีลำดับความสำคัญสูงกว่าในการจัดอันดับเมื่อเทียบกับแหล่งที่มาอื่นหรือไม่

Enum
DEFAULT
LOW
HIGH

SourceCrowdingConfig

กำหนดขีดจำกัดจำนวนผลลัพธ์ การเบียดกันคือสถานการณ์ที่ผลการค้นหาหลายรายการจากแหล่งที่มาหรือโฮสต์เดียวกัน "เบียด" ผลการค้นหาอื่นๆ ซึ่งทำให้คุณภาพการค้นหาสำหรับผู้ใช้ลดลง หากต้องการปรับปรุงคุณภาพการค้นหาและเพิ่มความหลากหลายของแหล่งที่มาในผลการค้นหา คุณสามารถตั้งค่าเงื่อนไขเพื่อลดผลการค้นหาที่ซ้ำกันตามแหล่งที่มา

การแสดง JSON 
{
  "numResults": integer,
  "numSuggestions": integer
}
ช่อง
numResults

integer

จํานวนผลการค้นหาสูงสุดที่อนุญาตจากแหล่งข้อมูลในหน้าผลการค้นหา ตราบใดที่ผลการค้นหาจากแหล่งข้อมูลอื่นๆ ยังไม่หมด ค่าที่ระบุต้องไม่เป็นค่าลบ ระบบจะใช้ค่าเริ่มต้นหากค่านี้เท่ากับ 0 หากต้องการปิดใช้ขีดจํากัดดังกล่าว ให้กําหนดค่าที่มากกว่า 100
numSuggestions

integer

จํานวนการแนะนำสูงสุดที่อนุญาตจากแหล่งที่มา ระบบจะไม่จำกัดผลลัพธ์หากค่านี้น้อยกว่าหรือเท่ากับ 0

ScoringConfig

การกําหนดค่าการให้คะแนนสําหรับแหล่งที่มาขณะประมวลผลคําขอ query.search หรือ query.suggest

การแสดง JSON 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
ช่อง
disableFreshness

boolean

การใช้ความใหม่เป็นสัญญาณการจัดอันดับ โดยค่าเริ่มต้น ระบบจะใช้ความใหม่เป็นสัญญาณการจัดอันดับ โปรดทราบว่าการตั้งค่านี้ไม่พร้อมใช้งานใน UI การดูแลระบบ
disablePersonalization

boolean

ตัวเลือกในการปรับเปลี่ยนผลการค้นหาในแบบของคุณ โดยค่าเริ่มต้น ระบบจะใช้สัญญาณส่วนบุคคลเพื่อเพิ่มประสิทธิภาพผลการค้นหา

SortOptions

การแสดง JSON 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
ช่อง
operatorName

string

ชื่อของโอเปอเรเตอร์ที่สอดคล้องกับช่องที่จะจัดเรียง พร็อพเพอร์ตี้ที่เกี่ยวข้องต้องได้รับการทําเครื่องหมายเป็น sortable
sortOrder

enum (SortOptions.SortOrder)

การจัดเรียงจากน้อยไปมากเป็นลําดับการจัดเรียงเริ่มต้น

SortOptions.SortOrder

Enum
ASCENDING
DESCENDING

FacetOptions

ระบุโอเปอเรเตอร์ที่จะแสดงผลลัพธ์ของข้อมูลประกอบ FacetResult จะมี 1 รายการสำหรับชุดค่าผสม sourceName/objectType/operatorName แต่ละชุด

การแสดง JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
ช่อง
sourceName

string

ชื่อแหล่งที่มาที่จะแสดงเป็นมิติข้อมูล รูปแบบ: datasources/{sourceId} หากเป็นค่าว่าง ระบบจะใช้แหล่งข้อมูลทั้งหมด
objectType

string

หากตั้งค่า objectType ระบบจะใช้เฉพาะออบเจ็กต์ประเภทนั้นๆ เพื่อคํานวณแง่มุม หากเป็นค่าว่าง ระบบจะใช้ออบเจ็กต์ทั้งหมดในการคำนวณแง่มุม
operatorName

string

ชื่อของโอเปอเรเตอร์ที่เลือกไว้สําหรับการแยกแง่มุม @ดู cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

จํานวนสูงสุดของที่เก็บข้อมูลแง่มุมที่ควรแสดงสําหรับแง่มุมนี้ ค่าเริ่มต้นคือ 10 ค่าสูงสุดคือ 100
integerFacetingOptions

object (IntegerFacetingOptions)

หากตั้งค่าไว้ จะอธิบายตัวเลือกการแยกแง่มุมของจำนวนเต็มสําหรับพร็อพเพอร์ตี้จำนวนเต็มที่ระบุ พร็อพเพอร์ตี้จำนวนเต็มที่เกี่ยวข้องในสคีมาควรมีเครื่องหมาย isFacetable จำนวนที่เก็บข้อมูลที่แสดงผลจะเป็นค่าต่ำสุดของค่านี้และ numFacetBuckets

IntegerFacetingOptions

ใช้เพื่อระบุตัวเลือกการแยกแง่มุมแบบจำนวนเต็ม

การแสดง JSON 
{
  "integerBuckets": [
    string
  ]
}
ช่อง
integerBuckets[]

string (Int64Value format)

กลุ่มสำหรับค่าจำนวนเต็มที่ระบุควรเรียงตามลําดับจากน้อยไปมากอย่างเคร่งครัด เช่น หากค่าที่ระบุคือ (1,5,10,100) ระบบจะสร้างกลุ่มแง่มุมต่อไปนี้ {<1, [1,5), [5-10), [10-100), >=100}

QueryInterpretationConfig

ตัวเลือกเริ่มต้นในการตีความการค้นหาของผู้ใช้

การแสดง JSON 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
ช่อง
forceVerbatimMode

boolean

เปิดใช้ Flag นี้เพื่อปิดการเพิ่มประสิทธิภาพภายในทั้งหมด เช่น การตีความคำค้นหาเป็นภาษาธรรมชาติ (NL) การแสดงผลการค้นหาเพิ่มเติม และการใช้คำพ้องความหมาย รวมถึงคำพ้องความหมายที่กำหนดเอง หากตั้งค่า Flag นี้เป็น "จริง" ตัวเลือกนี้จะมีความสำคัญเหนือกว่าตัวเลือกที่ตั้งไว้ที่ระดับการค้นหา สำหรับค่าเริ่มต้นของ False แฟล็กระดับการค้นหาจะตั้งค่าการตีความที่ถูกต้องสำหรับโหมดข้อความตรงทั้งหมด
forceDisableSupplementalResults

boolean

ตั้งค่า Flag นี้เพื่อปิดใช้การดึงข้อมูลผลการค้นหาเพิ่มเติม การตั้งค่า Flag ที่นี่จะไม่ดึงข้อมูลผลการค้นหาเพิ่มเติมสําหรับคําค้นหาที่เชื่อมโยงกับแอปพลิเคชันการค้นหาหนึ่งๆ หากตั้งค่า Flag นี้เป็น "จริง" ตัวเลือกนี้จะมีความสำคัญเหนือกว่าตัวเลือกที่ตั้งไว้ที่ระดับการค้นหา สำหรับค่าเริ่มต้นที่เป็น False แฟล็กระดับการค้นหาจะตั้งค่าการตีความที่ถูกต้องสำหรับผลการค้นหาเพิ่มเติม

เมธอด

create

 สร้างแอปพลิเคชันการค้นหา

delete

 ลบแอปพลิเคชันการค้นหา

get

 รับแอปพลิเคชันการค้นหาที่ระบุ

list

 แสดงรายการแอปพลิเคชันการค้นหาทั้งหมด

patch

 อัปเดตแอปพลิเคชันการค้นหา

reset

 รีเซ็ตแอปพลิเคชันการค้นหาเป็นการตั้งค่าเริ่มต้น

update

 อัปเดตแอปพลิเคชันการค้นหา