Documents

Yöntem: corpora.documents.create

Boş bir Document oluşturur.

Uç nokta

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

Yol parametreleri

parent string

Zorunlu. Bu Document'un oluşturulacağı Corpus'nin 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ç) en fazla 40 karakter içerebilir. Bu karakterler, küçük harfli alfanümerik veya kısa çizgiler (-) şeklindedir. Kimlik, tireyle başlayamaz veya bitemez. Oluşturma sırasında ad boş olursa 12 karakterlik rastgele bir son ek ile birlikte displayName öğesinden 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ın okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Semantic Retriever Documentation"

customMetadata[] object (CustomMetadata)

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

Yanıt gövdesi

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

Yöntem: corpora.documents.query

Document üzerinde anlamsal arama yapar.

Uç nokta

yayınlayacağım 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. Anlamsal 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 filtre uygulayın. Her MetadataFilter nesnesi benzersiz bir anahtara karşılık gelmelidir. Birden fazla MetadataFilter nesne, mantıksal "AND" ifadeleriyle birleştirilir.

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

Örnek sorgu: (yıl >= 2020 VEYA yıl < 2010) VE (tür = dram VEYA tür = aksiyon)

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 bir değer aralığı için örnek sorgu: (year > 2015 AND year <= 2020)

MetadataFilter object list: metadataFilters = [ {key = &quot;chunk.custom_metadata.year&quot; koşullar = [{int_value = 2015, işlem = BÜYÜK HARF}]}, {anahtar = "chunk.custom_metadata.year" koşullar = [{int_value = 2020, işlem = LESS_EQUAL}]}]

Not: Aynı anahtara yönelik "VE" ifadeleri yalnızca sayısal değerler için 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

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

Uç nokta

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

Belirtilmezse en fazla 10 Document döndürülür. Maksimum boyut sınırı sayfa başına 20 Document'tir.

pageToken string

İsteğe bağlı. Önceki bir documents.list çağrısından alınan 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.

Sayfalandırma yapılırken documents.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

documents.list tarafından gönderilen ve sayfalandırılmış bir Document listesi içeren yanıt. Document değerleri 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 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 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Yöntem: corpora.documents.get

Belirli bir Document hakkında bilgi alır.

Uç nokta

indir 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 güncellemesi

Uç nokta

yama 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/" ön ekinden hariç tutulan ad), küçük harf alfanümerik veya kısa çizgi (-) karakterlerinden en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName'den 12 karakterlik rastgele bir ek ile birlikte 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, tam nitelikli alan adlarının virgülle ayrılmış bir 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ın okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Anlamsal Retriever Dokümanları"

customMetadata[] object (CustomMetadata)

İsteğe bağlı. Sorgulama için kullanılan anahtar/değer çiftleri olarak depolanan, kullanıcı tarafından sağlanan özel meta veriler. 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

Bir Document'yi siler.

Uç nokta

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

Yol parametreleri

name string

Zorunlu. Silinecek Document kaynağının 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 ilişkili tüm Chunk'ler ve nesneler de silinir.

Yanlış ise (varsayılan) Document herhangi bir 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 metni boş olur.

REST Kaynağı: corpora.documents

Kaynak: Doküman

Document, Chunk'lerden oluşan bir koleksiyondur. Bir Corpus'te en fazla 10.000 Document olabilir.

Alanlar
name string

Sabit. Tanımlayıcı. Document kaynağının adı. Kimlik ("corpora/*/documents/" ön ekinden hariç tutulan ad), küçük harf alfanümerik veya kısa çizgi (-) olan en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boş olursa 12 karakterlik rastgele bir son ek ile birlikte displayName öğesinden 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ın okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Semantic Retriever Documentation"

customMetadata[] object (CustomMetadata)

İsteğe bağlı. Sorgulama için kullanılan anahtar/değer çiftleri olarak depolanan, kullanıcı tarafından sağlanan ö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 damgası.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Ö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 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".

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

CustomMetadata

Anahtar/değer çiftleri olarak depolanan kullanıcı tarafından sağlanan meta veriler.

Alanlar
key string

Zorunlu. Depolanacak meta verinin anahtarı.

Birleştirme alanı value.

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,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}

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
  ]
}