Documents

API-ja e Kërkimit të Skedarëve i referohet skedarëve ose dokumenteve tuaja burimore të papërpunuara si objekte të përkohshme të Skedarëve.

Metoda: fileSearchStores.documents.delete

Fshin një Document .

Pika e Fundit

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

Parametrat e shtegut

string name

E detyrueshme. Emri i burimit të Document që do të fshihet. Shembull: fileSearchStores/my-file-search-store-123/documents/the-doc-abc . Ai merr formën fileSearchStores/{filesearchstore}/documents/{document} .

Parametrat e pyetjes

force boolean

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

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

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

Merr informacion në lidhje me një Document specifik.

Pika e Fundit

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

Parametrat e shtegut

string name

E detyrueshme. Emri i Document që do të rikthehet. Shembull: fileSearchStores/my-file-search-store-123/documents/the-doc-abc . Ai merr formën fileSearchStores/{filesearchstore}/documents/{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 përmban një instancë të Document .

Metoda: fileSearchStores.documents.list

Liston të gjitha Document në një Corpus .

Pika e Fundit

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

Parametrat e shtegut

parent string

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

Parametrat e pyetjes

Madhësia pageSize integer

Opsionale. 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 maksimumi 10 Document . Limiti maksimal i madhësisë është 20 Document për faqe.

vargu i pageToken string

Opsionale. Një shenjë faqeje, e marrë nga një thirrje e mëparshme documents.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 documents.list duhet të përputhen me thirrjen që dha tokenin e faqes.

Trupi i kërkesës

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

Trupi i përgjigjes

Përgjigje nga documents.list që përmban një listë të faqezuar të Document . Document janë renditur sipas rendimit rritës document.create_time .

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

Fushat
objekt documents[] object ( Document )

Document i kthyer s.

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

Metoda: fileSearchStores.documents.query

Kryen kërkim semantik mbi një Document .

Pika e Fundit

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

Parametrat e shtegut

string name

E detyrueshme. Emri i Document që do të kërkohet. Shembull: fileSearchStores/my-file-search-store-123/documents/the-doc-abc . Ai merr formën fileSearchStores/{filesearchstore}/documents/{document} .

Trupi i kërkesës

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

Fushat
vargu string query

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

integer resultsCount

Opsionale. Numri maksimal i Chunk që duhen kthyer. Shërbimi mund të kthejë më pak Chunk -e.

Nëse nuk specifikohet, do të kthehen maksimumi 10 Chunk . Numri maksimal i rezultateve të specifikuara është 100.

objekti metadataFilters[] object ( MetadataFilter )

Opsionale. Filtër për meta të dhëna Chunk . Çdo objekt MetadataFilter duhet të korrespondojë me një çelës unik. Objekte të shumëfishta MetadataFilter bashkohen nga "AND" logjike.

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

Shembull pyetjeje: (viti >= 2020 OSE viti < 2010) DHE (zhanri = dramë OSE zhanri = aksion)

Lista e objekteve MetadataFilter : 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 = "dramë", operation = EQUAL}, {stringValue = "veprim", operation = EQUAL}}]

Shembull kërkese për një diapazon numerik vlerash: (viti > 2015 DHE viti <= 2020)

Lista e objekteve MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

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

Trupi i përgjigjes

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
objekti relevantChunks[] object ( RelevantChunk )

Pjesët përkatëse të kthyera.

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

Burimi REST: fileSearchStores.documents

Burimi: Dokument

Një Document është një koleksion i Chunk s.

Fushat
string name

I pandryshueshëm. Identifikues. Emri i burimit Document . ID-ja (emri duke përjashtuar parashtesën "fileSearchStores/*/documents/") mund të përmbajë deri në 40 karaktere që janë shkronja të vogla alfanumerike ose viza (-). ID-ja nuk mund të fillojë ose të mbarojë me 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 prej 12 karakteresh. Shembull: fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c

string displayName

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

objekti customMetadata[] object ( CustomMetadata )

Opsionale. Meta të dhëna të personalizuara të ofruara nga përdoruesi, të ruajtura si çifte çelës-vlerë të përdorura për pyetje. Një Document mund të ketë një maksimum prej 20 CustomMetadata .

vargu updateTime string ( Timestamp format)

Vetëm rezultati. Vula kohore e kohës kur Document ë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" .

createTime string ( Timestamp format)

Vetëm rezultati. Vula kohore e kohës kur është krijuar Document .

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

numërimi state enum ( State )

Vetëm rezultati. Gjendja aktuale e Document .

vargu sizeBytes string ( int64 format)

Vetëm rezultati. Madhësia e bajteve të papërpunuara të përfshira në Dokument.

string mimeType

Vetëm rezultati. Lloji mime i Dokumentit.

Përfaqësimi JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string,
  "state": enum (State),
  "sizeBytes": string,
  "mimeType": string
}

Shteti

Shtetet për ciklin jetësor të një Document .

Numërime
STATE_UNSPECIFIED Vlera e parazgjedhur. Kjo vlerë përdoret nëse gjendja lihet jashtë.
STATE_PENDING Disa Chunks të Document janë duke u përpunuar (ngulitje dhe ruajtje vektoriale).
STATE_ACTIVE Të gjitha Chunks e Document janë përpunuar dhe janë të disponueshme për pyetje.
STATE_FAILED Disa Chunks të Document dështuan në përpunim.