Documents

Dosya Arama API'si, ham kaynak dosyalarınıza veya dokümanlarınıza geçici Dosya nesneleri olarak referans verir.

Yöntem: fileSearchStores.documents.delete

Document öğesini siler.

Uç nokta

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

Yol parametreleri

name string

Zorunlu. Silinecek Document öğesinin kaynak adı. Örnek: fileSearchStores/my-file-search-store-123/documents/the-doc-abc It takes the form fileSearchStores/{filesearchstore}/documents/{document}.

Sorgu parametreleri

force boolean

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

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

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

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

Yöntem: fileSearchStores.documents.get

Belirli bir Document hakkında bilgi alır.

Uç nokta

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

Yol parametreleri

name string

Zorunlu. Alınacak Document öğesinin adı. Örnek: fileSearchStores/my-file-search-store-123/documents/the-doc-abc It takes the form fileSearchStores/{filesearchstore}/documents/{document}.

İstek metni

İ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: fileSearchStores.documents.list

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

Uç nokta

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

Yol parametreleri

parent string

Zorunlu. FileSearchStore içeren Documents'nin adı. Örnek: fileSearchStores/my-file-search-store-123 It takes the form fileSearchStores/{filesearchstore}.

Sorgu parametreleri

pageSize integer

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

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

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 metni

İstek metni boş olmalıdır.

Yanıt metni

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: fileSearchStores.documents.query

Document üzerinde semantik arama yapar.

Uç nokta

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

Yol parametreleri

name string

Zorunlu. Sorgulanacak Document öğesinin adı. Örnek: fileSearchStores/my-file-search-store-123/documents/the-doc-abc It takes the form fileSearchStores/{filesearchstore}/documents/{document}.

İstek metni

İstek içeriği 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ır. 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ıdır. 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 object list: 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 object list: 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" işlemleri yalnızca sayısal değerlerde desteklenir. Dize değerleri yalnızca aynı anahtar için "VEYA"ları destekler.

Yanıt metni

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

REST Kaynağı: fileSearchStores.documents

Kaynak: Doküman

Document, Chunk koleksiyonudur.

Alanlar
name string

Değişmez. Tanımlayıcı. Document kaynak adı. Kimlik ("fileSearchStores/*/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: fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c

displayName string

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

customMetadata[] object (CustomMetadata)

İsteğe bağlıdır. 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ın zaman damgası.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman 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ı.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da 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ış. Document'nın mevcut durumu.

sizeBytes string (int64 format)

Yalnızca çıkış. Belgeye alınan ham baytların boyutu.

mimeType string

Yalnızca çıkış. Belgenin MIME türü.

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

Eyalet

Document yaşam döngüsündeki durumlar.

Sıralamalar
STATE_UNSPECIFIED Varsayılan değer. Eyalet belirtilmemişse bu değer kullanılır.
STATE_PENDING Document Chunks bazıları işleniyor (yerleştirme ve vektör depolama).
STATE_ACTIVE Document alanının tüm Chunks işlenir ve sorgulanabilir.
STATE_FAILED Document öğelerinin bazıları Chunks işlenemedi.