Corpora

เมธอด: corpora.create

สร้าง Corpus ว่าง

ปลายทาง

โพสต์ https://generativelanguage.googleapis.com/v1beta/corpora

เนื้อหาของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ Corpus

ฟิลด์
name string

เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากร Corpus รหัส (ชื่อที่ไม่รวมคำนำหน้า "corpora/") ประกอบด้วยอักขระที่เป็นตัวอักษรและตัวเลขคละกันหรือขีดกลาง (-) ได้สูงสุด 40 ตัว โดยรหัสต้องไม่ขึ้นต้นหรือลงท้ายด้วยขีดกลาง หากชื่อว่างเปล่าเมื่อสร้าง ชื่อที่ไม่ซ้ำกันจะได้มาจาก displayName พร้อมด้วยคำต่อท้ายแบบสุ่ม 12 อักขระ ตัวอย่าง: corpora/my-awesome-corpora-123a456b789c

displayName string

ไม่บังคับ ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับ Corpus ชื่อที่แสดงต้องมีความยาวไม่เกิน 512 อักขระ ซึ่งรวมถึงการเว้นวรรค ตัวอย่าง: "เอกสารเกี่ยวกับ Semantic Retriever"

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Corpus ที่สร้างขึ้นใหม่

เมธอด: corpora.query

ทำการค้นหาเชิงความหมายใน Corpus

ปลายทาง

โพสต์ https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

พารามิเตอร์เส้นทาง

name string

ต้องระบุ ชื่อของ Corpus ที่จะค้นหา ตัวอย่างเช่น corpora/my-corpus-123 อยู่ในรูปแบบ corpora/{corpora}

เนื้อหาของคำขอ

เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

ฟิลด์
query string

ต้องระบุ สตริงการค้นหาเพื่อทำการค้นหาเชิงความหมาย

metadataFilters[] object (MetadataFilter)

ไม่บังคับ กรองข้อมูลเมตา Chunk และ Document ออบเจ็กต์ MetadataFilter แต่ละรายการควรสอดคล้องกับคีย์ที่ไม่ซ้ำกัน ออบเจ็กต์ MetadataFilter หลายรายการจะรวมกันด้วยตรรกะ "AND"

ตัวอย่างการค้นหาที่ระดับเอกสาร: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter object list: metadataFilters = [ {key = &quot;document.custom_metadata.year&quot; เงื่อนไข = [{int_value = 2020, การดำเนินการ = GREATER_EQUAL}, {int_value = 2010, การดำเนินการ = LESS}]}, {key = "document.custom_metadata.year" เงื่อนไข = [{int_value = 2020, การดำเนินการ = GREATER_EQUAL}, {int_value = 2010, การดำเนินการ = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, operation = EQUAL}]}]

ตัวอย่างการค้นหาที่ระดับกลุ่มสำหรับช่วงของค่าที่เป็นตัวเลข: (year > 2015 AND year <= 2020)

MetadataFilter รายการออบเจ็กต์: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

หมายเหตุ: "AND" สำหรับคีย์เดียวกันรองรับเฉพาะค่าตัวเลข ค่าสตริงรองรับเฉพาะ "OR" สำหรับคีย์เดียวกันเท่านั้น

resultsCount integer

ไม่บังคับ จำนวน Chunk สูงสุดที่จะแสดง บริการอาจแสดงผล Chunk น้อยลง

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

เนื้อหาการตอบกลับ

คำตอบจาก corpora.query ที่มีรายชื่อส่วนที่เกี่ยวข้อง

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

ช่อง
relevantChunks[] object (RelevantChunk)

ข้อมูลที่เกี่ยวข้อง

การแสดง JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

เมธอด: corpora.list

แสดงรายการ Corpora ทั้งหมดที่ผู้ใช้เป็นเจ้าของ

ปลายทาง

ซื้อ https://generativelanguage.googleapis.com/v1beta/corpora

พารามิเตอร์การค้นหา

pageSize integer

ไม่บังคับ จำนวนสูงสุด Corpora ที่จะแสดงผล (ต่อหน้า) บริการอาจแสดงผล Corpora น้อยลง

หากไม่ระบุ ระบบจะแสดงผล Corpora ไม่เกิน 10 รายการ ขนาดสูงสุดคือ 20 Corpora ต่อหน้า

pageToken string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการโทร corpora.list ก่อนหน้า

ระบุ nextPageToken ที่แสดงในการตอบกลับเป็นอาร์กิวเมนต์ในคําขอถัดไปเพื่อดึงข้อมูลหน้าถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ corpora.list ต้องตรงกับการเรียกใช้ที่ระบุโทเค็นของหน้าเว็บ

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

การตอบกลับจาก corpora.list ที่มีรายการ Corpora แบบแบ่งหน้า ผลลัพธ์จะจัดเรียงตาม corpus.create_time จากน้อยไปมาก

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

ฟิลด์
corpora[] object (Corpus)

คลังข้อมูลที่แสดงผล

nextPageToken string

โทเค็น ซึ่งสามารถส่งเป็น pageToken เพื่อเรียกข้อมูลหน้าถัดไป หากไม่ระบุฟิลด์นี้ ระบบจะไม่แสดงหน้าเว็บอีก

การแสดง JSON 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

เมธอด: corpora.get

รับข้อมูลเกี่ยวกับ Corpus ที่เฉพาะเจาะจง

ปลายทาง

ซื้อ https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

พารามิเตอร์เส้นทาง

name string

ต้องระบุ ชื่อของ Corpus ตัวอย่างเช่น corpora/my-corpus-123 อยู่ในรูปแบบ corpora/{corpora}

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Corpus

เมธอด: corpora.patch

อัปเดต Corpus

ปลายทาง

patch https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

พารามิเตอร์เส้นทาง

corpus.name string

เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากร Corpus รหัส (ชื่อที่ไม่รวมคำนำหน้า "corpora/") ประกอบด้วยอักขระที่เป็นตัวอักษรและตัวเลขคละกันหรือขีดกลาง (-) ได้สูงสุด 40 ตัว โดยรหัสต้องไม่ขึ้นต้นหรือลงท้ายด้วยขีดกลาง หากชื่อว่างเปล่าเมื่อสร้าง ชื่อที่ไม่ซ้ำกันจะได้มาจาก displayName พร้อมด้วยคำต่อท้ายแบบสุ่ม 12 อักขระ ตัวอย่างเช่น corpora/my-awesome-corpora-123a456b789c อยู่ในรูปแบบ corpora/{corpora}

พารามิเตอร์การค้นหา

updateMask string (FieldMask format)

ต้องระบุ รายการช่องที่จะอัปเดต ปัจจุบันฟีเจอร์นี้รองรับเฉพาะการอัปเดต displayName

ซึ่งเป็นรายการชื่อฟิลด์ที่สมบูรณ์ในตัวเองที่คั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

เนื้อหาของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ Corpus

ช่อง
displayName string

ไม่บังคับ ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับ Corpus ชื่อที่แสดงต้องมีความยาวไม่เกิน 512 อักขระ รวมเว้นวรรค ตัวอย่าง: "เอกสารเกี่ยวกับ Semantic Retriever"

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Corpus

เมธอด: corpora.delete

ลบ Corpus

ปลายทาง

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

พารามิเตอร์เส้นทาง

name string

ต้องระบุ ชื่อทรัพยากรของ Corpus ตัวอย่างเช่น corpora/my-corpus-123 อยู่ในรูปแบบ corpora/{corpora}

พารามิเตอร์การค้นหา

force boolean

ไม่บังคับ หากตั้งค่าเป็น "จริง" ระบบจะลบ Document และออบเจ็กต์ที่เกี่ยวข้องกับ Corpus นี้ด้วย

หากเป็นเท็จ (ค่าเริ่มต้น) ระบบจะแสดงข้อผิดพลาด FAILED_PRECONDITION หาก Corpus มี Document

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากสำเร็จ เนื้อหาการตอบกลับจะว่างเปล่า

ทรัพยากร REST: corpora.permissions

แหล่งข้อมูล: สิทธิ์

ทรัพยากรสิทธิ์จะให้สิทธิ์ผู้ใช้ กลุ่ม หรือผู้อื่นทั่วโลกในการเข้าถึงทรัพยากร PaLM API (เช่น โมเดลที่ปรับแต่ง คลังข้อมูล)

บทบาทคือชุดการดำเนินการที่ได้รับอนุญาตซึ่งช่วยให้ผู้ใช้ดำเนินการบางอย่างกับทรัพยากร PaLM API ได้ คุณต้องมอบหมายบทบาทเพื่อให้ผู้ใช้ กลุ่ม หรือบัญชีบริการพร้อมใช้งาน การกำหนดบทบาทเป็นการมอบสิทธิ์ที่มีอยู่ในบทบาทนั้น

บทบาทที่ทับซ้อนกันมี 3 บทบาท แต่ละบทบาทคือซูเปอร์เซ็ตของการดำเนินการที่ได้รับอนุญาตของบทบาทก่อนหน้า:

  • ผู้อ่านสามารถใช้ทรัพยากร (เช่น โมเดลที่ปรับแต่ง คอร์ปัส) สำหรับการอนุมาน
  • ผู้เขียนมีสิทธิ์ของผู้อ่านและแก้ไขและแชร์ได้
  • เจ้าของมีสิทธิ์ของผู้เขียนและสามารถลบได้
ฟิลด์
name string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อสิทธิ์ ระบบจะสร้างชื่อที่ไม่ซ้ำกันเมื่อสร้าง ตัวอย่าง: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} เอาต์พุตเท่านั้น

granteeType enum (GranteeType)

ไม่บังคับ เปลี่ยนแปลงไม่ได้ ประเภทของผู้รับอนุญาต

emailAddress string

ไม่บังคับ เปลี่ยนแปลงไม่ได้ อีเมลของผู้ใช้ในกลุ่มที่สิทธิ์นี้อ้างอิง ไม่มีการตั้งค่าช่องนี้เมื่อประเภทผู้รับของสิทธิ์คือ "ทุกคน"

role enum (Role)

ต้องระบุ บทบาทที่ได้รับสิทธิ์นี้

การแสดง JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

กำหนดประเภทผู้รับสิทธิ์นี้

Enum
GRANTEE_TYPE_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
USER แสดงผู้ใช้ เมื่อตั้งค่าแล้ว คุณต้องระบุ emailAddress สำหรับผู้ใช้
GROUP แสดงกลุ่ม เมื่อตั้งค่าแล้ว คุณต้องระบุ emailAddress สำหรับกลุ่ม
EVERYONE แสดงสิทธิ์เข้าถึงทุกคน โดยไม่จำเป็นต้องให้ข้อมูลเพิ่มเติม

บทบาท

กำหนดบทบาทที่ได้รับจากสิทธิ์นี้

Enum
ROLE_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้งาน
OWNER เจ้าของสามารถใช้ อัปเดต แชร์ และลบทรัพยากรได้
WRITER ผู้เขียนสามารถใช้ อัปเดต และแชร์ทรัพยากรได้
READER ผู้อ่านใช้ทรัพยากรได้

MetadataFilter

ตัวกรองที่ผู้ใช้ระบุเพื่อจํากัดการดึงข้อมูลตามค่าข้อมูลเมตาระดับ Chunk หรือ Document ตัวอย่าง (ประเภท = ดราม่าหรือ ประเภท = แอ็กชัน): key = "document.custom_metadata.genre" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, operation = EQUAL}]

ฟิลด์
key string

ต้องระบุ คีย์ของข้อมูลเมตาที่จะกรอง

conditions[] object (Condition)

ต้องระบุ Condition สำหรับคีย์ที่ระบุซึ่งจะทริกเกอร์ตัวกรองนี้ Condition หลายรายการจะผนวกกันด้วย OR เชิงตรรกะ

การแสดง JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

เงื่อนไข

เงื่อนไขตัวกรองที่ใช้กับคีย์เดียว

ช่อง
operation enum (Operator)

ต้องระบุ โอเปอเรเตอร์ที่ใช้กับคู่คีย์-ค่าที่ระบุเพื่อทริกเกอร์เงื่อนไข

ช่องการรวม value ประเภทค่าต้องสอดคล้องกับประเภทค่าที่กําหนดไว้ในช่องสําหรับคีย์ที่เกี่ยวข้อง หากประเภทค่าไม่สอดคล้องกัน ผลลัพธ์จะเป็นชุดว่าง เมื่อ CustomMetadata มีประเภทค่าเป็น StringList เงื่อนไขการกรองควรใช้ string_value ร่วมกับการดำเนินการ INCLUDES/EXCLUDES มิฉะนั้นผลลัพธ์จะเป็นชุดว่าง value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
stringValue string

ค่าสตริงเพื่อกรองข้อมูลเมตา

numericValue number

ค่าตัวเลขที่ใช้กรองข้อมูลเมตา

การแสดง JSON 
{
  "operation": enum (Operator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}

โอเปอเรเตอร์

กำหนดโอเปอเรเตอร์ที่ใช้ได้กับคู่คีย์-ค่า

Enum
OPERATOR_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้งาน
LESS รองรับเป็นตัวเลข
LESS_EQUAL รองรับตัวเลข
EQUAL รองรับโดยตัวเลขและ สตริง
GREATER_EQUAL รองรับตัวเลข
GREATER รองรับตัวเลข
NOT_EQUAL รองรับตัวเลขและสตริง
INCLUDES สตริงจะรองรับเมื่อประเภทค่า CustomMetadata ของคีย์ที่ระบุมี stringListValue เท่านั้น
EXCLUDES สตริงรองรับเฉพาะเมื่อประเภทค่า CustomMetadata ของคีย์ที่ระบุมี stringListValue

RelevantChunk

ข้อมูลของข้อมูลที่เกี่ยวข้องกับคำค้นหา

ช่อง
chunkRelevanceScore number

Chunk ความเกี่ยวข้องกับคำค้นหา

chunk object (Chunk)

Chunk ที่เชื่อมโยงกับคำค้นหา

การแสดง JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

ทรัพยากร REST: ภาษา

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

Corpus คือคอลเล็กชันของ Document โปรเจ็กต์สร้างคลังข้อมูลได้สูงสุด 5 รายการ

ช่อง
name string

เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากร Corpus รหัส (ชื่อที่ไม่รวมคำนำหน้า "corpora/") มีอักขระได้สูงสุด 40 ตัว ซึ่งเป็นอักขระที่เป็นตัวอักษรพิมพ์เล็กและตัวเลขคละกันหรือขีดกลาง (-) รหัสต้องไม่ขึ้นต้นหรือลงท้ายด้วยขีดกลาง หากชื่อว่างเปล่าเมื่อสร้าง ระบบจะสร้างชื่อที่ไม่ซ้ำกันจาก displayName พร้อมกับคำต่อแบบสุ่ม 12 อักขระ ตัวอย่าง: corpora/my-awesome-corpora-123a456b789c

displayName string

ไม่บังคับ ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับ Corpus ชื่อที่แสดงต้องมีความยาวไม่เกิน 512 อักขระ ซึ่งรวมถึงการเว้นวรรค ตัวอย่าง: "เอกสารเกี่ยวกับ Semantic Retriever"

createTime string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่สร้าง Corpus

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

updateTime string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่อัปเดต Corpus ครั้งล่าสุด

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

การแสดง JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}