- درخواست HTTP
- پارامترهای مسیر
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- گذرگاه های زمینی
- گذرگاه زمینی
- SemanticRetrieverConfig
- سبک پاسخ
- InputFeedback
- BlockReason
یک پاسخ پایه از مدلی که یک ورودی GenerateAnswerRequest
داده شده است ایجاد می کند.
درخواست HTTP
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateAnswer
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
model | ضروری. نام قالب: |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "contents": [ { object ( |
زمینه های | |
---|---|
contents[] | ضروری. محتوای گفتگوی فعلی با مدل. برای پرس و جوهای تک نوبتی، باید به این یک سوال پاسخ داد. برای جستارهای چند نوبتی، این یک فیلد تکراری است که حاوی تاریخچه مکالمه و آخرین توجه: models.generateAnswer در حال حاضر فقط از درخواستهای انگلیسی پشتیبانی میکند. |
answerStyle | ضروری. سبکی که در آن پاسخ ها باید برگردانده شوند. |
safetySettings[] | اختیاری. فهرستی از نمونههای این در |
میدان اتحادیه grounding_source . منابعی که پاسخ را در آنها پایه گذاری کنیم. grounding_source تنها می تواند یکی از موارد زیر باشد: | |
inlinePassages | معابر مطابق با درخواست ارائه شده است. |
semanticRetriever | محتوای بازیابی شده از منابع ایجاد شده از طریق Semantic Retriever API. |
temperature | اختیاری. تصادفی بودن خروجی را کنترل می کند. مقادیر می توانند از [0.0،1.0]، شامل متغیر باشند. یک مقدار نزدیکتر به 1.0 پاسخهایی را تولید میکند که متنوعتر و خلاقانهتر هستند، در حالی که مقدار نزدیکتر به 0.0 معمولاً منجر به پاسخهای سادهتر از مدل میشود. دمای پایین (~0.2) معمولاً برای موارد استفاده Attributed-Question-Answering توصیه می شود. |
بدن پاسخگو
پاسخ از مدل برای پاسخ پایه.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "answer": { object ( |
زمینه های | |
---|---|
answer | پاسخ کاندیدا از مدل. توجه: مدل همیشه سعی می کند یک پاسخ مبتنی بر ارائه دهد، حتی زمانی که بعید است که پاسخ از قسمت های داده شده قابل پاسخ باشد. در این صورت، ممکن است پاسخی با کیفیت پایین یا بی اساس، همراه با |
answerableProbability | فقط خروجی تخمین مدل از احتمال صحیح بودن پاسخ آن و پایه گذاری آن در معابر ورودی. احتمال پاسخ پذیری کم نشان می دهد که پاسخ ممکن است در منابع مستقر نباشد. وقتی
|
inputFeedback | فقط خروجی بازخورد مربوط به داده های ورودی مورد استفاده برای پاسخ به سؤال، در مقابل پاسخ تولید شده توسط مدل به سؤال. "داده های ورودی" می تواند یک یا چند مورد از موارد زیر باشد:
|
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/generative-language
-
https://www.googleapis.com/auth/generative-language.retriever
-
https://www.googleapis.com/auth/generative-language.retriever.readonly
-
https://www.googleapis.com/auth/generative-language.tuning
-
https://www.googleapis.com/auth/generative-language.tuning.readonly
برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.
گذرگاه های زمینی
فهرست مکرر متن.
نمایندگی JSON |
---|
{
"passages": [
{
object ( |
زمینه های | |
---|---|
passages[] | فهرست معابر. |
گذرگاه زمینی
گذرگاه به صورت خطی با پیکربندی زمینی گنجانده شده است.
نمایندگی JSON |
---|
{
"id": string,
"content": {
object ( |
زمینه های | |
---|---|
id | شناسه متن برای نسبت دادن این قطعه در پاسخ های مبتنی بر. |
content | محتوای متن. |
SemanticRetrieverConfig
پیکربندی برای بازیابی محتوای زمینی از یک Corpus
یا Document
ایجاد شده با استفاده از Semantic Retriever API.
نمایندگی JSON |
---|
{ "source": string, "query": { object ( |
زمینه های | |
---|---|
source | ضروری. نام منبع برای بازیابی، به عنوان مثال corpora/123 یا corpora/123/documents/abc. |
query | ضروری. پرس و جو برای استفاده برای تطبیق شباهتهای |
metadataFilters[] | اختیاری. فیلترهایی برای انتخاب |
maxChunksCount | اختیاری. حداکثر تعداد |
minimumRelevanceScore | اختیاری. حداقل امتیاز مربوط به |
سبک پاسخ
سبک برای پاسخ های مبتنی بر.
Enums | |
---|---|
ANSWER_STYLE_UNSPECIFIED | سبک پاسخ نامشخص |
ABSTRACTIVE | سبک موجز اما انتزاعی. |
EXTRACTIVE | سبک بسیار مختصر و استخراجی. |
VERBOSE | سبک پرمخاطب شامل جزئیات اضافی. پاسخ ممکن است به صورت یک جمله، پاراگراف، چند پاراگراف یا نقطه گلوله و غیره شکل بگیرد. |
InputFeedback
بازخورد مربوط به داده های ورودی مورد استفاده برای پاسخ به سؤال، در مقابل پاسخ تولید شده توسط مدل به سؤال.
نمایندگی JSON |
---|
{ "safetyRatings": [ { object ( |
زمینه های | |
---|---|
safetyRatings[] | رتبه بندی برای ایمنی ورودی حداکثر یک رتبه برای هر دسته وجود دارد. |
blockReason | اختیاری. در صورت تنظیم، ورودی مسدود شده است و هیچ نامزدی برگردانده نمی شود. ورودی خود را دوباره بیان کنید |
BlockReason
مشخص می کند که دلیل مسدود شدن ورودی چه بوده است.
Enums | |
---|---|
BLOCK_REASON_UNSPECIFIED | مقدار پیش فرض. این مقدار استفاده نشده است. |
SAFETY | ورودی به دلایل ایمنی مسدود شد. میتوانید safetyRatings بررسی کنید تا متوجه شوید کدام دسته ایمنی آن را مسدود کرده است. |
OTHER | ورودی به دلایل دیگر مسدود شد. |