mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
949 lines
42 KiB
HTML
949 lines
42 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Locations Agents Sessions Detect Intent - Dialogflow v2.0.0+20210329</title>
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
<style>
|
|
body {font-size: 90%;}
|
|
pre, code {font-size: 100%;}
|
|
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
|
</style>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Dialogflow v2.0.0+20210329</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Projects</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-create">Locations Agents Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-delete">Locations Agents Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-entity-types-create">Locations Agents Entity Types Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-entity-types-delete">Locations Agents Entity Types Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-entity-types-get">Locations Agents Entity Types Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-entity-types-list">Locations Agents Entity Types List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-entity-types-patch">Locations Agents Entity Types Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-create">Locations Agents Environments Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-delete">Locations Agents Environments Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-experiments-create">Locations Agents Environments Experiments Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-experiments-delete">Locations Agents Environments Experiments Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-experiments-get">Locations Agents Environments Experiments Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-experiments-list">Locations Agents Environments Experiments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-experiments-patch">Locations Agents Environments Experiments Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-experiments-start">Locations Agents Environments Experiments Start</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-experiments-stop">Locations Agents Environments Experiments Stop</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-get">Locations Agents Environments Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-list">Locations Agents Environments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-lookup-environment-history">Locations Agents Environments Lookup Environment History</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-patch">Locations Agents Environments Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-sessions-detect-intent">Locations Agents Environments Sessions Detect Intent</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-sessions-entity-types-create">Locations Agents Environments Sessions Entity Types Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-sessions-entity-types-delete">Locations Agents Environments Sessions Entity Types Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-sessions-entity-types-get">Locations Agents Environments Sessions Entity Types Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-sessions-entity-types-list">Locations Agents Environments Sessions Entity Types List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-sessions-entity-types-patch">Locations Agents Environments Sessions Entity Types Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-sessions-fulfill-intent">Locations Agents Environments Sessions Fulfill Intent</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-environments-sessions-match-intent">Locations Agents Environments Sessions Match Intent</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-export">Locations Agents Export</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-create">Locations Agents Flows Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-delete">Locations Agents Flows Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-get">Locations Agents Flows Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-get-validation-result">Locations Agents Flows Get Validation Result</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-list">Locations Agents Flows List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-pages-create">Locations Agents Flows Pages Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-pages-delete">Locations Agents Flows Pages Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-pages-get">Locations Agents Flows Pages Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-pages-list">Locations Agents Flows Pages List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-pages-patch">Locations Agents Flows Pages Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-patch">Locations Agents Flows Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-train">Locations Agents Flows Train</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-transition-route-groups-create">Locations Agents Flows Transition Route Groups Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-transition-route-groups-delete">Locations Agents Flows Transition Route Groups Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-transition-route-groups-get">Locations Agents Flows Transition Route Groups Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-transition-route-groups-list">Locations Agents Flows Transition Route Groups List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-transition-route-groups-patch">Locations Agents Flows Transition Route Groups Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-validate">Locations Agents Flows Validate</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-versions-create">Locations Agents Flows Versions Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-versions-delete">Locations Agents Flows Versions Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-versions-get">Locations Agents Flows Versions Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-versions-list">Locations Agents Flows Versions List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-versions-load">Locations Agents Flows Versions Load</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-flows-versions-patch">Locations Agents Flows Versions Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-get">Locations Agents Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-get-validation-result">Locations Agents Get Validation Result</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-intents-create">Locations Agents Intents Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-intents-delete">Locations Agents Intents Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-intents-get">Locations Agents Intents Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-intents-list">Locations Agents Intents List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-intents-patch">Locations Agents Intents Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-list">Locations Agents List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-patch">Locations Agents Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-restore">Locations Agents Restore</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Locations Agents Sessions Detect Intent</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-sessions-entity-types-create">Locations Agents Sessions Entity Types Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-sessions-entity-types-delete">Locations Agents Sessions Entity Types Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-sessions-entity-types-get">Locations Agents Sessions Entity Types Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-sessions-entity-types-list">Locations Agents Sessions Entity Types List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-sessions-entity-types-patch">Locations Agents Sessions Entity Types Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-sessions-fulfill-intent">Locations Agents Sessions Fulfill Intent</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-sessions-match-intent">Locations Agents Sessions Match Intent</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-batch-delete">Locations Agents Test Cases Batch Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-batch-run">Locations Agents Test Cases Batch Run</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-calculate-coverage">Locations Agents Test Cases Calculate Coverage</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-create">Locations Agents Test Cases Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-export">Locations Agents Test Cases Export</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-get">Locations Agents Test Cases Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-import">Locations Agents Test Cases Import</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-list">Locations Agents Test Cases List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-patch">Locations Agents Test Cases Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-results-get">Locations Agents Test Cases Results Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-results-list">Locations Agents Test Cases Results List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-test-cases-run">Locations Agents Test Cases Run</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-validate">Locations Agents Validate</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-webhooks-create">Locations Agents Webhooks Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-webhooks-delete">Locations Agents Webhooks Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-webhooks-get">Locations Agents Webhooks Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-webhooks-list">Locations Agents Webhooks List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-agents-webhooks-patch">Locations Agents Webhooks Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-operations-cancel">Locations Operations Cancel</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-operations-get">Locations Operations Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-operations-list">Locations Operations List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-security-settings-create">Locations Security Settings Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-security-settings-delete">Locations Security Settings Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-security-settings-get">Locations Security Settings Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-security-settings-list">Locations Security Settings List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-security-settings-patch">Locations Security Settings Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_operations-cancel">Operations Cancel</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_operations-get">Operations Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_operations-list">Operations List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href=".."></a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
<li>Locations Agents Sessions Detect Intent</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/master/gen/dialogflow3-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See <a href="https://cloud.google.com/dialogflow/cx/docs/concept/version">Versions and environments</a>.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
|
|
<li><em>https://www.googleapis.com/auth/dialogflow</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>dialogflow3 --scope <scope> projects locations-agents-sessions-detect-intent ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><session></strong> <em>(string)</em><ul>
|
|
<li>Required. The name of the session this query is sent to. Format: <code>projects//locations//agents//sessions/</code> or <code>projects//locations//agents//environments//sessions/</code>. If <code>Environment ID</code> is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate <code>Session ID</code>. It can be a random number or some type of session identifiers (preferably hashed). The length of the <code>Session ID</code> must not exceed 36 characters. For more information, see the <a href="https://cloud.google.com/dialogflow/cx/docs/concept/session">sessions guide</a>. Note: Always use agent versions for production traffic. See <a href="https://cloud.google.com/dialogflow/cx/docs/concept/version">Versions and environments</a>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>GoogleCloudDialogflowCxV3DetectIntentRequest:
|
|
output-audio-config:
|
|
audio-encoding: string
|
|
sample-rate-hertz: integer
|
|
synthesize-speech-config:
|
|
effects-profile-id: [string]
|
|
pitch: number
|
|
speaking-rate: number
|
|
voice:
|
|
name: string
|
|
ssml-gender: string
|
|
volume-gain-db: number
|
|
query-input:
|
|
audio:
|
|
audio: string
|
|
config:
|
|
audio-encoding: string
|
|
enable-word-info: boolean
|
|
model: string
|
|
model-variant: string
|
|
phrase-hints: [string]
|
|
sample-rate-hertz: integer
|
|
single-utterance: boolean
|
|
dtmf:
|
|
digits: string
|
|
finish-digit: string
|
|
event:
|
|
event: string
|
|
intent:
|
|
intent: string
|
|
language-code: string
|
|
text:
|
|
text: string
|
|
query-params:
|
|
analyze-query-text-sentiment: boolean
|
|
current-page: string
|
|
disable-webhook: boolean
|
|
geo-location:
|
|
latitude: number
|
|
longitude: number
|
|
time-zone: string
|
|
webhook-headers: { string: string }
|
|
|
|
</code></pre>
|
|
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r .output-audio-config audio-encoding=consetetur</code><ul>
|
|
<li>Required. Audio encoding of the synthesized audio content.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>sample-rate-hertz=82</code><ul>
|
|
<li>Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>synthesize-speech-config effects-profile-id=sed</code><ul>
|
|
<li>Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pitch=0.4962661437411874</code><ul>
|
|
<li>Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>speaking-rate=0.015843876813973368</code><ul>
|
|
<li>Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>voice name=magna</code><ul>
|
|
<li>Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to <a href="https://cloud.google.com/text-to-speech/docs/voices">Supported voices and languages</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>ssml-gender=diam</code></p>
|
|
<ul>
|
|
<li>Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. volume-gain-db=0.9777863627696993</code></p>
|
|
<ul>
|
|
<li>Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...query-input.audio audio=et</code></p>
|
|
<ul>
|
|
<li>The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both <code>config</code> and <code>audio</code> must be provided. For streaming audio detect intent, <code>config</code> must be provided in the first request and <code>audio</code> must be provided in all following requests.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>config audio-encoding=sanctus</code><ul>
|
|
<li>Required. Audio encoding of the audio content to process.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enable-word-info=true</code><ul>
|
|
<li>Optional. If <code>true</code>, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>model=sed</code><ul>
|
|
<li>Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to <a href="https://cloud.google.com/speech-to-text/docs/basics#select-model">Cloud Speech API documentation</a> for more details.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>model-variant=est</code><ul>
|
|
<li>Optional. Which variant of the Speech model to use.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>phrase-hints=takimata</code><ul>
|
|
<li>Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See <a href="https://cloud.google.com/speech-to-text/docs/basics#phrase-hints">the Cloud Speech documentation</a> for more details.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>sample-rate-hertz=2</code><ul>
|
|
<li>Sample rate (in Hertz) of the audio content sent in the query. Refer to <a href="https://cloud.google.com/speech-to-text/docs/basics">Cloud Speech API documentation</a> for more details.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>single-utterance=false</code></p>
|
|
<ul>
|
|
<li>Optional. If <code>false</code> (default), recognition does not cease until the client closes the stream. If <code>true</code>, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...dtmf digits=at</code></p>
|
|
<ul>
|
|
<li>The dtmf digits.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>finish-digit=erat</code></p>
|
|
<ul>
|
|
<li>The finish digit (if any).</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..event event=justo</code></p>
|
|
<ul>
|
|
<li>Name of the event.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..intent intent=ipsum</code></p>
|
|
<ul>
|
|
<li>Required. The unique identifier of the intent. Format: <code>projects//locations//agents//intents/</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. language-code=accusam</code></p>
|
|
<ul>
|
|
<li>Required. The language of the input. See <a href="https://cloud.google.com/dialogflow/cx/docs/reference/language">Language Support</a> for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>text text=dolores</code></p>
|
|
<ul>
|
|
<li>Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...query-params analyze-query-text-sentiment=false</code></p>
|
|
<ul>
|
|
<li>Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>current-page=no</code><ul>
|
|
<li>The unique identifier of the page to override the current page in the session. Format: <code>projects//locations//agents//pages/</code>. If <code>current_page</code> is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>disable-webhook=true</code><ul>
|
|
<li>Whether to disable webhook calls for this request.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>geo-location latitude=0.4609587543650727</code><ul>
|
|
<li>The latitude in degrees. It must be in the range [-90.0, +90.0].</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>longitude=0.8051858500096339</code></p>
|
|
<ul>
|
|
<li>The longitude in degrees. It must be in the range [-180.0, +180.0].</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. time-zone=stet</code></p>
|
|
<ul>
|
|
<li>The time zone of this conversational query from the <a href="https://www.iana.org/time-zones">time zone database</a>, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>webhook-headers=key=gubergren</code><ul>
|
|
<li>This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../projects_locations-agents-sessions-entity-types-create" class="btn btn-neutral float-right" title="Locations Agents Sessions Entity Types Create"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../projects_locations-agents-restore" class="btn btn-neutral" title="Locations Agents Restore"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
<!-- Copyright etc -->
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
<span><a href="../projects_locations-agents-restore" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../projects_locations-agents-sessions-entity-types-create" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |