Documents

Yöntem: corpora.documents.create

Boş bir Document oluşturur.

Uç nokta

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

Yol parametreleri

parent string

Zorunlu. Bu Document öğesinin oluşturulacağı Corpus öğesinin adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

İstek içeriği

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

Alanlar
name string

Değişmez. Tanımlayıcı. Document kaynak adı. Kimlik ("corpora/*/documents/" öneki hariç ad) küçük harfli alfanümerik karakterler veya kısa çizgiler (-) içeren en fazla 40 karakterden oluşabilir. Kimlik kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName öğesinden 12 karakterlik rastgele bir sonek eklenerek benzersiz bir ad türetilir. Örnek: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

İsteğe bağlı. Document için kullanıcılar tarafından okunabilir görünen ad. Görünen ad, boşluklar dahil olmak üzere 512 karakterden uzun olmamalıdır. Örnek: "Semantic Retriever Documentation" (Anlamsal Alıcı Dokümanları)

customMetadata[] object (CustomMetadata)

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

Yanıt gövdesi

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

Yöntem: corpora.documents.query

Document üzerinde semantik arama yapar.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

Yol parametreleri

name string

Zorunlu. Sorgulanacak Document öğesinin adı. Ö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
query string

Zorunlu. Semantik arama yapmak için kullanılan sorgu dizesi.

resultsCount integer

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

Belirtilmemişse en fazla 10 Chunk döndürülür. Belirtilen maksimum sonuç sayısı 100'dür.

metadataFilters[] object (MetadataFilter)

İsteğe bağlı. Chunk meta verileri için filtreleme yapın. Her MetadataFilter nesnesi benzersiz bir anahtara karşılık gelmelidir. Birden fazla MetadataFilter nesne, mantıksal "VE" ile birleştirilir.

Not: Document adı zaten belirtildiği için bu istekte Document düzeyinde filtreleme desteklenmez.

Örnek sorgu: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter nesne listesi: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

Sayısal değer aralığı için örnek sorgu: (year > 2015 AND year <= 2020)

MetadataFilter nesne listesi: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Not: Aynı anahtar için "VE" yalnızca sayısal değerlerde desteklenir. Dize değerleri yalnızca aynı anahtar için "VEYA"ları destekler.

Yanıt gövdesi

Alakalı parçaların listesini içeren documents.query yanıtı.

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

Alanlar
relevantChunks[] object (RelevantChunk)

Döndürülen ilgili parçalar.

JSON gösterimi 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Yöntem: corpora.documents.list

Bir Corpus içindeki tüm Document'ları listeler.

Uç nokta

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

Yol parametreleri

parent string

Zorunlu. Document içeren Corpus öğesinin adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

Sorgu parametreleri

pageSize integer

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

Belirtilmemişse en fazla 10 Document döndürülür. Maksimum boyut sınırı, sayfa başına 20 Document'dir.

pageToken string

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

Sonraki sayfayı almak için yanıtta döndürülen nextPageToken değerini sonraki isteğe bağımsız değişken olarak iletin.

Sayfalara ayırma işlemi yapılırken documents.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

documents.list öğesinden, Document öğelerinin sayfalandırılmış listesini içeren yanıt. Document, artan document.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
documents[] object (Document)

Döndürülen Document'ler.

nextPageToken string

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

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

Yöntem: corpora.documents.get

Belirli bir Document hakkında bilgi alır.

Uç nokta

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

Yol parametreleri

name string

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

İstek içeriği

İstek metni boş olmalıdır.

Yanıt metni

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

Yöntem: corpora.documents.patch

Document öğesini günceller.

Uç nokta

patch https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

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

Yol parametreleri

document.name string

Değişmez. Tanımlayıcı. Document kaynak adı. Kimlik ("corpora/*/documents/" öneki hariç ad) küçük harfli alfanümerik karakterler veya kısa çizgiler (-) içeren en fazla 40 karakterden oluşabilir. Kimlik kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName öğesinden 12 karakterlik rastgele bir sonek eklenerek benzersiz bir ad türetilir. Örnek: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c corpora/{corpora}/documents/{document} biçimindedir.

Sorgu parametreleri

updateMask string (FieldMask format)

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

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

İstek içeriği

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

Alanlar
displayName string

İsteğe bağlı. Document için kullanıcılar tarafından okunabilir görünen ad. Görünen ad, boşluklar dahil olmak üzere 512 karakterden uzun olmamalıdır. Örnek: "Semantic Retriever Documentation" (Anlamsal Alıcı Dokümanları)

customMetadata[] object (CustomMetadata)

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

Yanıt gövdesi

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

Yöntem: corpora.documents.delete

Document öğesini siler.

Uç nokta

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

Yol parametreleri

name string

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

Sorgu parametreleri

force boolean

İsteğe bağlı. Doğru olarak ayarlanırsa bu Document ile ilgili tüm Chunk'lar ve nesneler de silinir.

Yanlış (varsayılan) ise Document, Chunk içeriyorsa FAILED_PRECONDITION hatası döndürülür.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

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

REST Kaynağı: corpora.documents

Kaynak: Doküman

Document, Chunk koleksiyonudur. Bir Corpus en fazla 10.000 Document içerebilir.

Alanlar
name string

Değişmez. Tanımlayıcı. Document kaynak adı. Kimlik ("corpora/*/documents/" öneki hariç ad) küçük harfli alfanümerik karakterler veya kısa çizgiler (-) içeren en fazla 40 karakterden oluşabilir. Kimlik kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName öğesinden 12 karakterlik rastgele bir sonek eklenerek benzersiz bir ad türetilir. Örnek: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

İsteğe bağlı. Document için kullanıcılar tarafından okunabilir görünen ad. Görünen ad, boşluklar dahil olmak üzere 512 karakterden uzun olmamalıdır. Örnek: "Semantic Retriever Documentation" (Anlamsal Alıcı Dokümanları)

customMetadata[] object (CustomMetadata)

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

updateTime string (Timestamp format)

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

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

createTime string (Timestamp format)

Yalnızca çıkış. Document oluşturulduğu zamanın zaman damgası.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

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

CustomMetadata

Kullanıcı tarafından sağlanan ve anahtar/değer çiftleri olarak depolanan meta veriler.

Alanlar
key string

Zorunlu. Depolanacak meta verilerin anahtarı.

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

Depolanacak meta verilerin dize değeri.

stringListValue object (StringList)

Depolanacak meta verilerin StringList değeri.

numericValue number

Depolanacak meta verilerin sayısal değeri.

JSON gösterimi 
{
  "key": string,

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

StringList

Tek bir meta veri anahtarına atanan, kullanıcı tarafından sağlanan dize değerleri.

Alanlar
values[] string

Depolanacak meta verilerin dize değerleri.

JSON gösterimi 
{
  "values": [
    string
  ]
}