Documents

Metoda: korporat.dokumentet.krijoj

Krijon një Document bosh.

Pika përfundimtare

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

Parametrat e rrugës

parent string

E detyrueshme. Emri i Corpus ku do të krijohet ky Document . Shembull: corpora/my-corpus-123 Merr formën corpora/{corpora} .

Trupi i kërkesës

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

Fushat
string name

E pandryshueshme. Identifikues. Emri i burimit Document . ID-ja (emri duke përjashtuar parashtesën "corpora/*/documents/") 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/{corpus_id}/documents/my-awesome-doc-123a456b789c

string displayName

Fakultative. Emri i ekranit i lexueshëm nga njeriu për Document . Emri i shfaqur duhet të jetë jo më shumë se 512 karaktere i gjatë, duke përfshirë hapësirat. Shembull: "Dokumentacioni Semantik Retriever"

object ( CustomMetadata ) customMetadata[] (Metadata e personalizuar)

Fakultative. Përdoruesi siguroi meta të dhëna të personalizuara të ruajtura si çifte çelës-vlerë të përdorur për të kërkuar. Një Document mund të ketë një maksimum prej 20 CustomMetadata .

Trupi i reagimit

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

Metoda: korporat.dokumentet.pyetja

Kryen kërkimin semantik mbi një Document .

Pika përfundimtare

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

Parametrat e rrugës

string name

E detyrueshme. Emri i Document për të kërkuar. Shembull: corpora/my-corpus-123/documents/the-doc-abc Merr formën corpora/{corpora}/documents/{document} .

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.

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.

objekt metadataFilters[] object ( MetadataFilter )

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

Shënim: Filtrimi i nivelit Document nuk mbështetet për këtë kërkesë sepse një emër Document është specifikuar tashmë.

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

Lista e objekteve MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" kushte = [{int_value = 2020, operacion = GREATER_BARABAR}, {int_value = 2010, operacion = LESS}}, {key = "chunk.custom_metadatagenre. "conditions = [{stringValue = "dramë", operacion = EQUAL}, {stringValue = "veprim", operacion = EQUAL}}]

Shembull i pyetjes 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.

Trupi i reagimit

Përgjigje nga documents.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 të kthyera.

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

Metoda: korporat.dokumentet.lista

Liston të gjithë Document në një Corpus .

Pika përfundimtare

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

Parametrat e rrugës

parent string

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

Parametrat e pyetjes

integer pageSize

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

Nëse nuk specifikohet, do të kthehen më së shumti 10 Document . Kufiri maksimal i madhësisë është 20 Document për faqe.

string pageToken

Fakultative. Një shenjë faqeje, e marrë nga një thirrje e mëparshme documents.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ë documents.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 documents.list që përmban një listë të faqezuar të Document s. Document janë renditur sipas document.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
documents[] object ( Document )

Document i kthyer s.

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 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Metoda: corpora.documents.get

Merr informacion në lidhje me një Document specifik.

Pika përfundimtare

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

Parametrat e rrugës

string name

E detyrueshme. Emri i Document për t'u marrë. Shembull: corpora/my-corpus-123/documents/the-doc-abc Merr formën corpora/{corpora}/documents/{document} .

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ë Document .

Metoda: corpora.documents.patch

Përditëson një Document .

Pika përfundimtare

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

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

Parametrat e rrugës

string document.name

E pandryshueshme. Identifikues. Emri i burimit Document . ID-ja (emri duke përjashtuar parashtesën "corpora/*/documents/") 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/{corpus_id}/documents/my-awesome-doc-123a456b789c Merr formën corpora/{corpora}/documents/{document} .

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 dhe customMetadata .

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ë Document .

Fushat
string displayName

Fakultative. Emri i ekranit i lexueshëm nga njeriu për Document . Emri i shfaqur duhet të jetë jo më shumë se 512 karaktere i gjatë, duke përfshirë hapësirat. Shembull: "Dokumentacioni Semantik Retriever"

object ( CustomMetadata ) customMetadata[] (Metadata e personalizuar)

Fakultative. Përdoruesi siguroi meta të dhëna të personalizuara të ruajtura si çifte çelës-vlerë të përdorur për të kërkuar. Një Document mund të ketë një maksimum prej 20 CustomMetadata .

Trupi i reagimit

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

Metoda: corpora.documents.delete

Fshin një Document .

Pika përfundimtare

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

Parametrat e rrugës

string name

E detyrueshme. Emri i burimit të Document për t'u fshirë. Shembull: corpora/my-corpus-123/documents/the-doc-abc Merr formën corpora/{corpora}/documents/{document} .

Parametrat e pyetjes

force boolean

Fakultative. Nëse vendoset në true, çdo Chunk dhe objekte që lidhen me këtë Document do të fshihen gjithashtu.

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

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

Burimi: Dokument

Një Document është një koleksion i Chunk s. Një Corpus mund të ketë një maksimum prej 10,000 Document .

Fushat
string name

E pandryshueshme. Identifikues. Emri i burimit Document . ID-ja (emri duke përjashtuar parashtesën "corpora/*/documents/") 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/{corpus_id}/documents/my-awesome-doc-123a456b789c

string displayName

Fakultative. Emri i ekranit i lexueshëm nga njeriu për Document . Emri i shfaqur duhet të jetë jo më shumë se 512 karaktere i gjatë, duke përfshirë hapësirat. Shembull: "Dokumentacioni Semantik Retriever"

object ( CustomMetadata ) customMetadata[] (Metadata e personalizuar)

Fakultative. Përdoruesi siguroi meta të dhëna të personalizuara të ruajtura si çifte çelës-vlerë të përdorur për të kërkuar. Një Document mund të ketë një maksimum prej 20 CustomMetadata .

Vargu updateTime string ( Timestamp format)

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

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

createTime string ( Timestamp format)

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

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,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}

Metadatat e personalizuara

Meta të dhënat e ofruara nga përdoruesi ruhen si çifte çelës-vlerë.

Fushat
string key

E detyrueshme. Çelësi i meta të dhënave për t'u ruajtur.

Lloji i value Union type
value mund të jetë vetëm një nga sa vijon:
stringValue string

Vlera e vargut të meta të dhënave për të ruajtur.

Objekti stringListValue object ( StringList )

Vlera StringList e meta të dhënave për të ruajtur.

numericValue number

Vlera numerike e meta të dhënave për të ruajtur.

Përfaqësimi JSON 
{
  "key": string,

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

Lista e vargjeve

Vlerat e vargut të dhënë nga përdoruesi i janë caktuar një çelësi të vetëm meta të dhënash.

Fushat
string values[]

Vlerat e vargut të meta të dhënave për të ruajtur.

Përfaqësimi JSON 
{
  "values": [
    string
  ]
}