Question answering

API Semantic Retrieval ofron një shërbim të pritjes për përgjigjen e pyetjeve për ndërtimin e sistemeve të Gjenerimit të Shtuar të Rikthimit (RAG) duke përdorur infrastrukturën e Google. Për një përshkrim të hollësishëm, shikoni udhëzuesin e rikthimit semantik .

Metoda: modele.gjenerojPërgjigje

Gjeneron një përgjigje të bazuar nga modeli i dhënë një hyrje GenerateAnswerRequest .

Pika përfundimtare

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

Parametrat e rrugës

string model

E detyrueshme. Emri i Model që do të përdoret për gjenerimin e përgjigjes së bazuar.

Formati: model=models/{model} . Ajo merr formën models/{model} .

Trupi i kërkesës

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

Fushat
objekti contents[] object ( Content )

E detyrueshme. Përmbajtja e bisedës aktuale me Model . Për pyetjet me një kthesë, kjo është një pyetje e vetme për t'iu përgjigjur. Për pyetjet me shumë kthesa, kjo është një fushë e përsëritur që përmban historikun e bisedave dhe Content e fundit në listën që përmban pyetjen.

Shënim: models.generateAnswer mbështet vetëm pyetjet në anglisht.

answerStyle enum ( AnswerStyle )

E detyrueshme. Stili në të cilin përgjigjet duhet të kthehen.

objekti safetySettings[] object ( SafetySetting )

Fakultative. Një listë e rasteve unike SafetySetting për bllokimin e përmbajtjes së pasigurt.

Kjo do të zbatohet në GenerateAnswerRequest.contents dhe GenerateAnswerResponse.candidate . Nuk duhet të ketë më shumë se një cilësim për çdo lloj SafetyCategory . API do të bllokojë çdo përmbajtje dhe përgjigje që nuk arrin të përmbushë kufijtë e vendosur nga këto cilësime. Kjo listë anashkalon cilësimet e paracaktuara për secilën SafetyCategory të specifikuar në Cilësimet e sigurisë. Nëse nuk ka SafetySetting për një SafetyCategory të dhënë në listë, API do të përdorë cilësimin e paracaktuar të sigurisë për atë kategori. Kategoritë e dëmtimit HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT mbështeten. Referojuni udhëzuesit për informacion të detajuar mbi cilësimet e disponueshme të sigurisë. Referojuni gjithashtu udhëzimit të sigurisë për të mësuar se si të përfshini konsideratat e sigurisë në aplikacionet tuaja të AI.

grounding_source Union type
Burimet në të cilat bazohet përgjigja. grounding_source mund të jetë vetëm një nga sa vijon:
objekti inlinePassages object ( GroundingPassages )

Pasazhet e ofruara në përputhje me kërkesën.

object ( SemanticRetrieverConfig ) semanticRetriever (SemanticRetrieverConfig)

Përmbajtja e marrë nga burimet e krijuara nëpërmjet API-së Semantic Retriever.

number temperature

Fakultative. Kontrollon rastësinë e daljes.

Vlerat mund të variojnë nga [0.0,1.0], përfshirëse. Një vlerë më afër 1.0 do të prodhojë përgjigje që janë më të ndryshme dhe kreative, ndërsa një vlerë më afër 0.0 zakonisht do të rezultojë në përgjigje më të drejtpërdrejta nga modeli. Zakonisht rekomandohet një temperaturë e ulët (~0.2) për rastet e përdorimit të Atribuuar-Pyetje-Përgjigje.

Trupi i reagimit

Përgjigje nga modeli për një përgjigje të bazuar.

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

Fushat
objekti i answer object ( Candidate )

Përgjigja e kandidatit nga modeli.

Shënim: Modeli gjithmonë përpiqet të japë një përgjigje të bazuar, edhe kur përgjigja nuk ka gjasa të jetë e përgjegjshme nga pasazhet e dhëna. Në atë rast, mund të jepet një përgjigje me cilësi të ulët ose të pabazuar, së bashku me një probabilitet të ulët answerableProbability .

answerableProbability number probabilitetit

Vetëm dalje. Vlerësimi i modelit për probabilitetin që përgjigja e tij të jetë e saktë dhe e bazuar në pasazhet hyrëse.

Një answerableProbability tregon se përgjigja mund të mos jetë e bazuar në burime.

Kur answerableProbability është i ulët, mund të dëshironi:

  • Shfaq një mesazh me efektin "Nuk mund t'i përgjigjemi kësaj pyetjeje" për përdoruesit.
  • Kthehuni te një LLM me qëllim të përgjithshëm që i përgjigjet pyetjes nga njohuritë botërore. Pragu dhe natyra e këtyre rikthimeve do të varen nga rastet e përdorimit individual. 0.5 është një prag i mirë fillestar.
Objekt inputFeedback object ( InputFeedback )

Vetëm dalje. Reagimet lidhur me të dhënat hyrëse të përdorura për t'iu përgjigjur pyetjes, në krahasim me përgjigjen e krijuar nga modeli për pyetjen.

Të dhënat hyrëse mund të jenë një ose më shumë nga sa vijon:

  • Pyetja e specifikuar nga hyrja e fundit në GenerateAnswerRequest.content
  • Historia e bisedave e specifikuar nga hyrjet e tjera në GenerateAnswerRequest.content
  • Burimet e tokëzimit ( GenerateAnswerRequest.semantic_retriever ose GenerateAnswerRequest.inline_passages )
Përfaqësimi JSON 
{
  "answer": {
    object (Candidate)
  },
  "answerableProbability": number,
  "inputFeedback": {
    object (InputFeedback)
  }
}

Kalimet e tokëzimit

Një listë e përsëritur e pasazheve.

Fushat
passages[] object ( GroundingPassage )

Lista e pasazheve.

Përfaqësimi JSON 
{
  "passages": [
    {
      object (GroundingPassage)
    }
  ]
}

Kalim Tokësor

Kalimi i përfshirë në linjë me një konfigurim tokëzimi.

Fushat
string id

Identifikues për fragmentin për atribuimin e këtij fragmenti në përgjigjet e bazuara.

objekti content object ( Content )

Përmbajtja e pasazhit.

Përfaqësimi JSON 
{
  "id": string,
  "content": {
    object (Content)
  }
}

SemanticRetrieverConfig

Konfigurimi për marrjen e përmbajtjes së tokëzimit nga një Corpus ose Document i krijuar duke përdorur API-në Semantic Retriever.

Fushat
source string

E detyrueshme. Emri i burimit për rikthim. Shembull: corpora/123 ose corpora/123/documents/abc .

objekti query object ( Content )

E detyrueshme. Pyetje për t'u përdorur për përputhjen Chunk në burimin e dhënë sipas ngjashmërisë.

objekt metadataFilters[] object ( MetadataFilter )

Fakultative. Filtrat për zgjedhjen e Document dhe/ose Chunk nga burimi.

maxChunksCount integer

Fakultative. Numri maksimal i Chunk përkatëse për t'u marrë.

number minimumRelevanceScore

Fakultative. Rezultati minimal i rëndësisë për Chunk përkatëse të marra.

Përfaqësimi JSON 
{
  "source": string,
  "query": {
    object (Content)
  },
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "maxChunksCount": integer,
  "minimumRelevanceScore": number
}

Stili i përgjigjes

Stil për përgjigje të bazuara.

Enums
ANSWER_STYLE_UNSPECIFIED Stili i papërcaktuar i përgjigjes.
ABSTRACTIVE Stili i përmbledhur por abstrakt.
EXTRACTIVE Stil shumë i shkurtër dhe tërheqës.
VERBOSE Stili me fjalë duke përfshirë detaje shtesë. Përgjigja mund të formatohet si fjali, paragraf, paragrafë të shumtë ose pika, etj.

Input Feedback

Reagimet lidhur me të dhënat hyrëse të përdorura për t'iu përgjigjur pyetjes, në krahasim me përgjigjen e krijuar nga modeli për pyetjen.

Fushat
Objekt safetyRatings[] object ( SafetyRating )

Vlerësimet për sigurinë e hyrjes. Ka më së shumti një vlerësim për kategori.

blockReason enum ( BlockReason )

Fakultative. Nëse vendoset, hyrja është bllokuar dhe asnjë kandidat nuk kthehet. Riformuloni hyrjen.

Përfaqësimi JSON 
{
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "blockReason": enum (BlockReason)
}

BlockReason

Përcakton se cila ishte arsyeja pse u bllokua hyrja.

Enums
BLOCK_REASON_UNSPECIFIED Vlera e paracaktuar. Kjo vlerë është e papërdorur.
SAFETY Hyrja u bllokua për arsye sigurie. Inspektoni safetyRatings për të kuptuar se cila kategori e sigurisë e bllokoi atë.
OTHER Hyrja u bllokua për arsye të tjera.
,

API Semantic Retrieval ofron një shërbim të pritjes për përgjigjen e pyetjeve për ndërtimin e sistemeve të Gjenerimit të Shtuar të Rikthimit (RAG) duke përdorur infrastrukturën e Google. Për një përshkrim të hollësishëm, shikoni udhëzuesin e rikthimit semantik .

Metoda: modele.gjenerojPërgjigje

Gjeneron një përgjigje të bazuar nga modeli i dhënë një hyrje GenerateAnswerRequest .

Pika përfundimtare

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

Parametrat e rrugës

string model

E detyrueshme. Emri i Model që do të përdoret për gjenerimin e përgjigjes së bazuar.

Formati: model=models/{model} . Ajo merr formën models/{model} .

Trupi i kërkesës

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

Fushat
objekti contents[] object ( Content )

E detyrueshme. Përmbajtja e bisedës aktuale me Model . Për pyetjet me një kthesë, kjo është një pyetje e vetme për t'iu përgjigjur. Për pyetjet me shumë kthesa, kjo është një fushë e përsëritur që përmban historikun e bisedave dhe Content e fundit në listën që përmban pyetjen.

Shënim: models.generateAnswer mbështet vetëm pyetjet në anglisht.

answerStyle enum ( AnswerStyle )

E detyrueshme. Stili në të cilin përgjigjet duhet të kthehen.

objekti safetySettings[] object ( SafetySetting )

Fakultative. Një listë e rasteve unike SafetySetting për bllokimin e përmbajtjes së pasigurt.

Kjo do të zbatohet në GenerateAnswerRequest.contents dhe GenerateAnswerResponse.candidate . Nuk duhet të ketë më shumë se një cilësim për çdo lloj SafetyCategory . API do të bllokojë çdo përmbajtje dhe përgjigje që nuk arrin të përmbushë kufijtë e vendosur nga këto cilësime. Kjo listë anashkalon cilësimet e paracaktuara për secilën SafetyCategory të specifikuar në Cilësimet e sigurisë. Nëse nuk ka SafetySetting për një SafetyCategory të dhënë në listë, API do të përdorë cilësimin e paracaktuar të sigurisë për atë kategori. Kategoritë e dëmtimit HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT mbështeten. Referojuni udhëzuesit për informacion të detajuar mbi cilësimet e disponueshme të sigurisë. Referojuni gjithashtu udhëzimit të sigurisë për të mësuar se si të përfshini konsideratat e sigurisë në aplikacionet tuaja të AI.

grounding_source Union type
Burimet në të cilat bazohet përgjigja. grounding_source mund të jetë vetëm një nga sa vijon:
objekti inlinePassages object ( GroundingPassages )

Pasazhet e ofruara në përputhje me kërkesën.

object ( SemanticRetrieverConfig ) semanticRetriever (SemanticRetrieverConfig)

Përmbajtja e marrë nga burimet e krijuara nëpërmjet API-së Semantic Retriever.

number temperature

Fakultative. Kontrollon rastësinë e daljes.

Vlerat mund të variojnë nga [0.0,1.0], përfshirëse. Një vlerë më afër 1.0 do të prodhojë përgjigje që janë më të ndryshme dhe kreative, ndërsa një vlerë më afër 0.0 zakonisht do të rezultojë në përgjigje më të drejtpërdrejta nga modeli. Zakonisht rekomandohet një temperaturë e ulët (~0.2) për rastet e përdorimit të Atribuuar-Pyetje-Përgjigje.

Trupi i reagimit

Përgjigje nga modeli për një përgjigje të bazuar.

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

Fushat
objekti i answer object ( Candidate )

Përgjigja e kandidatit nga modeli.

Shënim: Modeli gjithmonë përpiqet të japë një përgjigje të bazuar, edhe kur përgjigja nuk ka gjasa të jetë e përgjegjshme nga pasazhet e dhëna. Në atë rast, mund të jepet një përgjigje me cilësi të ulët ose të pabazuar, së bashku me një probabilitet të ulët answerableProbability .

answerableProbability number probabilitetit

Vetëm dalje. Vlerësimi i modelit për probabilitetin që përgjigja e tij të jetë e saktë dhe e bazuar në pasazhet hyrëse.

Një answerableProbability tregon se përgjigja mund të mos jetë e bazuar në burime.

Kur answerableProbability është i ulët, mund të dëshironi:

  • Shfaq një mesazh me efektin "Nuk mund t'i përgjigjemi kësaj pyetjeje" për përdoruesit.
  • Kthehuni te një LLM me qëllim të përgjithshëm që i përgjigjet pyetjes nga njohuritë botërore. Pragu dhe natyra e këtyre rikthimeve do të varen nga rastet e përdorimit individual. 0.5 është një prag i mirë fillestar.
Objekt inputFeedback object ( InputFeedback )

Vetëm dalje. Reagimet lidhur me të dhënat hyrëse të përdorura për t'iu përgjigjur pyetjes, në krahasim me përgjigjen e krijuar nga modeli për pyetjen.

Të dhënat hyrëse mund të jenë një ose më shumë nga sa vijon:

  • Pyetja e specifikuar nga hyrja e fundit në GenerateAnswerRequest.content
  • Historia e bisedave e specifikuar nga hyrjet e tjera në GenerateAnswerRequest.content
  • Burimet e tokëzimit ( GenerateAnswerRequest.semantic_retriever ose GenerateAnswerRequest.inline_passages )
Përfaqësimi JSON 
{
  "answer": {
    object (Candidate)
  },
  "answerableProbability": number,
  "inputFeedback": {
    object (InputFeedback)
  }
}

Kalimet e tokëzimit

Një listë e përsëritur e pasazheve.

Fushat
passages[] object ( GroundingPassage )

Lista e pasazheve.

Përfaqësimi JSON 
{
  "passages": [
    {
      object (GroundingPassage)
    }
  ]
}

Kalim Tokësor

Kalimi i përfshirë në linjë me një konfigurim tokëzimi.

Fushat
string id

Identifikues për fragmentin për atribuimin e këtij fragmenti në përgjigjet e bazuara.

objekti content object ( Content )

Përmbajtja e pasazhit.

Përfaqësimi JSON 
{
  "id": string,
  "content": {
    object (Content)
  }
}

SemanticRetrieverConfig

Konfigurimi për marrjen e përmbajtjes së tokëzimit nga një Corpus ose Document i krijuar duke përdorur API-në Semantic Retriever.

Fushat
source string

E detyrueshme. Emri i burimit për rikthim. Shembull: corpora/123 ose corpora/123/documents/abc .

objekti query object ( Content )

E detyrueshme. Pyetje për t'u përdorur për përputhjen Chunk në burimin e dhënë sipas ngjashmërisë.

objekt metadataFilters[] object ( MetadataFilter )

Fakultative. Filtrat për zgjedhjen e Document dhe/ose Chunk nga burimi.

maxChunksCount integer

Fakultative. Numri maksimal i Chunk përkatëse për t'u marrë.

number minimumRelevanceScore

Fakultative. Rezultati minimal i rëndësisë për Chunk përkatëse të marra.

Përfaqësimi JSON 
{
  "source": string,
  "query": {
    object (Content)
  },
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "maxChunksCount": integer,
  "minimumRelevanceScore": number
}

Stili i përgjigjes

Stil për përgjigje të bazuara.

Enums
ANSWER_STYLE_UNSPECIFIED Stili i papërcaktuar i përgjigjes.
ABSTRACTIVE Stili i përmbledhur por abstrakt.
EXTRACTIVE Stil shumë i shkurtër dhe tërheqës.
VERBOSE Stili me fjalë duke përfshirë detaje shtesë. Përgjigja mund të formatohet si fjali, paragraf, paragrafë të shumtë ose pika, etj.

Input Feedback

Reagimet lidhur me të dhënat hyrëse të përdorura për t'iu përgjigjur pyetjes, në krahasim me përgjigjen e krijuar nga modeli për pyetjen.

Fushat
Objekt safetyRatings[] object ( SafetyRating )

Vlerësimet për sigurinë e hyrjes. Ka më së shumti një vlerësim për kategori.

blockReason enum ( BlockReason )

Fakultative. Nëse vendoset, hyrja është bllokuar dhe asnjë kandidat nuk kthehet. Riformuloni hyrjen.

Përfaqësimi JSON 
{
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "blockReason": enum (BlockReason)
}

BlockReason

Përcakton se cila ishte arsyeja pse u bllokua hyrja.

Enums
BLOCK_REASON_UNSPECIFIED Vlera e paracaktuar. Kjo vlerë është e papërdorur.
SAFETY Hyrja u bllokua për arsye sigurie. Inspektoni safetyRatings për të kuptuar se cila kategori e sigurisë e bllokoi atë.
OTHER Hyrja u bllokua për arsye të tjera.