Corpora

Metoda: korporat.krijoj

Krijon një Corpus bosh.

Pika përfundimtare

postoni https: / /generativelanguage.googleapis.com /v1beta /corpora
URL-ja përdor sintaksën e transkodimit të gRPC .

Trupi i kërkesës

Trupi i kërkesës përmban një shembull të Corpus .

Fushat
string name

E pandryshueshme. Identifikues. Emri i burimit Corpus . ID-ja (emri duke përjashtuar prefiksin "corpora/") mund të përmbajë deri në 40 karaktere që janë alfanumerike të vogla ose viza (-). ID-ja nuk mund të fillojë ose të përfundojë me një vizë. Nëse emri është bosh gjatë krijimit, një emër unik do të rrjedh nga displayName së bashku me një prapashtesë të rastësishme me 12 karaktere. Shembull: corpora/my-awesome-corpora-123a456b789c

string displayName

Fakultative. Emri i shfaqur i lexueshëm nga njeriu për Corpus . Emri i shfaqur duhet të jetë jo më shumë se 512 karaktere i gjatë, duke përfshirë hapësirat. Shembull: "Dokumentet në Retriever Semantic"

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes përmban një shembull të sapokrijuar të Corpus .

Metoda: korporat.pyetje

Kryen kërkimin semantik mbi një Corpus .

Pika përfundimtare

postoni https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /*}:query
URL-ja përdor sintaksën e transkodimit të gRPC .

Parametrat e rrugës

string name

E detyrueshme. Emri i Corpus për të kërkuar. Shembull: corpora/my-corpus-123 Merr formën corpora/{corpora} .

Trupi i kërkesës

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

Fushat
query string

E detyrueshme. Vargu i pyetjes për të kryer kërkimin semantik.

objekt metadataFilters[] object ( MetadataFilter )

Fakultative. Filtro për të dhënat meta Chunk dhe Document . Çdo objekt MetadataFilter duhet të korrespondojë me një çelës unik. Objekte të shumëfishta MetadataFilter bashkohen me "AND" logjike.

Shembull i pyetjes në nivel dokumenti: (viti >= 2020 OSE viti < 2010) DHE (zhanri = dramë OSE zhanri = veprim)

Lista e objekteve MetadataFilter : metadataFilters = [ {key = "document.custom_metadata.year" condition = [{int_value = 2020, operacion = GREATER_EQUAL}, {int_value = 2010, operacion = LESS}]}, {key = "document.custom_metata. viti" kushtet = [{int_value = 2020, operacion = GREATER_BARABAR}, {int_value = 2010, operacion = PAK}]}, {key = "document.custom_metadata.genre" kushtet = [{stringValue = "dramë", operacion = EQUAL}, {stringValue = "veprim", operacion = BARABAR}]}]

Shembull i pyetjes në nivel copë për një gamë numerike vlerash: (viti > 2015 DHE viti <= 2020)

Lista e objekteve MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" condition = [{int_value = 2015, operacion = MË GJITHË }]}, {key = "chunk.custom_metadata.year" kushtet = [{int_value = 2020, operacion = PAK_BARABARTË}]}]

Shënim: "AND" për të njëjtin çelës mbështeten vetëm për vlerat numerike. Vlerat e vargut mbështesin vetëm "OR" për të njëjtin çelës.

resultsCount integer

Fakultative. Numri maksimal i Chunk për t'u kthyer. Shërbimi mund të kthejë më Chunk s.

Nëse nuk specifikohet, do të kthehen më së shumti Chunk s. Numri maksimal i specifikuar i rezultateve është 100.

Trupi i reagimit

Përgjigje nga corpora.query që përmban një listë të pjesëve përkatëse.

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

Fushat
object ( RelevantChunk ) relevantChunks[] (RelevantChunk)

Pjesët përkatëse.

Përfaqësimi JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Metoda: korporat.lista

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

Pika përfundimtare

merrni https: / /generativelanguage.googleapis.com /v1beta /corpora
URL-ja përdor sintaksën e transkodimit të gRPC .

Parametrat e pyetjes

integer pageSize

Fakultative. Numri maksimal i Corpora për t'u kthyer (për faqe). Shërbimi mund të kthejë më pak Corpora .

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

string pageToken

Fakultative. Një shenjë faqeje, e marrë nga një telefonatë e mëparshme corpora.list .

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

Gjatë paginimit, të gjithë parametrat e tjerë të dhënë në corpora.list duhet të përputhen me thirrjen që ka dhënë tokenin e faqes.

Trupi i kërkesës

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

Trupi i reagimit

Përgjigje nga corpora.list që përmban një listë të faqezuar të Corpora . Rezultatet renditen sipas corpus.create_time në rritje.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 corpora[] object ( Corpus )

Korpuset e kthyera.

string nextPageToken

Një shenjë, e cila mund të dërgohet si pageToken për të tërhequr faqen tjetër. Nëse kjo fushë hiqet, nuk ka më faqe.

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

Metoda: corpora.get

Merr informacion për një Corpus specifik.

Pika përfundimtare

merrni https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /*}
URL-ja përdor sintaksën e transkodimit të gRPC .

Parametrat e rrugës

string name

E detyrueshme. Emri i Corpus . Shembull: corpora/my-corpus-123 Merr formën corpora/{corpora} .

Trupi i kërkesës

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

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes përmban një shembull të Corpus .

Metoda: corpora.patch

Përditëson një Corpus .

Pika përfundimtare

patch https: / /generativelanguage.googleapis.com /v1beta /{corpus.name=corpora /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

URL-ja përdor sintaksën e transkodimit të gRPC .

Parametrat e rrugës

corpus.name string

E pandryshueshme. Identifikues. Emri i burimit Corpus . ID-ja (emri duke përjashtuar prefiksin "corpora/") mund të përmbajë deri në 40 karaktere që janë alfanumerike të vogla ose viza (-). ID-ja nuk mund të fillojë ose të përfundojë me një vizë. Nëse emri është bosh gjatë krijimit, një emër unik do të rrjedh nga displayName së bashku me një prapashtesë të rastësishme me 12 karaktere. Shembull: corpora/my-awesome-corpora-123a456b789c Merr formën corpora/{corpora} .

Parametrat e pyetjes

vargu updateMask string ( FieldMask format)

E detyrueshme. Lista e fushave për të përditësuar. Aktualisht, kjo mbështet vetëm përditësimin e displayName .

Kjo është një listë e ndarë me presje e emrave plotësisht të kualifikuar të fushave. Shembull: "user.displayName,photo" .

Trupi i kërkesës

Trupi i kërkesës përmban një shembull të Corpus .

Fushat
string displayName

Fakultative. Emri i shfaqur i lexueshëm nga njeriu për Corpus . Emri i shfaqur duhet të jetë jo më shumë se 512 karaktere i gjatë, duke përfshirë hapësirat. Shembull: "Dokumentet në Retriever Semantic"

Trupi i reagimit

Nëse është i suksesshëm, trupi i përgjigjes përmban një shembull të Corpus .

Metoda: korpora.fshij

Fshin një Corpus .

Pika përfundimtare

fshi https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /*}
URL-ja përdor sintaksën e transkodimit të gRPC .

Parametrat e rrugës

string name

E detyrueshme. Emri i burimit të Corpus . Shembull: corpora/my-corpus-123 Merr formën corpora/{corpora} .

Parametrat e pyetjes

force boolean

Fakultative. Nëse vendoset në true, çdo Document dhe objekt që lidhet me këtë Corpus do të fshihet gjithashtu.

Nëse është false (e parazgjedhur), një gabim FAILED_PRECONDITION do të kthehet nëse Corpus përmban ndonjë Document s.

Trupi i kërkesës

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

Trupi i reagimit

Nëse ka sukses, trupi i përgjigjes është bosh.

Burimi REST: corpora.permissions

Burimi: Leja

Burimi i lejes i jep përdoruesit, grupit ose pjesës tjetër të botës akses në burimin e API-së PalM (p.sh. një model i akorduar, korpus).

Një rol është një koleksion i operacioneve të lejuara që i lejon përdoruesit të kryejnë veprime specifike në burimet e PalM API. Për t'i vënë ato të disponueshme për përdoruesit, grupet ose llogaritë e shërbimit, ju caktoni role. Kur caktoni një rol, ju jepni lejet që përmban roli.

Ka tre role koncentrike. Çdo rol është një superbashkë e operacioneve të lejuara të rolit të mëparshëm:

  • lexuesi mund të përdorë burimin (p.sh. modeli i akorduar, korpusi) për përfundime
  • shkrimtari ka lejet e lexuesit dhe gjithashtu mund të modifikojë dhe shpërndajë
  • pronari ka lejet e shkrimtarit dhe gjithashtu mund të fshijë
Fushat
string name

Vetëm dalje. Identifikues. Emri i lejes. Një emër unik do të krijohet gjatë krijimit. Shembuj: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Vetëm dalje.

enum granteeType enum ( GranteeType )

Fakultative. E pandryshueshme. Lloji i përfituesit të grantit.

string emailAddress

Fakultative. E pandryshueshme. Adresa e emailit të përdoruesit të grupit të cilit i referohet kjo leje. Fusha nuk caktohet kur lloji i përfituesit të lejes është GJITHË.

role enum ( Role )

E detyrueshme. Roli i dhënë nga kjo leje.

Përfaqësimi JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Përcakton llojet e përfituesit të kësaj leje.

Enums
GRANTEE_TYPE_UNSPECIFIED Vlera e paracaktuar. Kjo vlerë është e papërdorur.
USER Përfaqëson një përdorues. Kur caktohet, duhet të jepni adresën e emailit për përdoruesin.
GROUP Përfaqëson një grup. Kur caktohet, duhet të jepni adresën e emailit për grupin.
EVERYONE Përfaqëson akses për të gjithë. Asnjë informacion shtesë nuk kërkohet.

Roli

Përcakton rolin e dhënë nga kjo leje.

Enums
ROLE_UNSPECIFIED Vlera e paracaktuar. Kjo vlerë është e papërdorur.
OWNER Pronari mund të përdorë, përditësojë, ndajë dhe fshijë burimin.
WRITER Writer mund të përdorë, përditësojë dhe ndajë burimin.
READER Lexuesi mund të përdorë burimin.

Filtri i meta të dhënave

Filtri i ofruar nga përdoruesi për të kufizuar rikthimin bazuar në vlerat e meta të dhënave të nivelit të Chunk ose Document . Shembull (zhanër = dramë OSE zhanër = veprim): çelësi = "document.custom_metadata.zhanër" kushtet = [{stringValue = "dramë", operacion = EQUAL}, {stringValue = "veprim", operacion = EQUAL}]

Fushat
string key

E detyrueshme. Çelësi i meta të dhënave për tu filtruar.

conditions[] object ( Condition )

E detyrueshme. Condition është për çelësin e dhënë që do të aktivizojë këtë filtër. Condition të shumta bashkohen nga OR logjike.

Përfaqësimi JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

gjendja

Gjendja e filtrit e zbatueshme për një çelës të vetëm.

Fushat
numri i operation enum ( Operator )

E detyrueshme. Operatori aplikoi në çiftin e dhënë çelës-vlerë për të aktivizuar kushtin.

Lloji i value Union type
Lloji i vlerës duhet të jetë në përputhje me llojin e vlerës së përcaktuar në fushën për çelësin përkatës. Nëse llojet e vlerave nuk janë të qëndrueshme, rezultati do të jetë një grup bosh. Kur CustomMetadata ka një lloj vlere StringList , kushti i filtrimit duhet të përdorë string_value të çiftuar me një operacion INCLUDES/EXCLUDES, përndryshe rezultati do të jetë gjithashtu një grup bosh. value mund të jetë vetëm një nga sa vijon:
stringValue string

Vlera e vargut për të filtruar meta të dhënat.

numericValue number

Vlera numerike për të filtruar meta të dhënat.

Përfaqësimi JSON 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

Operatori

Përcakton operatorët e vlefshëm që mund të aplikohen në një çift çelës-vlerë.

Enums
OPERATOR_UNSPECIFIED Vlera e paracaktuar. Kjo vlerë është e papërdorur.
LESS Mbështetur nga numerike.
LESS_EQUAL Mbështetur nga numerike.
EQUAL Mbështetur nga numerike dhe varg.
GREATER_EQUAL Mbështetur nga numerike.
GREATER Mbështetur nga numerike.
NOT_EQUAL Mbështetur nga numerike dhe varg.
INCLUDES Mbështetet nga vargu vetëm kur lloji i vlerës CustomMetadata për çelësin e dhënë ka një stringListValue .
EXCLUDES Mbështetet nga vargu vetëm kur lloji i vlerës CustomMetadata për çelësin e dhënë ka një stringListValue .

RelevantCunk

Informacioni për një pjesë të rëndësishme për një pyetje.

Fushat
chunkRelevanceScore number

Rëndësia e Chunk me pyetjen.

objekt chunk object ( Chunk )

Chunk e lidhur me pyetjen.

Përfaqësimi JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

Burimi REST: corpora

Burimi: Corpus

Një Corpus është një koleksion i Document s. Një projekt mund të krijojë deri në 5 korpuse.

Fushat
string name

E pandryshueshme. Identifikues. Emri i burimit Corpus . ID-ja (emri duke përjashtuar prefiksin "corpora/") mund të përmbajë deri në 40 karaktere që janë alfanumerike të vogla ose viza (-). ID-ja nuk mund të fillojë ose të përfundojë me një vizë. Nëse emri është bosh gjatë krijimit, një emër unik do të rrjedh nga displayName së bashku me një prapashtesë të rastësishme me 12 karaktere. Shembull: corpora/my-awesome-corpora-123a456b789c

string displayName

Fakultative. Emri i shfaqur i lexueshëm nga njeriu për Corpus . Emri i shfaqur duhet të jetë jo më shumë se 512 karaktere i gjatë, duke përfshirë hapësirat. Shembull: "Dokumentet në Retriever Semantic"

createTime string ( Timestamp format)

Vetëm dalje. Vula kohore e krijimit të Corpus .

Një vulë kohore në formatin RFC3339 UTC "Zulu", me rezolucion nanosekonda dhe deri në nëntë shifra të pjesshme. Shembuj: "2014-10-02T15:01:23Z" dhe "2014-10-02T15:01:23.045123456Z" .

Vargu updateTime string ( Timestamp format)

Vetëm dalje. Vula kohore e përditësimit të fundit të Corpus .

Një vulë kohore në formatin RFC3339 UTC "Zulu", me rezolucion nanosekonda dhe deri në nëntë shifra të pjesshme. Shembuj: "2014-10-02T15:01:23Z" dhe "2014-10-02T15:01:23.045123456Z" .

Përfaqësimi JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}