เมธอด: 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" เชิงตรรกะ
ตัวอย่างการค้นหาที่ระดับเอกสาร: (ปี >= 2020 หรือ ปี < 2010) และ (ประเภท = ละคร OR ประเภท = แอ็กชัน)
MetadataFilter
object list: metadataFilters = [ {key = "document.custom_metadata.year" เงื่อนไข = [{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 = "drama", operation = EQUAL}, {stringValue = "action", 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 ( |
เมธอด: corpora.list
แสดงรายการ Corpora
ทั้งหมดที่ผู้ใช้เป็นเจ้าของ
ปลายทาง
get
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 ( |
เมธอด: corpora.get
รับข้อมูลเกี่ยวกับ Corpus
ที่เฉพาะเจาะจง
ปลายทาง
ซื้อ
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}
พารามิเตอร์เส้นทาง
name
string
ต้องระบุ ชื่อ Corpus
ตัวอย่าง: corpora/my-corpus-123
อยู่ในรูปแบบ corpora/{corpora}
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Corpus
เมธอด: corpora.patch
อัปเดต Corpus
ปลายทาง
แพตช์
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 (เช่น โมเดลที่ปรับแต่ง ข้อมูล Corpus)
บทบาทคือชุดการดำเนินการที่ได้รับอนุญาตซึ่งช่วยให้ผู้ใช้ดำเนินการบางอย่างกับทรัพยากร PaLM API ได้ คุณต้องมอบหมายบทบาทเพื่อให้ผู้ใช้ กลุ่ม หรือบัญชีบริการพร้อมใช้งาน การกำหนดบทบาทเป็นการมอบสิทธิ์ที่มีอยู่ในบทบาทนั้น
บทบาทที่ทับซ้อนกันมี 3 บทบาท แต่ละบทบาทจะเป็นเซตที่รวมการดำเนินการที่ได้รับอนุญาตของบทบาทก่อนหน้า
- ผู้อ่านสามารถใช้ทรัพยากร (เช่น โมเดลที่ปรับแต่ง คอร์ปัส) สำหรับการอนุมาน
- ผู้เขียนมีสิทธิ์ของผู้อ่าน ทั้งยังแก้ไขและแชร์ได้
- เจ้าของมีสิทธิ์ของผู้เขียนและสามารถลบได้
name
string
เอาต์พุตเท่านั้น ตัวระบุ ชื่อสิทธิ์ ระบบจะสร้างชื่อที่ไม่ซ้ำกันขึ้นเมื่อสร้าง ตัวอย่าง: TunModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} เอาต์พุตเท่านั้น
granteeType
enum (GranteeType
)
ไม่บังคับ เปลี่ยนแปลงไม่ได้ ประเภทของผู้รับสิทธิ์
emailAddress
string
ไม่บังคับ เปลี่ยนแปลงไม่ได้ อีเมลของผู้ใช้ในกลุ่มที่สิทธิ์นี้อ้างถึง ระบบจะไม่ตั้งค่าช่องเมื่อประเภทผู้รับสิทธิ์ของสิทธิ์คือ "ทุกคน"
role
enum (Role
)
ต้องระบุ บทบาทที่ได้รับจากสิทธิ์นี้
การแสดง JSON |
---|
{ "name": string, "granteeType": enum ( |
GranteeType
กำหนดประเภทผู้รับสิทธิ์นี้
Enum | |
---|---|
GRANTEE_TYPE_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้งาน |
USER |
แสดงผู้ใช้ เมื่อตั้งค่าแล้ว คุณต้องระบุอีเมลสำหรับผู้ใช้ |
GROUP |
แสดงถึงกลุ่ม เมื่อตั้งค่าแล้ว คุณต้องระบุ emailAddress สำหรับกลุ่ม |
EVERYONE |
แสดงสิทธิ์เข้าถึงทุกคน โดยไม่จำเป็นต้องให้ข้อมูลเพิ่มเติม |
บทบาท
กำหนดบทบาทที่ได้รับจากสิทธิ์นี้
Enum | |
---|---|
ROLE_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้งาน |
OWNER |
เจ้าของจะใช้ อัปเดต แชร์ และลบทรัพยากรได้ |
WRITER |
ผู้เขียนเนื้อหาสามารถใช้ อัปเดต และแชร์ทรัพยากรได้ |
READER |
ผู้อ่านใช้ทรัพยากรได้ |
MetadataFilter
ผู้ใช้ระบุตัวกรองเพื่อจำกัดการดึงข้อมูลตามค่าข้อมูลเมตาระดับ Chunk
หรือ Document
ตัวอย่าง (genre = drama OR genre = action): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]
key
string
ต้องระบุ คีย์ของข้อมูลเมตาที่จะกรอง
conditions[]
object (Condition
)
ต้องระบุ Condition
สำหรับคีย์ที่ระบุซึ่งจะทริกเกอร์ตัวกรองนี้ Condition
หลายรายการจะผนวกกันด้วย OR เชิงตรรกะ
การแสดง JSON |
---|
{
"key": string,
"conditions": [
{
object ( |
เงื่อนไข
เงื่อนไขตัวกรองที่ใช้กับคีย์เดียว
operation
enum (Operator
)
ต้องระบุ โอเปอเรเตอร์ที่ใช้กับคู่คีย์-ค่าที่ระบุเพื่อทริกเกอร์เงื่อนไข
value
ประเภทค่าต้องสอดคล้องกับประเภทค่าที่กําหนดไว้ในช่องสําหรับคีย์ที่เกี่ยวข้อง หากประเภทค่าไม่สอดคล้องกัน ผลลัพธ์จะเป็นชุดว่างเปล่า เมื่อ CustomMetadata
มีประเภทค่าเป็น StringList
เงื่อนไขการกรองควรใช้ string_value
ร่วมกับการดำเนินการ INCLUDES/EXCLUDES มิฉะนั้นผลลัพธ์จะเป็นชุดว่าง value
ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
stringValue
string
ค่าสตริงเพื่อกรองข้อมูลเมตา
numericValue
number
ค่าตัวเลขที่ใช้กรองข้อมูลเมตา
การแสดง JSON |
---|
{ "operation": enum ( |
โอเปอเรเตอร์
กำหนดโอเปอเรเตอร์ที่ถูกต้องซึ่งสามารถใช้กับคู่คีย์-ค่า
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้ |
LESS |
รองรับเป็นตัวเลข |
LESS_EQUAL |
รองรับตัวเลข |
EQUAL |
รองรับโดยตัวเลขและ สตริง |
GREATER_EQUAL |
รองรับเป็นตัวเลข |
GREATER |
รองรับตัวเลข |
NOT_EQUAL |
รองรับโดยตัวเลขและ สตริง |
INCLUDES |
สตริงรองรับเฉพาะเมื่อประเภทค่า CustomMetadata ของคีย์ที่ระบุมี stringListValue |
EXCLUDES |
สตริงรองรับเฉพาะเมื่อประเภทค่า CustomMetadata ของคีย์ที่ระบุมี stringListValue |
ทรัพยากร REST: ภาษา
ทรัพยากร: Corpus
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 } |