Corpora

ทรัพยากร REST: corpora

ทรัพยากร: Corpus

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

การแสดง JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
ช่อง
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"

เมธอด: corpora.create

สร้าง Corpus ที่ว่างเปล่า

ปลายทาง

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

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

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

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

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

เมธอด: 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.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: ตัวกรองข้อมูลเมตา = [ {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" เงื่อนไข = [{stringValue = "ละคร", การดำเนินการ = EQUAL}, {stringValue = "การกระทำ", การดำเนินการ = EQUAL}]}]

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

รายการออบเจ็กต์ MetadataFilter: ตัวกรองข้อมูลเมตา = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; เงื่อนไข = [{int_value = 2020, การดำเนินการ = LESS_EQUAL}]}]

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

resultsCount integer

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

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

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

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

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

ช่อง
relevantChunks[] object (RelevantChunk)

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

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

เมธอด: 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

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

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

เมธอด: corpora.delete

ลบ Corpus

ปลายทาง

ลบ 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 บทบาท แต่ละบทบาทคือซูเปอร์เซ็ตของการดำเนินการที่ได้รับอนุญาตของบทบาทก่อนหน้า:

  • ผู้อ่านสามารถใช้ทรัพยากร (เช่น โมเดลที่ปรับแต่ง คอร์ปัส) สำหรับการอนุมาน
  • ผู้เขียนมีสิทธิ์ของผู้อ่าน ทั้งยังแก้ไขและแชร์ได้
  • เจ้าของมีสิทธิ์ของผู้เขียนและสามารถลบ
การแสดง JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
ช่อง
name string

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

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" เงื่อนไข = [{stringValue = "ละคร", การดำเนินการ = EQUAL}, {stringValue = "การกระทำ", การดำเนินการ = EQUAL}]

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

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

conditions[] object (Condition)

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

เงื่อนไข

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

การแสดง 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.
}
ช่อง
operation enum (Operator)

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

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

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

numericValue number

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

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

กำหนดโอเปอเรเตอร์ที่ถูกต้องซึ่งสามารถใช้กับคู่คีย์-ค่า

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

RelevantChunk

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

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

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

chunk object (Chunk)

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