Chunks

Yöntem: corpora.documents.chunks.create

Bir Chunk oluşturur.

Uç nokta

yayın https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

Yol parametreleri

parent string

Zorunlu. Bu Chunk'un oluşturulacağı Document'nin adı. Örnek: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} biçimindedir.

İstek içeriği

İstek metni, Chunk öğesinin bir örneğini içerir.

Alanlar
name string

Değişmez. Tanımlayıcı. Chunk kaynak adı. Kimlik ("corpora/*/documents/*/chunks/" ön ekinden hariç tutulan ad), küçük harf alfanümerik karakterler veya kısa çizgiler (-) olmak üzere en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boş bırakılırsa 12 karakterli rastgele bir benzersiz kimlik oluşturulur. Örnek: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Zorunlu. Chunk için içerik (ör. metin dizesi). Her bir parça için maksimum jeton sayısı 2043'tür.

customMetadata[] object (CustomMetadata)

İsteğe bağlı. Anahtar/değer çiftleri olarak depolanan, kullanıcı tarafından sağlanan özel meta veriler. Her bir parça için maksimum CustomMetadata sayısı 20'dir.

Yanıt gövdesi

Başarılı olursa yanıt metni, yeni oluşturulmuş bir Chunk örneği içerir.

Yöntem: corpora.documents.chunks.list

Bir Document içindeki tüm Chunk öğelerini listeler.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

Yol parametreleri

parent string

Zorunlu. Chunk içeren Document öğesinin adı. Örnek: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} biçimindedir.

Sorgu parametreleri

pageSize integer

İsteğe bağlı. Döndürülecek maksimum Chunk sayısı (sayfa başına). Hizmet daha az Chunk döndürebilir.

Belirtilmemişse en fazla 10 Chunk döndürülür. Maksimum boyut sınırı sayfa başına 100 Chunk'tir.

pageToken string

İsteğe bağlı. Önceki bir chunks.list çağrısından alınan sayfa jetonu.

Sonraki sayfayı almak için yanıtta döndürülen nextPageToken değerini bir sonraki isteğinin bağımsız değişkeni olarak sağlayın.

Sayfalandırma yapılırken chunks.list parametresine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

chunks.list tarafından gönderilen ve sayfalandırılmış bir Chunk listesi içeren yanıt. Chunk değerleri artan chunk.create_time değerine göre sıralanır.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
chunks[] object (Chunk)

Döndürülen Chunk değerleri.

nextPageToken string

Sonraki sayfayı almak için pageToken olarak gönderilebilen bir jeton. Bu alan atlanırsa başka sayfa yoktur.

JSON gösterimi 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

Yöntem: corpora.documents.chunks.get

Belirli bir Chunk hakkında bilgi alır.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

Yol parametreleri

name string

Zorunlu. Alınacak Chunk öğesinin adı. Örnek: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk corpora/{corpora}/documents/{document}/chunks/{chunk} biçimindedir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, Chunk öğesinin bir örneğini içerir.

Yöntem: corpora.documents.chunks.patch

Chunk güncellemesi

Uç nokta

yama https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

Yol parametreleri

chunk.name string

Değişmez. Tanımlayıcı. Chunk kaynak adı. Kimlik ("corpora/*/documents/*/chunks/" ön ekinden hariç tutulan ad), küçük harf alfanümerik karakterler veya kısa çizgiler (-) olmak üzere en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boş bırakılırsa 12 karakterli rastgele bir benzersiz kimlik oluşturulur. Örnek: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c corpora/{corpora}/documents/{document}/chunks/{chunk} biçimindedir.

Sorgu parametreleri

updateMask string (FieldMask format)

Zorunlu. Güncellenecek alanların listesi. Şu anda yalnızca customMetadata ve data değerlerinin güncellenmesi desteklenmektedir.

Bu, alanların tam nitelikli adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

İstek içeriği

İstek metni, Chunk öğesinin bir örneğini içerir.

Alanlar
data object (ChunkData)

Zorunlu. Chunk için içerik (ör. metin dizesi). Her bir parça için maksimum jeton sayısı 2043'tür.

customMetadata[] object (CustomMetadata)

İsteğe bağlı. Anahtar/değer çiftleri olarak depolanan, kullanıcı tarafından sağlanan özel meta veriler. Her bir parça için maksimum CustomMetadata sayısı 20'dir.

Yanıt gövdesi

Başarılıysa yanıt metni, Chunk öğesinin bir örneğini içerir.

Yöntem: corpora.documents.chunks.delete

Bir Chunk'yi siler.

Uç nokta

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

Yol parametreleri

name string

Zorunlu. Silinecek Chunk kaynağının adı. Örnek: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk corpora/{corpora}/documents/{document}/chunks/{chunk} biçimindedir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni boş bir JSON nesnesi olur.

Yöntem: corpora.documents.chunks.batchCreate

Chunk'leri toplu olarak oluşturun.

Uç nokta

yayın https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate

Yol parametreleri

parent string

İsteğe bağlı. Bu Chunk grubunu oluşturacağınız Document'nin adı. Her CreateChunkRequest öğesindeki üst alan bu değerle eşleşmelidir. Örnek: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} biçimindedir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
requests[] object (CreateChunkRequest)

Zorunlu. Oluşturulacak Chunk'leri belirten istek mesajları. Bir toplu işlemde en fazla 100 Chunk oluşturulabilir.

Yanıt gövdesi

Oluşturulan Chunk'ların listesini içeren chunks.batchCreate'ten gelen yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
chunks[] object (Chunk)

Chunk oluşturuldu.

JSON gösterimi 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

Chunk oluşturma isteği.

Alanlar
parent string

Zorunlu. Bu Chunk'un oluşturulacağı Document'nin adı. Örnek: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

Zorunlu. Oluşturulacak Chunk.

JSON gösterimi 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}

Yöntem: corpora.documents.chunks.batchUpdate

Chunk'leri toplu olarak güncelleyin.

Uç nokta

yayın https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate

Yol parametreleri

parent string

İsteğe bağlı. Güncellenecek Chunk'ları içeren Document'nin adı. Her UpdateChunkRequest'teki üst alan bu değerle eşleşmelidir. Örnek: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} biçimindedir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
requests[] object (UpdateChunkRequest)

Zorunlu. Güncellenecek Chunk'leri belirten istek mesajları. Bir toplu işlemde en fazla 100 Chunk güncellenebilir.

Yanıt gövdesi

Güncellenen Chunk'ların listesini içeren chunks.batchUpdate'ten gelen yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
chunks[] object (Chunk)

Chunk güncellendi.

JSON gösterimi 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

Chunk güncelleme isteği.

Alanlar
chunk object (Chunk)

Zorunlu. Güncellenecek Chunk.

updateMask string (FieldMask format)

Zorunlu. Güncellenecek alanların listesi. Şu anda yalnızca customMetadata ve data değerlerinin güncellenmesi desteklenmektedir.

Bu, alanların tam nitelikli adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

JSON gösterimi 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}

Yöntem: corpora.documents.chunks.batchDelete

Chunk'leri toplu olarak silme

Uç nokta

yayın https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete

Yol parametreleri

parent string

İsteğe bağlı. Silinecek Chunk'ları içeren Document öğesinin adı. Her DeleteChunkRequest'teki üst alan bu değerle eşleşmelidir. Örnek: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} biçimindedir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
requests[] object (DeleteChunkRequest)

Zorunlu. Silecek Chunk'leri belirten istek mesajları.

Yanıt gövdesi

Başarılı olursa yanıt metni boş bir JSON nesnesi olur.

DeleteChunkRequest

Chunk silme isteği

Alanlar
name string

Zorunlu. Silinecek Chunk kaynağının adı. Örnek: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk

JSON gösterimi 
{
  "name": string
}

REST Kaynağı: corpora.documents.chunks

Kaynak: Chunk

Chunk, vektör temsili ve depolama amacıyla bağımsız bir birim olarak ele alınan Document'un alt bölümüdür. Bir Corpus en fazla 1 milyon Chunk içerebilir.

Alanlar
name string

Değişmez. Tanımlayıcı. Chunk kaynak adı. Kimlik ("corpora/*/documents/*/chunks/" ön ekinden hariç tutulan ad), küçük harf alfanümerik karakterler veya kısa çizgiler (-) olmak üzere en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boş bırakılırsa 12 karakterli rastgele bir benzersiz kimlik oluşturulur. Örnek: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Zorunlu. Chunk için içerik (ör. metin dizesi). Her bir parça için maksimum jeton sayısı 2043'tür.

customMetadata[] object (CustomMetadata)

İsteğe bağlı. Anahtar/değer çiftleri olarak depolanan, kullanıcı tarafından sağlanan özel meta veriler. Her bir parça için maksimum CustomMetadata sayısı 20'dir.

createTime string (Timestamp format)

Yalnızca çıkış. Chunk öğesinin oluşturulduğu zaman damgası.

Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Yalnızca çıkış. Chunk öğesinin en son güncellendiği zaman damgası.

Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

state enum (State)

Yalnızca çıkış. Chunk'ün mevcut durumu.

JSON gösterimi 
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}

ChunkData

Chunk içeriğini temsil eden ayıklanmış veriler.

Alanlar
data Union type
data yalnızca aşağıdakilerden biri olabilir:
stringValue string

Chunk içeriği dize olarak. Her bir parça için maksimum jeton sayısı 2043'tür.

JSON gösterimi 
{

  // data
  "stringValue": string
  // Union type
}

Eyalet

Chunk yaşam döngüsü için durumlar.

Sıralamalar
STATE_UNSPECIFIED Varsayılan değer. Eyalet atlanmazsa bu değer kullanılır.
STATE_PENDING_PROCESSING Chunk işlenmektedir (yerleştirme ve vektör depolama).
STATE_ACTIVE Chunk işlenmiş ve sorgulanabilir durumdadır.
STATE_FAILED Chunk işleme başarısız oldu.