Corpora

เมธอด: corpora.create

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

ปลายทาง

post 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

ปลายทาง

post 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 รายการออบเจ็กต์: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = 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 (RelevantChunk)
    }
  ]
}

เมธอด: 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 (Corpus)
    }
  ],
  "nextPageToken": string
}

เมธอด: corpora.get

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

ปลายทาง

get 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

ปลายทาง

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

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

name string

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

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

force boolean

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

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

เนื้อความของคำขอ

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

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

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

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

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

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

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

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

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

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

granteeType enum (GranteeType)

ไม่บังคับ เปลี่ยนแปลงไม่ได้ ประเภทของผู้รับเงินช่วยเหลือ

emailAddress string

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

role enum (Role)

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

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

GranteeType

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

Enum
GRANTEE_TYPE_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
USER แสดงผู้ใช้ เมื่อตั้งค่าแล้ว คุณต้องระบุ emailAddress สำหรับผู้ใช้
GROUP แสดงถึงกลุ่ม เมื่อตั้งค่าแล้ว คุณต้องระบุอีเมลสำหรับกลุ่ม
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 (Condition)
    }
  ]
}

เงื่อนไข

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

ฟิลด์
operation enum (Operator)

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

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

ค่าสตริงที่จะกรองข้อมูลเมตา

numericValue number

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

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

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

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

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

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

RelevantChunk

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

ฟิลด์
chunkRelevanceScore number

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

chunk object (Chunk)

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

document object (Document)

Document ที่เชื่อมโยงกับก้อนข้อมูล

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

ทรัพยากร 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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็น Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่าง: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

updateTime string (Timestamp format)

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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็น Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่าง: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

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