sessions
Creates, updates, deletes, gets or lists a sessions
resource.
Overview
Name | sessions |
Type | Resource |
Id | google.dialogflow.sessions |
Fields
The following fields are returned by SELECT
queries:
SELECT
not supported for this resource, use SHOW METHODS
to view available operations for the resource.
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
projects_locations_agents_sessions_detect_intent | exec | projectsId , locationsId , agentsId , sessionsId | 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 Versions and environments. | |
projects_locations_agents_sessions_server_streaming_detect_intent | exec | projectsId , locationsId , agentsId , sessionsId | Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request. | |
projects_locations_agents_sessions_match_intent | exec | projectsId , locationsId , agentsId , sessionsId | Returns preliminary intent match results, doesn't change the session status. | |
projects_locations_agents_sessions_fulfill_intent | exec | projectsId , locationsId , agentsId , sessionsId | Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined. | |
projects_locations_agents_sessions_submit_answer_feedback | exec | projectsId , locationsId , agentsId , sessionsId | Updates the feedback received from the user for a single turn of the bot response. | |
projects_locations_agents_environments_sessions_detect_intent | exec | projectsId , locationsId , agentsId , environmentsId , sessionsId | 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 Versions and environments. | |
projects_locations_agents_environments_sessions_server_streaming_detect_intent | exec | projectsId , locationsId , agentsId , environmentsId , sessionsId | Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request. | |
projects_locations_agents_environments_sessions_match_intent | exec | projectsId , locationsId , agentsId , environmentsId , sessionsId | Returns preliminary intent match results, doesn't change the session status. | |
projects_locations_agents_environments_sessions_fulfill_intent | exec | projectsId , locationsId , agentsId , environmentsId , sessionsId | Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
agentsId | string | |
environmentsId | string | |
locationsId | string | |
projectsId | string | |
sessionsId | string |
Lifecycle Methods
- projects_locations_agents_sessions_detect_intent
- projects_locations_agents_sessions_server_streaming_detect_intent
- projects_locations_agents_sessions_match_intent
- projects_locations_agents_sessions_fulfill_intent
- projects_locations_agents_sessions_submit_answer_feedback
- projects_locations_agents_environments_sessions_detect_intent
- projects_locations_agents_environments_sessions_server_streaming_detect_intent
- projects_locations_agents_environments_sessions_match_intent
- projects_locations_agents_environments_sessions_fulfill_intent
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 Versions and environments.
EXEC google.dialogflow.sessions.projects_locations_agents_sessions_detect_intent
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@sessionsId='{{ sessionsId }}' --required
@@json=
'{
"queryParams": "{{ queryParams }}",
"queryInput": "{{ queryInput }}",
"outputAudioConfig": "{{ outputAudioConfig }}"
}';
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.
EXEC google.dialogflow.sessions.projects_locations_agents_sessions_server_streaming_detect_intent
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@sessionsId='{{ sessionsId }}' --required
@@json=
'{
"queryParams": "{{ queryParams }}",
"queryInput": "{{ queryInput }}",
"outputAudioConfig": "{{ outputAudioConfig }}"
}';
Returns preliminary intent match results, doesn't change the session status.
EXEC google.dialogflow.sessions.projects_locations_agents_sessions_match_intent
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@sessionsId='{{ sessionsId }}' --required
@@json=
'{
"queryParams": "{{ queryParams }}",
"queryInput": "{{ queryInput }}",
"persistParameterChanges": {{ persistParameterChanges }}
}';
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
EXEC google.dialogflow.sessions.projects_locations_agents_sessions_fulfill_intent
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@sessionsId='{{ sessionsId }}' --required
@@json=
'{
"matchIntentRequest": "{{ matchIntentRequest }}",
"match": "{{ match }}",
"outputAudioConfig": "{{ outputAudioConfig }}"
}';
Updates the feedback received from the user for a single turn of the bot response.
EXEC google.dialogflow.sessions.projects_locations_agents_sessions_submit_answer_feedback
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@sessionsId='{{ sessionsId }}' --required
@@json=
'{
"responseId": "{{ responseId }}",
"answerFeedback": "{{ answerFeedback }}",
"updateMask": "{{ updateMask }}"
}';
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 Versions and environments.
EXEC google.dialogflow.sessions.projects_locations_agents_environments_sessions_detect_intent
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@environmentsId='{{ environmentsId }}' --required,
@sessionsId='{{ sessionsId }}' --required
@@json=
'{
"queryParams": "{{ queryParams }}",
"queryInput": "{{ queryInput }}",
"outputAudioConfig": "{{ outputAudioConfig }}"
}';
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.
EXEC google.dialogflow.sessions.projects_locations_agents_environments_sessions_server_streaming_detect_intent
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@environmentsId='{{ environmentsId }}' --required,
@sessionsId='{{ sessionsId }}' --required
@@json=
'{
"queryParams": "{{ queryParams }}",
"queryInput": "{{ queryInput }}",
"outputAudioConfig": "{{ outputAudioConfig }}"
}';
Returns preliminary intent match results, doesn't change the session status.
EXEC google.dialogflow.sessions.projects_locations_agents_environments_sessions_match_intent
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@environmentsId='{{ environmentsId }}' --required,
@sessionsId='{{ sessionsId }}' --required
@@json=
'{
"queryParams": "{{ queryParams }}",
"queryInput": "{{ queryInput }}",
"persistParameterChanges": {{ persistParameterChanges }}
}';
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
EXEC google.dialogflow.sessions.projects_locations_agents_environments_sessions_fulfill_intent
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@environmentsId='{{ environmentsId }}' --required,
@sessionsId='{{ sessionsId }}' --required
@@json=
'{
"matchIntentRequest": "{{ matchIntentRequest }}",
"match": "{{ match }}",
"outputAudioConfig": "{{ outputAudioConfig }}"
}';