- HTTP অনুরোধ
- শরীরের অনুরোধ
- প্রতিক্রিয়া শরীর
- অনুমোদনের সুযোগ
- ক্যোয়ারী ইন্টারপ্রিটেশন অপশন
- প্রশ্নব্যাখ্যা
- QueryInterpretation.InterpretationType
- প্রশ্ন ব্যাখ্যা. কারণ
- অনুসন্ধানের ফলাফল
- স্নিপেট
- ম্যাচরেঞ্জ
- মেটাডেটা
- ফলাফল প্রদর্শন মেটাডেটা
- ResultDisplayMetadata.ResultDisplayLine
- ResultDisplayMetadata.ResultDisplayField
- ResultDebugInfo
- কাঠামোগত ফলাফল
- বানান ফলাফল
- Facet ফলাফল
- FacetBucket
- প্রতিক্রিয়াDebugInfo
- ত্রুটি তথ্য
- ErrorMessage
- ফলাফল গণনা
- SourceResultCount
- এটা চেষ্টা করুন!
ক্লাউড অনুসন্ধান ক্যোয়ারী API সার্চ পদ্ধতি প্রদান করে, যা ব্যবহারকারীর ক্যোয়ারী থেকে সবচেয়ে প্রাসঙ্গিক ফলাফল প্রদান করে। ফলাফলগুলি Gmail বা Google Drive-এর মতো Google Workspace অ্যাপ থেকে আসতে পারে অথবা আপনি তৃতীয় পক্ষ থেকে ইন্ডেক্স করা ডেটা থেকে আসতে পারে।
দ্রষ্টব্য: এই API কার্যকর করার জন্য একটি আদর্শ ব্যবহারকারীর অ্যাকাউন্ট প্রয়োজন৷ একটি পরিষেবা অ্যাকাউন্ট সরাসরি কোয়েরি API অনুরোধগুলি সম্পাদন করতে পারে না; কোয়েরি করার জন্য একটি পরিষেবা অ্যাকাউন্ট ব্যবহার করতে, Google Workspace ডোমেন-ওয়াইড অথরিটি ডেলিগেশন সেট-আপ করুন।
HTTP অনুরোধ
POST https://cloudsearch.googleapis.com/v1/query/search
URL gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করে।
শরীরের অনুরোধ
অনুরোধের অংশে নিম্নলিখিত কাঠামো সহ ডেটা রয়েছে:
JSON প্রতিনিধিত্ব |
---|
{ "requestOptions": { object ( |
ক্ষেত্র | |
---|---|
requestOptions | অনুরোধের বিকল্পগুলি, যেমন অনুসন্ধান অ্যাপ্লিকেশন এবং ব্যবহারকারীর সময় অঞ্চল। |
query | কাঁচা ক্যোয়ারী স্ট্রিং। সমর্থিত অনুসন্ধান অপারেটর দেখুন অপারেটরদের সাথে আপনার অনুসন্ধান সংকীর্ণ করুন৷ |
pageSize | সর্বোচ্চ সংখ্যক সার্চ ফলাফল এক পৃষ্ঠায় ফিরতে হবে। বৈধ মান 1 থেকে 100 এর মধ্যে, অন্তর্ভুক্ত। ডিফল্ট মান হল 10। 2000-এর বেশি ফলাফলের অনুরোধ করা হলে সর্বনিম্ন মান 50। |
start | ফলাফলের সূচী শুরু। |
dataSourceRestrictions[] | অনুসন্ধানের জন্য যে উৎসগুলি ব্যবহার করতে হবে৷ নির্দিষ্ট না থাকলে, বর্তমান অনুসন্ধান অ্যাপ্লিকেশন থেকে সমস্ত ডেটা উত্স ব্যবহার করা হয়৷ |
facetOptions[] | |
sortOptions | অনুসন্ধান ফলাফল বাছাই জন্য বিকল্প |
queryInterpretationOptions | ব্যবহারকারীর প্রশ্নের ব্যাখ্যা করার বিকল্প। |
contextAttributes[] | অনুরোধের জন্য প্রসঙ্গ বৈশিষ্ট্য যা অনুসন্ধান ফলাফলের র্যাঙ্কিং সামঞ্জস্য করতে ব্যবহার করা হবে। উপাদানের সর্বাধিক সংখ্যা 10। |
প্রতিক্রিয়া শরীর
সফল হলে, প্রতিক্রিয়া বডিতে নিম্নলিখিত কাঠামোর সাথে ডেটা থাকে:
অনুসন্ধান API প্রতিক্রিয়া.
JSON প্রতিনিধিত্ব |
---|
{ "queryInterpretation": { object ( |
ক্ষেত্র | |
---|---|
queryInterpretation | ব্যবহারকারীর প্রশ্নের জন্য কোয়েরি ব্যাখ্যার ফলাফল। ক্যোয়ারী ব্যাখ্যা নিষ্ক্রিয় থাকলে খালি। |
results[] | একটি অনুসন্ধান ক্যোয়ারী থেকে ফলাফল. |
structuredResults[] | ব্যবহারকারীর প্রশ্নের জন্য স্ট্রাকচার্ড ফলাফল। এই ফলাফল পেজ সাইজের সাথে গণনা করা হয় না। |
spellResults[] | প্রশ্নের জন্য প্রস্তাবিত বানান। |
facetResults[] | বারবার ফেসেট ফলাফল। |
hasMoreResults | কোয়েরির সাথে মেলে আরও অনুসন্ধান ফলাফল আছে কিনা। |
debugInfo | প্রতিক্রিয়া সম্পর্কে তথ্য ডিবাগিং। |
errorInfo | প্রতিক্রিয়া সম্পর্কে ত্রুটি তথ্য. |
resultCounts | প্রসারিত ফলাফল গণনা তথ্য. |
ইউনিয়ন ক্ষেত্রের
বিরল ক্ষেত্রে যখন সিস্টেমটি সমস্ত নথির মাধ্যমে অনুসন্ধান করতে অক্ষম, কোয়েরিটি পুনরায় চালান। | |
resultCountEstimate | এই প্রশ্নের জন্য আনুমানিক ফলাফল গণনা. |
resultCountExact | এই প্রশ্নের জন্য সঠিক ফলাফল গণনা. |
অনুমোদনের সুযোগ
নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:
-
https://www.googleapis.com/auth/cloud_search.query
-
https://www.googleapis.com/auth/cloud_search
আরও তথ্যের জন্য, অনুমোদন নির্দেশিকা দেখুন।
ক্যোয়ারী ইন্টারপ্রিটেশন অপশন
ব্যবহারকারীর প্রশ্ন ব্যাখ্যা করার বিকল্প।
JSON প্রতিনিধিত্ব |
---|
{ "disableNlInterpretation": boolean, "enableVerbatimMode": boolean, "disableSupplementalResults": boolean } |
ক্ষেত্র | |
---|---|
disableNlInterpretation | প্রশ্নের প্রাকৃতিক ভাষা (NL) ব্যাখ্যা নিষ্ক্রিয় করতে পতাকা। ডিফল্ট মিথ্যা, প্রাকৃতিক ভাষা ব্যাখ্যা নিষ্ক্রিয় করতে সত্য সেট করুন। NL ব্যাখ্যা শুধুমাত্র পূর্বনির্ধারিত ডেটাসোর্সে প্রযোজ্য। |
enableVerbatimMode | প্রাকৃতিক ভাষা (NL) প্রশ্নের ব্যাখ্যা, পরিপূরক ফলাফল পুনরুদ্ধার, এবং কাস্টম সহ সমার্থক শব্দ ব্যবহার করার মতো সমস্ত অভ্যন্তরীণ অপ্টিমাইজেশন বন্ধ করতে এই পতাকাটি সক্ষম করুন৷ Nl ব্যাখ্যা নিষ্ক্রিয় করা হবে যদি দুটি পতাকার যেকোনো একটি সত্য হয়। |
disableSupplementalResults | একটি প্রশ্নের জন্য সম্পূরক ফলাফল নিষ্ক্রিয় করতে এই পতাকা ব্যবহার করুন. সার্চঅ্যাপ্লিকেশন স্তরে নির্বাচিত পরিপূরক ফলাফল সেটিং অগ্রাধিকার নেবে যদি সত্যে সেট করা হয়। |
প্রশ্নব্যাখ্যা
JSON প্রতিনিধিত্ব |
---|
{ "interpretedQuery": string, "interpretationType": enum ( |
ক্ষেত্র | |
---|---|
interpretedQuery | অনুসন্ধানে ব্যবহৃত প্রশ্নের ব্যাখ্যা। উদাহরণস্বরূপ, "জন থেকে ইমেল" এর মতো স্বাভাবিক ভাষার অভিপ্রায় সহ প্রশ্নগুলিকে "from:john source:mail" হিসাবে ব্যাখ্যা করা হবে। কারণটি NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY হলে এই ক্ষেত্রটি পূরণ করা হবে না৷ |
interpretationType | |
reason | প্রশ্নের ব্যাখ্যার কারণ। এই ক্ষেত্রটি অনির্দিষ্ট হবে না যদি ব্যাখ্যার ধরনটি কোনটি না হয়। |
QueryInterpretation.InterpretationType
Enums | |
---|---|
NONE | ন্যাচারাল ল্যাঙ্গুয়েজ ইন্টারপ্রিটেশন বা অনুসন্ধানের ফলাফল আনার জন্য কোয়েরির বৃহত্তর সংস্করণ ব্যবহার করা হয় না। |
BLEND | মূল ক্যোয়ারী থেকে ফলাফল অন্যান্য ফলাফলের সাথে মিশ্রিত করা হয়. মূল ক্যোয়ারী থেকে পাওয়া ফলাফলগুলির সাথে এই অন্যান্য ফলাফলগুলিকে মিশ্রিত করার কারণটি নীচের 'কারণ' ক্ষেত্রের মধ্যে রয়েছে৷ |
REPLACE | মূল ক্যোয়ারী থেকে ফলাফল প্রতিস্থাপিত হয়. মূল ক্যোয়ারী থেকে ফলাফল প্রতিস্থাপনের কারণ নীচের 'কারণ' ক্ষেত্রের মধ্যে রয়েছে। |
প্রশ্ন ব্যাখ্যা. কারণ
Enums | |
---|---|
UNSPECIFIED | |
QUERY_HAS_NATURAL_LANGUAGE_INTENT | অনুসন্ধান ফলাফল আনার জন্য প্রশ্নের প্রাকৃতিক ভাষা ব্যাখ্যা ব্যবহার করা হয়। |
NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY | ক্যোয়ারী এবং ডকুমেন্ট শব্দের মিল ব্যবহার করা হয় বেছে বেছে অতিরিক্ত অনুসন্ধান ফলাফল পুনরুদ্ধার করার জন্য ক্যোয়ারীকে প্রসারিত করার জন্য কারণ ব্যবহারকারীর ক্যোয়ারীটির জন্য যথেষ্ট ফলাফল পাওয়া যায়নি। এই ক্ষেত্রে ব্যাখ্যা করা প্রশ্ন খালি হবে। |
অনুসন্ধানের ফলাফল
একটি নথির জন্য সূচীকৃত তথ্য ধারণকারী ফলাফল।
JSON প্রতিনিধিত্ব |
---|
{ "title": string, "url": string, "snippet": { object ( |
ক্ষেত্র | |
---|---|
title | অনুসন্ধান ফলাফলের শিরোনাম। |
url | অনুসন্ধান ফলাফলের URL. URLটিতে প্রকৃত আইটেমটিতে একটি Google পুনঃনির্দেশ রয়েছে৷ এই URLটি স্বাক্ষরিত এবং পরিবর্তন করা উচিত নয়৷ |
snippet | এই ফলাফলের জন্য উপলব্ধ সমস্ত স্নিপেটের সংমিশ্রণ (সারাংশ)। |
metadata | অনুসন্ধান ফলাফলের মেটাডেটা। |
clusteredResults[] | উত্স ক্লাস্টার করা হলে, ক্লাস্টার ফলাফলের তালিকা প্রদান করুন। ক্লাস্টার ফলাফলের শুধুমাত্র একটি স্তর থাকবে। যদি বর্তমান উৎস ক্লাস্টারিংয়ের জন্য সক্ষম না হয়, তাহলে এই ক্ষেত্রটি খালি থাকবে। |
debugInfo | এই অনুসন্ধান ফলাফল সম্পর্কে তথ্য ডিবাগিং. |
স্নিপেট
অনুসন্ধান ফলাফলের স্নিপেট, যা ফলাফল পৃষ্ঠার বিষয়বস্তু সংক্ষিপ্ত করে।
JSON প্রতিনিধিত্ব |
---|
{
"snippet": string,
"matchRanges": [
{
object ( |
ক্ষেত্র | |
---|---|
snippet | নথির স্নিপেট। নথির স্নিপেট। এইচটিএমএল ক্যারেক্টার থাকতে পারে যা রেন্ডার করার আগে এস্কেপ করা উচিত। |
matchRanges[] | স্নিপেটে মিলে যাওয়া ব্যাপ্তি। |
ম্যাচরেঞ্জ
একটি স্নিপেটের মিলিত পরিসর [শুরু, শেষ)।
JSON প্রতিনিধিত্ব |
---|
{ "start": integer, "end": integer } |
ক্ষেত্র | |
---|---|
start | স্নিপেটে ম্যাচের শুরুর অবস্থান। |
end | স্নিপেটে ম্যাচ শেষ। |
মেটাডেটা
একটি মিলে যাওয়া অনুসন্ধান ফলাফলের মেটাডেটা।
JSON প্রতিনিধিত্ব |
---|
{ "source": { object ( |
ক্ষেত্র | |
---|---|
source | ফলাফলের জন্য নামকৃত উৎস, যেমন Gmail। |
mimeType | অনুসন্ধান ফলাফলের মাইম প্রকার। |
thumbnailUrl | ফলাফলের থাম্বনেইল URL। |
owner | অনুসন্ধান ফলাফলের নথি বা বস্তুর মালিক (সাধারণত নির্মাতা)। |
createTime | অনুসন্ধান ফলাফলে এই নথি বা বস্তুর জন্য তৈরির সময়। RFC3339 UTC "জুলু" ফর্ম্যাটে একটি টাইমস্ট্যাম্প, ন্যানোসেকেন্ড রেজোলিউশন এবং নয়টি পর্যন্ত ভগ্নাংশের সংখ্যা। উদাহরণ: |
updateTime | অনুসন্ধান ফলাফলে বস্তুর জন্য সর্বশেষ পরিবর্তিত তারিখ। আইটেমটিতে সেট করা না থাকলে, এখানে প্রত্যাবর্তিত মানটি খালি। যখন RFC3339 UTC "জুলু" ফর্ম্যাটে একটি টাইমস্ট্যাম্প, ন্যানোসেকেন্ড রেজোলিউশন এবং নয়টি পর্যন্ত ভগ্নাংশের সংখ্যা। উদাহরণ: |
fields[] | স্ট্রাকচার্ড ডেটাতে ইন্ডেক্স করা ফিল্ড, একটি জেনেরিক নামের প্রপার্টি হিসেবে ফিরে এসেছে। |
displayOptions | একটি কাঠামোগত ডেটা অনুসন্ধান ফলাফল কীভাবে প্রদর্শন করতে হয় তা নির্দিষ্ট করে এমন বিকল্পগুলি। |
objectType | সার্চ রেজাল্টের অবজেক্ট টাইপ। |
ফলাফল প্রদর্শন মেটাডেটা
JSON প্রতিনিধিত্ব |
---|
{
"objectTypeLabel": string,
"metalines": [
{
object ( |
ক্ষেত্র | |
---|---|
objectTypeLabel | বস্তুর জন্য প্রদর্শন লেবেল. |
metalines[] | মেটালাইন সামগ্রী ফলাফলের সাথে প্রদর্শিত হবে। |
ResultDisplayMetadata.ResultDisplayLine
ক্ষেত্রগুলির সংগ্রহ যা একটি প্রদর্শিত লাইন তৈরি করে
JSON প্রতিনিধিত্ব |
---|
{
"fields": [
{
object ( |
ক্ষেত্র | |
---|---|
fields[] | |
ResultDisplayMetadata.ResultDisplayField
query.search ফলাফলের জন্য প্রদর্শন ক্ষেত্র
JSON প্রতিনিধিত্ব |
---|
{
"label": string,
"operatorName": string,
"property": {
object ( |
ক্ষেত্র | |
---|---|
label | সম্পত্তির জন্য প্রদর্শন লেবেল. |
operatorName | সম্পত্তির অপারেটরের নাম। |
property | সম্পত্তির জন্য নামের মান জোড়া। |
ResultDebugInfo
ফলাফল সম্পর্কে তথ্য ডিবাগিং।
JSON প্রতিনিধিত্ব |
---|
{ "formattedDebugInfo": string } |
ক্ষেত্র | |
---|---|
formattedDebugInfo | সাধারণ ডিবাগ তথ্য প্রদর্শনের জন্য বিন্যাসিত। |
কাঠামোগত ফলাফল
স্ট্রাকচার্ড ফলাফল যা সার্চ অনুরোধের অংশ হিসেবে ফেরত দেওয়া হয়।
JSON প্রতিনিধিত্ব |
---|
{
"person": {
object ( |
ক্ষেত্র | |
---|---|
person | একজন ব্যক্তির প্রতিনিধিত্ব |
বানান ফলাফল
JSON প্রতিনিধিত্ব |
---|
{ "suggestedQuery": string } |
ক্ষেত্র | |
---|---|
suggestedQuery | কোয়েরির প্রস্তাবিত বানান। |
Facet ফলাফল
উত্স নির্দিষ্ট দিক প্রতিক্রিয়া
JSON প্রতিনিধিত্ব |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"buckets": [
{
object ( |
ক্ষেত্র | |
---|---|
sourceName | উত্সের নাম যার জন্য ফলাফলগুলি ফেরত দেওয়া হয়৷ খালি হবে না। |
objectType | অবজেক্ট টাইপ যার জন্য ফ্যাসেট ফলাফল দেওয়া হয়। খালি হতে পারে। |
operatorName | মুখের জন্য নির্বাচিত অপারেটরের নাম। @Cloudsearch.SchemaPropertyOptions দেখুন |
buckets[] | অনুরূপ ফিল্টার সহ অন্তত একটি একক ফলাফল ধারণকারী প্রতিক্রিয়ার মানগুলির জন্য FacetBuckets৷ |
FacetBucket
একটি দিক একটি বালতি অপারেশন মৌলিক একক. একটি বালতি হয় একটি একক মান বা মানগুলির একটি সংলগ্ন পরিসর, বালতিযুক্ত ক্ষেত্রের ধরণের উপর নির্ভর করে। FacetBucket বর্তমানে শুধুমাত্র প্রতিক্রিয়া বস্তু ফেরত দেওয়ার জন্য ব্যবহার করা হয়।
JSON প্রতিনিধিত্ব |
---|
{ "count": integer, "percentage": integer, "filter": { object ( |
ক্ষেত্র | |
---|---|
count | বালতি মানের সাথে মেলে এমন ফলাফলের সংখ্যা। গণনার সঠিকতা নিশ্চিত করা হলেই শুধুমাত্র অনুসন্ধানের জন্য গণনা ফেরত দেওয়া হয়। ক্লাউড সার্চ কোনো প্রশ্নের জন্য দিক গণনার গ্যারান্টি দেয় না এবং অভিন্ন ক্যোয়ারীগুলির জন্যও ফেসেট সংখ্যাগুলি মাঝে মাঝে উপস্থিত হতে পারে। দিক গণনার অস্তিত্বের উপর নির্ভরতা তৈরি করবেন না; পরিবর্তে ফেসেট আউট শতাংশ ব্যবহার করুন যা সর্বদা ফেরত দেওয়া হয়। |
percentage | বালতি মানের সাথে মেলে এমন ফলাফলের শতাংশ৷ প্রত্যাবর্তিত মানটি (0-100] এর মধ্যে, এবং ভগ্নাংশ হলে একটি পূর্ণসংখ্যায় পূর্ণাঙ্গ করা হয়৷ যদি মানটি স্পষ্টভাবে না দেওয়া হয়, তাহলে এটি একটি শতাংশের মান উপস্থাপন করে যা 0-এ পরিণত হয়৷ সমস্ত অনুসন্ধানের জন্য শতাংশ ফেরত দেওয়া হয়, তবে এটি একটি আনুমানিক কারণ শতাংশ সবসময় ফেরত দেওয়া হয়, আপনার গণনার পরিবর্তে শতাংশ রেন্ডার করা উচিত। |
filter | সংশ্লিষ্ট বালতি নির্বাচন করা থাকলে অনুসন্ধানের অনুরোধে পাস করতে ফিল্টার করুন। |
value | |
প্রতিক্রিয়াDebugInfo
প্রতিক্রিয়া সম্পর্কে তথ্য ডিবাগিং।
JSON প্রতিনিধিত্ব |
---|
{ "formattedDebugInfo": string } |
ক্ষেত্র | |
---|---|
formattedDebugInfo | সাধারণ ডিবাগ তথ্য প্রদর্শনের জন্য বিন্যাসিত। |
ত্রুটি তথ্য
প্রতিক্রিয়া সম্পর্কে ত্রুটি তথ্য.
JSON প্রতিনিধিত্ব |
---|
{
"errorMessages": [
{
object ( |
ক্ষেত্র | |
---|---|
errorMessages[] | |
ErrorMessage
উৎস প্রতিক্রিয়া প্রতি ত্রুটি বার্তা.
JSON প্রতিনিধিত্ব |
---|
{
"source": {
object ( |
ক্ষেত্র | |
---|---|
source | |
errorMessage | |
ফলাফল গণনা
ফলাফল গণনা তথ্য
JSON প্রতিনিধিত্ব |
---|
{
"sourceResultCounts": [
{
object ( |
ক্ষেত্র | |
---|---|
sourceResultCounts[] | ফলাফল সহ প্রতিটি উৎসের জন্য ফলাফল গণনা তথ্য। |
SourceResultCount
উৎস প্রতি ফলাফল গণনা তথ্য.
JSON প্রতিনিধিত্ব |
---|
{ "source": { object ( |
ক্ষেত্র | |
---|---|
source | ফলাফল গণনার তথ্য যে উৎসের সাথে যুক্ত। |
hasMoreResults | এই উৎসের জন্য আরো অনুসন্ধান ফলাফল আছে কিনা. |
ইউনিয়ন ক্ষেত্রের | |
resultCountEstimate | এই উৎসের জন্য আনুমানিক ফলাফল গণনা. |
resultCountExact | এই উৎসের জন্য সঠিক ফলাফল গণনা. |