REST Resource: corpora.documents

Kaynak: Doküman

Document, Chunk öğelerinden oluşan bir koleksiyondur. Bir Corpus en fazla 10.000 Document içerebilir.

JSON gösterimi
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Alanlar
name

string

Sabit. Tanımlayıcı. Document kaynağının adı. Kimlik ("corpora/*/documents/" öneki hariç), küçük harfli alfanümerik karakterler veya tireler (-) içeren en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma işleminde ad boş olursa displayName karakterinden 12 karakterlik rastgele bir son ek ile birlikte benzersiz bir ad türetilir. Örnek: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

İsteğe bağlı. Document öğesinin, kullanıcılar tarafından okunabilen görünen adı. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Semantic Retriever Belgeleri"

customMetadata[]

object (CustomMetadata)

İsteğe bağlı. Kullanıcı tarafından sağlanan ve sorgulama için kullanılan anahtar/değer çiftleri olarak depolanan özel meta veriler. Bir Document en fazla 20 CustomMetadata içerebilir.

updateTime

string (Timestamp format)

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

Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

createTime

string (Timestamp format)

Yalnızca çıkış. Document öğesinin oluşturulduğu zamanı gösteren zaman damgası.

Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

Yöntemler

create

Boş bir Document oluşturur.

delete

Bir Document dosyasını siler.

get

Belirli bir Document ile ilgili bilgileri alır.

list

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

patch

Document öğesini günceller.

query

Document üzerinden anlamsal arama gerçekleştirir.