File Search Stores

API-ja e Kërkimit të Skedarëve ofron një shërbim të hostuar për përgjigjen e pyetjeve për ndërtimin e sistemeve të Gjenerimit të Augmentuar të Rikthimit (RAG) duke përdorur infrastrukturën e Google-it.

Burimi REST: fileSearchStores

Burimi: FileSearchStore

Një FileSearchStore është një koleksion Document .

Fushat
string name

Vetëm dalje. I pandryshueshëm. Identifikues. Emri i burimit FileSearchStore . Është një ID (emri duke përjashtuar parashtesën "fileSearchStores/") që mund të përmbajë deri në 40 karaktere që janë alfanumerike të vogla ose viza (-). Është vetëm dalje. Emri unik do të rrjedhë nga displayName së bashku me një prapashtesë të rastësishme prej 12 karakteresh. Shembull: fileSearchStores/my-awesome-file-search-store-123a456b789c Nëse displayName nuk është dhënë, emri do të gjenerohet rastësisht.

string displayName

Opsionale. Emri i shfaqur i lexueshëm nga njeriu për FileSearchStore . Emri i shfaqur nuk duhet të jetë më shumë se 512 karaktere i gjatë, duke përfshirë hapësirat. Shembull: "Docs on Semantic Retriever"

createTime string ( Timestamp format)

Vetëm rezultate. Vula kohore e kohës kur u krijua FileSearchStore .

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

vargu updateTime string ( Timestamp format)

Vetëm rezultate. Vula kohore e kohës kur FileSearchStore është përditësuar për herë të fundit.

Përdor RFC 3339, ku rezultati i gjeneruar do të jetë gjithmonë i normalizuar sipas Z-së dhe do të përdorë 0, 3, 6 ose 9 shifra thyesore. Pranohen edhe zhvendosje të tjera përveç "Z". Shembuj: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ose "2014-10-02T15:01:23+05:30" .

vargu activeDocumentsCount string ( int64 format)

Vetëm rezultate. Numri i dokumenteve në FileSearchStore që janë aktive dhe gati për t'u rikthyer.

vargu pendingDocumentsCount string ( int64 format)

Vetëm rezultate. Numri i dokumenteve në FileSearchStore që po përpunohen.

vargu failedDocumentsCount string ( int64 format)

Vetëm rezultate. Numri i dokumenteve në FileSearchStore që nuk kanë arritur të përpunohen.

vargu sizeBytes string ( int64 format)

Vetëm rezultati. Madhësia e bajteve të papërpunuara të futura në FileSearchStore . Kjo është madhësia totale e të gjitha dokumenteve në FileSearchStore .

string embeddingModel

Opsionale. Modeli i ngulitjes që do të përdoret për FileSearchStore . Emri i burimit të modelit. Ky shërben si një ID për Modelin që do të përdorë. Formati: models/{model} . Nëse nuk specifikohet, do të përdoret modeli i parazgjedhur i ngulitjes.

Përfaqësimi JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "activeDocumentsCount": string,
  "pendingDocumentsCount": string,
  "failedDocumentsCount": string,
  "sizeBytes": string,
  "embeddingModel": string
}

Metoda: fileSearchStores.create

Krijon një FileSearchStore bosh.

Pika e Fundit

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

Trupi i kërkesës

Trupi i kërkesës përmban një instancë të FileSearchStore .

Fushat
string displayName

Opsionale. Emri i shfaqur i lexueshëm nga njeriu për FileSearchStore . Emri i shfaqur nuk duhet të jetë më shumë se 512 karaktere i gjatë, duke përfshirë hapësirat. Shembull: "Docs on Semantic Retriever"

string embeddingModel

Opsionale. Modeli i ngulitjes që do të përdoret për FileSearchStore . Emri i burimit të modelit. Ky shërben si një ID për Modelin që do të përdorë. Formati: models/{model} . Nëse nuk specifikohet, do të përdoret modeli i parazgjedhur i ngulitjes.

Trupi i përgjigjes

Nëse është e suksesshme, trupi i përgjigjes përmban një instancë të sapokrijuar të FileSearchStore .

Metoda: fileSearchStores.delete

Fshin një FileSearchStore .

Pika e Fundit

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

Parametrat e shtegut

string name

E detyrueshme. Emri i burimit të FileSearchStore . Shembull: fileSearchStores/my-file-search-store-123 Ai merr formën fileSearchStores/{filesearchstore} .

Parametrat e pyetjes

force boolean

Opsionale. Nëse vendoset në "e vërtetë", çdo Document dhe objekt që lidhet me këtë FileSearchStore do të fshihet gjithashtu.

Nëse është false (parazgjedhja), do të kthehet një gabim FAILED_PRECONDITION nëse FileSearchStore përmban ndonjë Document .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i përgjigjes

Nëse është i suksesshëm, trupi i përgjigjes është një objekt JSON bosh.

Metoda: fileSearchStores.get

Merr informacion në lidhje me një FileSearchStore specifik.

Pika e Fundit

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

Parametrat e shtegut

string name

E detyrueshme. Emri i FileSearchStore . Shembull: fileSearchStores/my-file-search-store-123 Merr formën fileSearchStores/{filesearchstore} .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i përgjigjes

Nëse është e suksesshme, trupi i përgjigjes përmban një instancë të FileSearchStore .

Metoda: fileSearchStores.list

Liston të gjitha FileSearchStores në pronësi të përdoruesit.

Pika e Fundit

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

Parametrat e pyetjes

pageSize integer

Opsionale. Numri maksimal i FileSearchStores që duhen kthyer (për faqe). Shërbimi mund të kthejë më pak FileSearchStores .

Nëse nuk specifikohet, do të kthehen maksimumi 10 FileSearchStores . Limiti maksimal i madhësisë është 20 FileSearchStores për faqe.

vargu i pageToken string

Opsionale. Një shenjë faqeje, e marrë nga një thirrje e mëparshme fileSearchStores.list .

Jep nextPageToken të kthyer në përgjigje si argument për kërkesën tjetër për të marrë faqen tjetër.

Gjatë faqosjes, të gjithë parametrat e tjerë të dhënë te fileSearchStores.list duhet të përputhen me thirrjen që ofroi tokenin e faqes.

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i përgjigjes

Përgjigje nga fileSearchStores.list që përmban një listë të faqezuar të FileSearchStores . Rezultatet renditen sipas rangut rritës fileSearchStore.create_time .

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

Fushat
objekti fileSearchStores[] object ( FileSearchStore )

Rag_stores të kthyera.

string nextPageToken

Një shenjë, e cila mund të dërgohet si pageToken për të marrë faqen tjetër. Nëse kjo fushë lihet jashtë, nuk ka faqe të tjera.

Përfaqësimi JSON 
{
  "fileSearchStores": [
    {
      object (FileSearchStore)
    }
  ],
  "nextPageToken": string
}

Metoda: fileSearchStores.importFile

Importon një File nga Shërbimi i Skedarëve në një FileSearchStore .

Pika e Fundit

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

Parametrat e shtegut

string fileSearchStoreName

E detyrueshme. E pandryshueshme. Emri i FileSearchStore ku do të importohet skedari. Shembull: fileSearchStores/my-file-search-store-123 Merr formën fileSearchStores/{filesearchstore} .

Trupi i kërkesës

Trupi i kërkesës përmban të dhëna me strukturën e mëposhtme:

Fushat
fileName string

E detyrueshme. Emri i File që do të importohet. Shembull: files/abc-123

objekti customMetadata[] object ( CustomMetadata )

Meta të dhëna të personalizuara që do të shoqërohen me skedarin.

objekti chunkingConfig object ( ChunkingConfig )

Opsionale. Konfigurim për t'i treguar shërbimit se si ta ndajë skedarin në copa. Nëse nuk ofrohet, shërbimi do të përdorë parametra të paracaktuar.

Trupi i përgjigjes

Nëse është i suksesshëm, trupi i përgjigjes përmban një instancë të Operation .

Burimi REST: fileSearchStores.operations

Burimi: Operacioni

Ky burim përfaqëson një operacion afatgjatë që është rezultat i një thirrjeje të API-t të rrjetit.

Fushat
string name

Emri i caktuar nga serveri, i cili është unik vetëm brenda të njëjtit shërbim që e kthen fillimisht. Nëse përdorni hartëzimin HTTP të parazgjedhur, name duhet të jetë një emër burimi që mbaron me operations/{unique_id} .

object metadata

Meta të dhëna specifike për shërbimin që lidhen me operacionin. Ato zakonisht përmbajnë informacion mbi progresin dhe meta të dhëna të zakonshme, siç është koha e krijimit. Disa shërbime mund të mos ofrojnë meta të dhëna të tilla. Çdo metodë që kthen një operacion afatgjatë duhet të dokumentojë llojin e meta të dhënave, nëse ka.

Një objekt që përmban fusha të një lloji arbitrar. Një fushë shtesë "@type" përmban një URI që identifikon llojin. Shembull: { "id": 1234, "@type": "types.example.com/standard/id" } .

done boolean

Nëse vlera është false , kjo do të thotë që operacioni është ende në vazhdim. Nëse true , operacioni ka përfunduar dhe është i disponueshëm ose error ose response .

result Union type
Rezultati i operacionit, i cili mund të jetë ose një error ose një response e vlefshme. Nëse done == false , as error dhe as response nuk caktohen. Nëse done == true , mund të caktohet saktësisht një nga error ose response . Disa shërbime mund të mos e japin rezultatin. result mund të jetë vetëm një nga të mëposhtmet:
objekt error object ( Status )

Rezultati i gabimit të operacionit në rast dështimi ose anulimi.

object response

Përgjigja normale dhe e suksesshme e operacionit. Nëse metoda origjinale nuk kthen të dhëna mbi suksesin, si p.sh. Delete , përgjigja është google.protobuf.Empty . Nëse metoda origjinale është standarde Get / Create / Update , përgjigja duhet të jetë burimi. Për metodat e tjera, përgjigja duhet të ketë llojin XxxResponse , ku Xxx është emri i metodës origjinale. Për shembull, nëse emri i metodës origjinale është TakeSnapshot() , lloji i përgjigjes së nxjerrë është TakeSnapshotResponse .

Një objekt që përmban fusha të një lloji arbitrar. Një fushë shtesë "@type" përmban një URI që identifikon llojin. Shembull: { "id": 1234, "@type": "types.example.com/standard/id" } .

Përfaqësimi JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

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

Metoda: fileSearchStores.operations.get

Merr gjendjen më të fundit të një operacioni që është në ekzekutim të gjatë. Klientët mund ta përdorin këtë metodë për të anketuar rezultatin e operacionit në intervale të rekomanduara nga shërbimi API.

Pika e Fundit

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

Parametrat e shtegut

string name

Emri i burimit të operacionit. Ai merr formën fileSearchStores/{filesearchstore}/operations/{operation} .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i përgjigjes

Nëse është i suksesshëm, trupi i përgjigjes përmban një instancë të Operation .

Burimi REST: fileSearchStores.upload.operations

Burimi: Operacioni

Ky burim përfaqëson një operacion afatgjatë që është rezultat i një thirrjeje të API-t të rrjetit.

Fushat
string name

Emri i caktuar nga serveri, i cili është unik vetëm brenda të njëjtit shërbim që e kthen fillimisht. Nëse përdorni hartëzimin HTTP të parazgjedhur, name duhet të jetë një emër burimi që mbaron me operations/{unique_id} .

object metadata

Meta të dhëna specifike për shërbimin që lidhen me operacionin. Ato zakonisht përmbajnë informacion mbi progresin dhe meta të dhëna të zakonshme, siç është koha e krijimit. Disa shërbime mund të mos ofrojnë meta të dhëna të tilla. Çdo metodë që kthen një operacion afatgjatë duhet të dokumentojë llojin e meta të dhënave, nëse ka.

Një objekt që përmban fusha të një lloji arbitrar. Një fushë shtesë "@type" përmban një URI që identifikon llojin. Shembull: { "id": 1234, "@type": "types.example.com/standard/id" } .

done boolean

Nëse vlera është false , kjo do të thotë që operacioni është ende në vazhdim. Nëse true , operacioni ka përfunduar dhe është i disponueshëm ose error ose response .

result Union type
Rezultati i operacionit, i cili mund të jetë ose një error ose një response e vlefshme. Nëse done == false , as error dhe as response nuk caktohen. Nëse done == true , mund të caktohet saktësisht një nga error ose response . Disa shërbime mund të mos e japin rezultatin. result mund të jetë vetëm një nga të mëposhtmet:
objekt error object ( Status )

Rezultati i gabimit të operacionit në rast dështimi ose anulimi.

object response

Përgjigja normale dhe e suksesshme e operacionit. Nëse metoda origjinale nuk kthen të dhëna mbi suksesin, si p.sh. Delete , përgjigja është google.protobuf.Empty . Nëse metoda origjinale është standarde Get / Create / Update , përgjigja duhet të jetë burimi. Për metodat e tjera, përgjigja duhet të ketë llojin XxxResponse , ku Xxx është emri i metodës origjinale. Për shembull, nëse emri i metodës origjinale është TakeSnapshot() , lloji i përgjigjes së nxjerrë është TakeSnapshotResponse .

Një objekt që përmban fusha të një lloji arbitrar. Një fushë shtesë "@type" përmban një URI që identifikon llojin. Shembull: { "id": 1234, "@type": "types.example.com/standard/id" } .

Përfaqësimi JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

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

Metoda: fileSearchStores.upload.operations.get

Merr gjendjen më të fundit të një operacioni që është në ekzekutim të gjatë. Klientët mund ta përdorin këtë metodë për të anketuar rezultatin e operacionit në intervale të rekomanduara nga shërbimi API.

Pika e Fundit

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

Parametrat e shtegut

string name

Emri i burimit të operacionit. Ai merr formën fileSearchStores/{filesearchstore}/upload/operations/{operation} .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i përgjigjes

Nëse është i suksesshëm, trupi i përgjigjes përmban një instancë të Operation .

Metoda: media.download

Shkarkon media nga një FileSearchStore .

Pika e Fundit

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

Parametrat e shtegut

string name

E detyrueshme. Emri i burimit të medias që do të shkarkohet. Shembull: fileSearchStores/abc-123/media/blob123 Merr formën fileSearchStores/{filesearchstore}/media/{+media} .

Trupi i kërkesës

Trupi i kërkesës duhet të jetë bosh.

Trupi i përgjigjes

Nëse është e suksesshme, trupi i përgjigjes është bosh.

Metoda: media.uploadToFileSearchStore

Ngarkon të dhënat në një FileSearchStore, i përpunon paraprakisht dhe i copëzon ato përpara se t'i ruajë në një dokument FileSearchStore.

Pika e Fundit

  • URI i ngarkimit, për kërkesat e ngarkimit të medias:
    • posto https: / /generativelanguage.googleapis.com /upload /v1beta /{fileSearchStoreName=fileSearchStores /*}:uploadToFileSearchStore
  • URI i meta të dhënave, për kërkesat vetëm për meta të dhëna:
    • posto https: / /generativelanguage.googleapis.com /v1beta /{fileSearchStoreName=fileSearchStores /*}:uploadToFileSearchStore

    Parametrat e shtegut

    string fileSearchStoreName

    E detyrueshme. E pandryshueshme. Emri i FileSearchStore ku do të ngarkohet skedari. Shembull: fileSearchStores/my-file-search-store-123 Merr formën fileSearchStores/{filesearchstore} .

    Trupi i kërkesës

    Trupi i kërkesës përmban të dhëna me strukturën e mëposhtme:

    Fushat
    string displayName

    Opsionale. Emri i shfaqur i dokumentit të krijuar.

    objekti customMetadata[] object ( CustomMetadata )

    Meta të dhëna të personalizuara që do të shoqërohen me të dhënat.

    objekti chunkingConfig object ( ChunkingConfig )

    Opsionale. Konfigurim për t'i treguar shërbimit se si t'i ndajë të dhënat në pjesë të vogla. Nëse nuk jepet, shërbimi do të përdorë parametra të paracaktuar.

    string mimeType

    Opsionale. Lloji MIME i të dhënave. Nëse nuk jepet, do të nxirret nga përmbajtja e ngarkuar.

    Trupi i përgjigjes

    Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

    Fushat
    string name

    Emri i caktuar nga serveri, i cili është unik vetëm brenda të njëjtit shërbim që e kthen fillimisht. Nëse përdorni hartëzimin HTTP të parazgjedhur, name duhet të jetë një emër burimi që mbaron me operations/{unique_id} .

    object metadata

    Meta të dhëna specifike për shërbimin që lidhen me operacionin. Ato zakonisht përmbajnë informacion mbi progresin dhe meta të dhëna të zakonshme, siç është koha e krijimit. Disa shërbime mund të mos ofrojnë meta të dhëna të tilla. Çdo metodë që kthen një operacion afatgjatë duhet të dokumentojë llojin e meta të dhënave, nëse ka.

    Një objekt që përmban fusha të një lloji arbitrar. Një fushë shtesë "@type" përmban një URI që identifikon llojin. Shembull: { "id": 1234, "@type": "types.example.com/standard/id" } .

    done boolean

    Nëse vlera është false , kjo do të thotë që operacioni është ende në vazhdim. Nëse true , operacioni ka përfunduar dhe është i disponueshëm ose error ose response .

    result Union type
    Rezultati i operacionit, i cili mund të jetë ose një error ose një response e vlefshme. Nëse done == false , as error dhe as response nuk caktohen. Nëse done == true , mund të caktohet saktësisht një nga error ose response . Disa shërbime mund të mos e japin rezultatin. result mund të jetë vetëm një nga të mëposhtmet:
    objekt error object ( Status )

    Rezultati i gabimit të operacionit në rast dështimi ose anulimi.

    object response

    Përgjigja normale dhe e suksesshme e operacionit. Nëse metoda origjinale nuk kthen të dhëna mbi suksesin, si p.sh. Delete , përgjigja është google.protobuf.Empty . Nëse metoda origjinale është standarde Get / Create / Update , përgjigja duhet të jetë burimi. Për metodat e tjera, përgjigja duhet të ketë llojin XxxResponse , ku Xxx është emri i metodës origjinale. Për shembull, nëse emri i metodës origjinale është TakeSnapshot() , lloji i përgjigjes së nxjerrë është TakeSnapshotResponse .

    Një objekt që përmban fusha të një lloji arbitrar. Një fushë shtesë "@type" përmban një URI që identifikon llojin. Shembull: { "id": 1234, "@type": "types.example.com/standard/id" } .

    Përfaqësimi JSON 
    {
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

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