File Search Stores

File Search API, Google'ın altyapısını kullanarak Almayla Artırılmış Üretim (RAG) sistemleri oluşturmak için barındırılan bir soru-cevap hizmeti sunar.

Yöntem: media.uploadToFileSearchStore

Verileri bir FileSearchStore'a yükler, FileSearchStore belgesinde depolamadan önce önceden işler ve parçalara ayırır.

Uç nokta

  • Medya yükleme istekleri için yükleme URI'si:
 post https://generativelanguage.googleapis.com/upload/v1beta/{fileSearchStoreName=fileSearchStores/*}:uploadToFileSearchStore
  • Yalnızca meta veri istekleri için meta veri URI'si:
 post https://generativelanguage.googleapis.com/v1beta/{fileSearchStoreName=fileSearchStores/*}:uploadToFileSearchStore

Yol parametreleri

fileSearchStoreName string

Zorunlu. Değişmez. Dosyanın yükleneceği FileSearchStore adı. Örnek: fileSearchStores/my-file-search-store-123 It takes the form fileSearchStores/{filesearchstore}.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
displayName string

İsteğe bağlıdır. Oluşturulan dokümanın görünen adı.

customMetadata[] object (CustomMetadata)

Verilerle ilişkilendirilecek özel meta veriler.

chunkingConfig object (ChunkingConfig)

İsteğe bağlıdır. Hizmete verilerin nasıl bölüneceğini söyleyen yapılandırma. Sağlanmazsa hizmet varsayılan parametreleri kullanır.

mimeType string

İsteğe bağlıdır. Verilerin MIME türü. Belirtilmemişse yüklenen içerikten çıkarılır.

Yanıt metni

Bu, google.longrunning.Operation öğesinin bir kopyasıdır. Bunu kopyalamamız gerekiyor. Çünkü Scotty ile etkileşim kurmak için üst düzey Operation proto'ya eklenemeyen Scotty'ye özgü bir alan eklememiz gerekiyor.

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

Alanlar
name string

Sunucu tarafından atanan ad. Yalnızca bu adı ilk kez sağlayan hizmet kapsamında benzersizdir. Varsayılan HTTP eşlemesini kullanıyorsanız name değeri, operations/{unique_id} ile biten bir kaynak adı olmalıdır.

metadata object

İşlemle ilişkilendirilen, hizmete özgü meta veriler. Genellikle ilerleme bilgilerini ve oluşturma zamanı gibi ortak meta verileri içerir. Bazı hizmetler bu tür meta verileri sağlamayabilir. Uzun süreli bir işlemi döndüren tüm yöntemler, varsa meta veri türünü belirtmelidir.

Herhangi türde alanlar içeren bir nesne. Ek bir "@type" alanı, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Değer false olması işlemin devam ettiği anlamına gelir. Değer true olduğunda işlem tamamlanmış olup error veya response kullanılabilir.

result Union type
İşlem sonucu. error veya geçerli bir response olabilir. done == false ise error öğesi de response öğesi de ayarlanmaz. done == true ise error veya response öğelerinden yalnızca biri ayarlanabilir. Bazı hizmetler sonuç vermeyebilir. result aşağıdakilerden yalnızca biri olabilir:
error object (Status)

İşlem başarısız olduğunda veya iptal edildiğinde sistemin verdiği hata bilgisi.

response object

İşlem başarılı olduğunda sistemin verdiği normal yanıt. Orijinal yöntem başarılı olduğunda veri döndürmüyorsa (ör. Delete) yanıt google.protobuf.Empty olur. Orijinal yöntem standart Get/Create/Update ise yanıt kaynak olmalıdır. Diğer yöntemler için yanıtın türü XxxResponse olmalıdır. Burada Xxx, orijinal yöntem adıdır. Örneğin, orijinal yöntem adı TakeSnapshot() ise tahmin edilen yanıt türü TakeSnapshotResponse olur.

Herhangi türde alanlar içeren bir nesne. Ek bir "@type" alanı, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

JSON gösterimi 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Yöntem: fileSearchStores.create

Boş bir FileSearchStore oluşturur.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/fileSearchStores

İstek metni

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

Alanlar
displayName string

İsteğe bağlıdır. FileSearchStore 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: "Docs on Semantic Retriever" (Anlamsal Alıcı ile Dokümanlar)

Yanıt metni

Başarılı olursa yanıt metni, yeni oluşturulan bir FileSearchStore örneğini içerir.

Yöntem: fileSearchStores.delete

FileSearchStore öğesini siler.

Uç nokta

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

Yol parametreleri

name string

Zorunlu. FileSearchStore öğesinin kaynak adı. Örnek: fileSearchStores/my-file-search-store-123 It takes the form fileSearchStores/{filesearchstore}.

Sorgu parametreleri

force boolean

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

Yanlış (varsayılan) ise FileSearchStore, Document 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.get

Belirli bir FileSearchStore hakkında bilgi alır.

Uç nokta

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

Yol parametreleri

name string

Zorunlu. FileSearchStore adı. Örnek: fileSearchStores/my-file-search-store-123 It takes the form fileSearchStores/{filesearchstore}.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

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

Yöntem: fileSearchStores.list

Kullanıcıya ait tüm FileSearchStores listelenir.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/fileSearchStores

Sorgu parametreleri

pageSize integer

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

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

pageToken string

İsteğe bağlıdır. Önceki bir fileSearchStores.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 fileSearchStores.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

fileSearchStores.list öğesinin FileSearchStores öğelerinin sayfalandırılmış listesini içeren yanıtı. Sonuçlar artan fileSearchStore.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
fileSearchStores[] object (FileSearchStore)

Döndürülen ragStores.

nextPageToken string

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

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

Yöntem: fileSearchStores.importFile

Dosya Hizmeti'nden bir File öğesini FileSearchStore öğesine aktarır.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{fileSearchStoreName=fileSearchStores/*}:importFile

Yol parametreleri

fileSearchStoreName string

Zorunlu. Değişmez. Dosyanın içe aktarılacağı FileSearchStore'nın adı. Örnek: fileSearchStores/my-file-search-store-123 It takes the form fileSearchStores/{filesearchstore}.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
fileName string

Zorunlu. İçe aktarılacak File öğesinin adı. Örnek: files/abc-123

customMetadata[] object (CustomMetadata)

Dosyayla ilişkilendirilecek özel meta veriler.

chunkingConfig object (ChunkingConfig)

İsteğe bağlıdır. Hizmete dosyanın nasıl parçalanacağını söyleyen yapılandırma. Sağlanmazsa hizmet varsayılan parametreleri kullanır.

Yanıt metni

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

REST Kaynağı: fileSearchStores.operations

Kaynak: İşlem

Bu kaynak, bir ağ API çağrısının sonucu olan uzun süreli bir işlemi temsil eder.

Alanlar
name string

Sunucu tarafından atanan ad. Yalnızca bu adı ilk kez sağlayan hizmet kapsamında benzersizdir. Varsayılan HTTP eşlemesini kullanıyorsanız name değeri, operations/{unique_id} ile biten bir kaynak adı olmalıdır.

metadata object

İşlemle ilişkilendirilen, hizmete özgü meta veriler. Genellikle ilerleme bilgilerini ve oluşturma zamanı gibi ortak meta verileri içerir. Bazı hizmetler bu tür meta verileri sağlamayabilir. Uzun süreli bir işlemi döndüren tüm yöntemler, varsa meta veri türünü belirtmelidir.

Herhangi türde alanlar içeren bir nesne. Ek bir "@type" alanı, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Değer false olması işlemin devam ettiği anlamına gelir. Değer true olduğunda işlem tamamlanmış olup error veya response kullanılabilir.

result Union type
İşlem sonucu. error veya geçerli bir response olabilir. done == false ise error öğesi de response öğesi de ayarlanmaz. done == true ise error veya response öğelerinden yalnızca biri ayarlanabilir. Bazı hizmetler sonuç vermeyebilir. result aşağıdakilerden yalnızca biri olabilir:
error object (Status)

İşlem başarısız olduğunda veya iptal edildiğinde sistemin verdiği hata bilgisi.

response object

İşlem başarılı olduğunda sistemin verdiği normal yanıt. Orijinal yöntem başarılı olduğunda veri döndürmüyorsa (ör. Delete) yanıt google.protobuf.Empty olur. Orijinal yöntem standart Get/Create/Update ise yanıt kaynak olmalıdır. Diğer yöntemler için yanıtın türü XxxResponse olmalıdır. Burada Xxx, orijinal yöntem adıdır. Örneğin, orijinal yöntem adı TakeSnapshot() ise tahmin edilen yanıt türü TakeSnapshotResponse olur.

Herhangi türde alanlar içeren bir nesne. Ek bir "@type" alanı, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

JSON gösterimi 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Yöntem: fileSearchStores.operations.get

Uzun süreli bir işlemin en son durumunu bildirir. İstemciler bu yöntemi kullanarak API hizmetinin önerdiği aralıklarla işlem sonucunu sorgulayabilir.

Uç nokta

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

Yol parametreleri

name string

İşlem kaynağının adı. fileSearchStores/{filesearchstore}/operations/{operation} biçimindedir.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

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

REST Kaynağı: fileSearchStores.upload.operations

Kaynak: İşlem

Bu kaynak, bir ağ API çağrısının sonucu olan uzun süreli bir işlemi temsil eder.

Alanlar
name string

Sunucu tarafından atanan ad. Yalnızca bu adı ilk kez sağlayan hizmet kapsamında benzersizdir. Varsayılan HTTP eşlemesini kullanıyorsanız name değeri, operations/{unique_id} ile biten bir kaynak adı olmalıdır.

metadata object

İşlemle ilişkilendirilen, hizmete özgü meta veriler. Genellikle ilerleme bilgilerini ve oluşturma zamanı gibi ortak meta verileri içerir. Bazı hizmetler bu tür meta verileri sağlamayabilir. Uzun süreli bir işlemi döndüren tüm yöntemler, varsa meta veri türünü belirtmelidir.

Herhangi türde alanlar içeren bir nesne. Ek bir "@type" alanı, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Değer false olması işlemin devam ettiği anlamına gelir. Değer true olduğunda işlem tamamlanmış olup error veya response kullanılabilir.

result Union type
İşlem sonucu. error veya geçerli bir response olabilir. done == false ise error öğesi de response öğesi de ayarlanmaz. done == true ise error veya response öğelerinden yalnızca biri ayarlanabilir. Bazı hizmetler sonuç vermeyebilir. result aşağıdakilerden yalnızca biri olabilir:
error object (Status)

İşlem başarısız olduğunda veya iptal edildiğinde sistemin verdiği hata bilgisi.

response object

İşlem başarılı olduğunda sistemin verdiği normal yanıt. Orijinal yöntem başarılı olduğunda veri döndürmüyorsa (ör. Delete) yanıt google.protobuf.Empty olur. Orijinal yöntem standart Get/Create/Update ise yanıt kaynak olmalıdır. Diğer yöntemler için yanıtın türü XxxResponse olmalıdır. Burada Xxx, orijinal yöntem adıdır. Örneğin, orijinal yöntem adı TakeSnapshot() ise tahmin edilen yanıt türü TakeSnapshotResponse olur.

Herhangi türde alanlar içeren bir nesne. Ek bir "@type" alanı, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

JSON gösterimi 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Yöntem: fileSearchStores.upload.operations.get

Uzun süreli bir işlemin en son durumunu bildirir. İstemciler bu yöntemi kullanarak API hizmetinin önerdiği aralıklarla işlem sonucunu sorgulayabilir.

Uç nokta

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

Yol parametreleri

name string

İşlem kaynağının adı. fileSearchStores/{filesearchstore}/upload/operations/{operation} biçimindedir.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

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

REST Kaynağı: fileSearchStores

Kaynak: FileSearchStore

FileSearchStore, Document koleksiyonudur.

Alanlar
name string

Yalnızca çıkış. Değişmez. Tanımlayıcı. FileSearchStore kaynak adı. Küçük harf alfanümerik karakterler veya tire (-) içeren ve en fazla 40 karakterden oluşabilen bir kimliktir ("fileSearchStores/" öneki hariç ad). Yalnızca çıkış olarak kullanılır. Benzersiz ad, 12 karakterlik rastgele bir sonek ile birlikte displayName öğesinden türetilir. Örnek: fileSearchStores/my-awesome-file-search-store-123a456b789c displayName sağlanmazsa ad rastgele oluşturulur.

displayName string

İsteğe bağlıdır. FileSearchStore 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: "Docs on Semantic Retriever" (Anlamsal Alıcı ile Dokümanlar)

createTime string (Timestamp format)

Yalnızca çıkış. FileSearchStore 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".

updateTime string (Timestamp format)

Yalnızca çıkış. FileSearchStore öğ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".

activeDocumentsCount string (int64 format)

Yalnızca çıkış. FileSearchStore içinde etkin olan ve alınmaya hazır dokümanların sayısı.

pendingDocumentsCount string (int64 format)

Yalnızca çıkış. İşlenen FileSearchStore içindeki doküman sayısı.

failedDocumentsCount string (int64 format)

Yalnızca çıkış. FileSearchStore içinde işlenemeyen dokümanların sayısı.

sizeBytes string (int64 format)

Yalnızca çıkış. FileSearchStore'ya alınan ham baytların boyutu. Bu, FileSearchStore içindeki tüm belgelerin toplam boyutudur.

JSON gösterimi 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "activeDocumentsCount": string,
  "pendingDocumentsCount": string,
  "failedDocumentsCount": string,
  "sizeBytes": string
}