Chunks

REST Kaynağı: Corpora.documents.chunks

Kaynak: Chunk

Chunk, vektör gösterimi ve depolama açısından bağımsız bir birim olarak değerlendirilen bir Document alt parçasıdır. Bir Corpus en fazla 1 milyon Chunk içerebilir.

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

Sabit. Tanımlayıcı. Chunk kaynağının adı. Kimlik ("Corpora/*/documents/*/chunks/" öneki hariç olmak üzere ad), en fazla 40 karakter içerebilir. Bu karakterler küçük harfli alfanümerik veya kısa çizgi (-) biçimlerinden oluşur. Kimlik, tireyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa 12 karakterlik rastgele bir benzersiz kimlik oluşturulur. Örnek: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Zorunlu. Chunk öğesinin içeriği (ör. metin dizesi). Parça başına maksimum jeton sayısı 2043'tür.

customMetadata[] object (CustomMetadata)

İsteğe bağlı. Kullanıcı tarafından sağlanan, anahtar/değer çiftleri olarak depolanan özel meta veriler. Yığın başına maksimum CustomMetadata sayısı 20'dir.

createTime string (Timestamp format)

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

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

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

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

state enum (State)

Yalnızca çıkış. Chunk cihazının mevcut durumu.

ChunkData

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

JSON gösterimi 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
Alanlar

Birleştirme alanı data.

data şunlardan yalnızca biri olabilir:

stringValue string

Dize olarak Chunk içeriği. Parça başına maksimum jeton sayısı 2043'tür.

Eyalet

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

Sıralamalar
STATE_UNSPECIFIED Varsayılan değerdir. Eyalet atlanırsa bu değer kullanılır.
STATE_PENDING_PROCESSING Chunk işleniyor (yerleştirme ve vektör depolama).
STATE_ACTIVE Chunk işlendi ve sorgulanabilir.
STATE_FAILED Chunk işlenemedi.

Yöntem: Corpora.documents.chunks.create

Chunk oluşturur.

Uç nokta

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

Yol parametreleri

parent string

Zorunlu. Bu Chunk öğesinin oluşturulacağı Document biriminin 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.

Yanıt gövdesi

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

Yöntem: Corpora.documents.chunks.list

Document içindeki tüm Chunk'leri listeler.

Uç nokta

indir 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.

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

pageToken string

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

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

Sayfalara ayırma işlemi sırasında chunks.list öğesine 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 yanıt, Chunk saniyelik sayfalara ayrılmış bir liste içeriyor. Chunk öğeleri artan chunk.create_time düzenine 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 öğeleri.

nextPageToken string

Sonraki sayfayı almak için pageToken olarak gönderilebilecek 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 ile ilgili bilgileri alır.

Uç nokta

indir 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ünceller.

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

Sabit. Tanımlayıcı. Chunk kaynağının adı. Kimlik ("Corpora/*/documents/*/chunks/" öneki hariç olmak üzere ad) en fazla 40 karakter içerebilir. Bu karakterler küçük harfli alfanümerik veya kısa çizgi (-) biçimlerinden oluşur. Kimlik, tireyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa 12 karakterlik 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 bu işlem yalnızca customMetadata ve data sürümlerinin güncellenmesini desteklemektedir.

Bu, tam nitelikli alan 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.

Yanıt gövdesi

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

Yöntem: Corpora.documents.chunks.delete

Chunk öğesini siler.

Uç nokta

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

Yol parametreleri

name string

Zorunlu. Silinecek Chunk öğesinin kaynak 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 gövdesi boş olur.

Yöntem: Corpora.documents.chunks.batchCreate

Toplu olarak Chunk oluşturun.

Uç nokta

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

Yol parametreleri

parent string

İsteğe bağlı. Bu Chunk grubunun oluşturulacağı Document öğesinin adı. Her CreateChunkRequest içindeki ü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 gövdesi, aşağıdaki yapıya sahip verileri içerir:

Alanlar
requests[] object (CreateChunkRequest)

Zorunlu. Oluşturulacak Chunk öğelerini belirten istek mesajları. Bir grupta en fazla 100 Chunk oluşturulabilir.

Yanıt gövdesi

Oluşturulan Chunk öğelerinin listesini içeren chunks.batchCreate 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 gönderin.

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

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

chunk object (Chunk)

Zorunlu. Oluşturulacak Chunk.

Yöntem: Corpora.documents.chunks.batchUpdate

Chunk öğelerini toplu güncelleme.

Uç nokta

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

Yol parametreleri

parent string

İsteğe bağlı. Güncellenecek Chunk öğelerini içeren Document öğesinin adı. Her UpdateChunkRequest içindeki ü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 gövdesi, aşağıdaki yapıya sahip verileri içerir:

Alanlar
requests[] object (UpdateChunkRequest)

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

Yanıt gövdesi

chunks.batchUpdate tarafından sağlanan, güncellenmiş Chunk öğelerinin listesini içeren 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 için güncelleme isteğinde bulunun.

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

Zorunlu. Güncellenecek Chunk.

updateMask string (FieldMask format)

Zorunlu. Güncellenecek alanların listesi. Şu anda bu işlem yalnızca customMetadata ve data sürümlerinin güncellenmesini desteklemektedir.

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

Yöntem: Corpora.documents.chunks.batchDelete

Chunk öğelerini toplu olarak silin.

Uç nokta

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

Yol parametreleri

parent string

İsteğe bağlı. Silinecek Chunk öğelerini içeren Document öğesinin adı. Her DeleteChunkRequest içindeki ü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 gövdesi, aşağıdaki yapıya sahip verileri içerir:

Alanlar
requests[] object (DeleteChunkRequest)

Zorunlu. Silinecek Chunk öğelerini belirten istek mesajları.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi boş olur.

DeleteChunkRequest

Chunk silme isteği

JSON gösterimi 
{
  "name": string
}
Alanlar
name string

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