Method: models.generateAnswer

یک پاسخ پایه از مدلی که یک ورودی GenerateAnswerRequest داده شده است ایجاد می کند.

درخواست HTTP

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateAnswer

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
model

string

ضروری. نام Model که برای تولید پاسخ زمینی استفاده می شود.

قالب: model=models/{model} .

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "contents": [
    {
      object (Content)
    }
  ],
  "answerStyle": enum (AnswerStyle),
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],

  // Union field grounding_source can be only one of the following:
  "inlinePassages": {
    object (GroundingPassages)
  },
  "semanticRetriever": {
    object (SemanticRetrieverConfig)
  }
  // End of list of possible types for union field grounding_source.
  "temperature": number
}
زمینه های
contents[]

object ( Content )

ضروری. محتوای گفتگوی فعلی با مدل. برای پرس و جوهای تک نوبتی، باید به این یک سوال پاسخ داد. برای جستارهای چند نوبتی، این یک فیلد تکراری است که حاوی تاریخچه مکالمه و آخرین Content فهرست حاوی سؤال است.

توجه: models.generateAnswer در حال حاضر فقط از درخواست‌های انگلیسی پشتیبانی می‌کند.

answerStyle

enum ( AnswerStyle )

ضروری. سبکی که در آن پاسخ ها باید برگردانده شوند.

safetySettings[]

object ( SafetySetting )

اختیاری. فهرستی از نمونه‌های SafetySetting منحصر به فرد برای مسدود کردن محتوای ناامن.

این در GenerateAnswerRequest.contents و GenerateAnswerResponse.candidate اعمال می شود. برای هر نوع SafetyCategory نباید بیش از یک تنظیم وجود داشته باشد. API هر محتوا و پاسخی را که نتواند آستانه تعیین شده توسط این تنظیمات را برآورده کند مسدود می کند. این فهرست تنظیمات پیش‌فرض را برای هر SafetyCategory مشخص‌شده در تنظیمات ایمنی لغو می‌کند. اگر هیچ SafetySetting برای یک SafetyCategory معین در لیست ارائه نشده باشد، API از تنظیمات ایمنی پیش‌فرض برای آن دسته استفاده می‌کند. دسته‌های آسیب HARM_CATEGORY_HATE_SPEECH، HARM_CATEGORY_SEXUALLY_EXPLICIT، HARM_CATEGORY_DANGEROUS_CONTENT، HARM_CATEGORY_HARASSMENT پشتیبانی می‌شوند.

میدان اتحادیه grounding_source . منابعی که پاسخ را در آنها پایه گذاری کنیم. grounding_source تنها می تواند یکی از موارد زیر باشد:
inlinePassages

object ( GroundingPassages )

معابر مطابق با درخواست ارائه شده است.

semanticRetriever

object ( SemanticRetrieverConfig )

محتوای بازیابی شده از منابع ایجاد شده از طریق Semantic Retriever API.

temperature

number

اختیاری. تصادفی بودن خروجی را کنترل می کند.

مقادیر می توانند از [0.0،1.0]، شامل متغیر باشند. یک مقدار نزدیکتر به 1.0 پاسخ‌هایی را تولید می‌کند که متنوع‌تر و خلاقانه‌تر هستند، در حالی که مقدار نزدیک‌تر به 0.0 معمولاً منجر به پاسخ‌های ساده‌تر از مدل می‌شود. دمای پایین (~0.2) معمولاً برای موارد استفاده Attributed-Question-Answering توصیه می شود.

بدن پاسخگو

پاسخ از مدل برای پاسخ پایه.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "answer": {
    object (Candidate)
  },
  "answerableProbability": number,
  "inputFeedback": {
    object (InputFeedback)
  }
}
زمینه های
answer

object ( Candidate )

پاسخ کاندیدا از مدل.

توجه: مدل همیشه سعی می کند یک پاسخ مبتنی بر ارائه دهد، حتی زمانی که بعید است که پاسخ از قسمت های داده شده قابل پاسخ باشد. در این صورت، ممکن است پاسخی با کیفیت پایین یا بی اساس، همراه با answerableProbability پایین ارائه شود.

answerableProbability

number

فقط خروجی تخمین مدل از احتمال صحیح بودن پاسخ آن و پایه گذاری آن در معابر ورودی.

احتمال پاسخ پذیری کم نشان می دهد که پاسخ ممکن است در منابع مستقر نباشد.

وقتی answerableProbability کم است، برخی از مشتریان ممکن است بخواهند:

  • نمایش پیامی با مضمون "ما نتوانستیم به این سوال پاسخ دهیم" به کاربر.
  • به یک LLM همه منظوره بازگردید که به این سؤال از دانش جهانی پاسخ می دهد. آستانه و ماهیت چنین بازگشت‌هایی به موارد استفاده مشتریان فردی بستگی دارد. 0.5 آستانه شروع خوبی است.
inputFeedback

object ( InputFeedback )

فقط خروجی بازخورد مربوط به داده های ورودی مورد استفاده برای پاسخ به سؤال، در مقابل پاسخ تولید شده توسط مدل به سؤال.

"داده های ورودی" می تواند یک یا چند مورد از موارد زیر باشد:

  • سوالی که توسط آخرین ورودی در GenerateAnswerRequest.content مشخص شده است
  • تاریخچه مکالمه مشخص شده توسط ورودی های دیگر در GenerateAnswerRequest.content
  • منابع زمین ( GenerateAnswerRequest.semantic_retriever یا GenerateAnswerRequest.inline_passages )

محدوده مجوز

به یکی از حوزه های 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 (GroundingPassage)
    }
  ]
}
زمینه های
passages[]

object ( GroundingPassage )

فهرست معابر.

گذرگاه زمینی

گذرگاه به صورت خطی با پیکربندی زمینی گنجانده شده است.

نمایندگی JSON
{
  "id": string,
  "content": {
    object (Content)
  }
}
زمینه های
id

string

شناسه متن برای نسبت دادن این قطعه در پاسخ های مبتنی بر.

content

object ( Content )

محتوای متن.

SemanticRetrieverConfig

پیکربندی برای بازیابی محتوای زمینی از یک Corpus یا Document ایجاد شده با استفاده از Semantic Retriever API.

نمایندگی JSON
{
  "source": string,
  "query": {
    object (Content)
  },
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "maxChunksCount": integer,
  "minimumRelevanceScore": number
}
زمینه های
source

string

ضروری. نام منبع برای بازیابی، به عنوان مثال corpora/123 یا corpora/123/documents/abc.

query

object ( Content )

ضروری. پرس و جو برای استفاده برای تطبیق شباهت‌های Chunk در منبع داده شده.

metadataFilters[]

object ( MetadataFilter )

اختیاری. فیلترهایی برای انتخاب Document و/یا Chunk از منبع.

maxChunksCount

integer

اختیاری. حداکثر تعداد Chunk مربوطه برای بازیابی.

minimumRelevanceScore

number

اختیاری. حداقل امتیاز مربوط به Chunk های مربوطه بازیابی شده.

سبک پاسخ

سبک برای پاسخ های مبتنی بر.

Enums
ANSWER_STYLE_UNSPECIFIED سبک پاسخ نامشخص
ABSTRACTIVE سبک موجز اما انتزاعی.
EXTRACTIVE سبک بسیار مختصر و استخراجی.
VERBOSE سبک پرمخاطب شامل جزئیات اضافی. پاسخ ممکن است به صورت یک جمله، پاراگراف، چند پاراگراف یا نقطه گلوله و غیره شکل بگیرد.

InputFeedback

بازخورد مربوط به داده های ورودی مورد استفاده برای پاسخ به سؤال، در مقابل پاسخ تولید شده توسط مدل به سؤال.

نمایندگی JSON
{
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "blockReason": enum (BlockReason)
}
زمینه های
safetyRatings[]

object ( SafetyRating )

رتبه بندی برای ایمنی ورودی حداکثر یک رتبه برای هر دسته وجود دارد.

blockReason

enum ( BlockReason )

اختیاری. در صورت تنظیم، ورودی مسدود شده است و هیچ نامزدی برگردانده نمی شود. ورودی خود را دوباره بیان کنید

BlockReason

مشخص می کند که دلیل مسدود شدن ورودی چه بوده است.

Enums
BLOCK_REASON_UNSPECIFIED مقدار پیش فرض. این مقدار استفاده نشده است.
SAFETY ورودی به دلایل ایمنی مسدود شد. می‌توانید safetyRatings بررسی کنید تا متوجه شوید کدام دسته ایمنی آن را مسدود کرده است.
OTHER ورودی به دلایل دیگر مسدود شد.