Documentation

Google_Service_Dialogflow_Resource_ProjectsAgentEnvironmentsUsersSessionsEntityTypes extends Google_Service_Resource
in package

The "entityTypes" collection of methods.

Typical usage is: $dialogflowService = new Google_Service_Dialogflow(...); $entityTypes = $dialogflowService->entityTypes;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType
Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. (entityTypes.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Dialogflow_GoogleProtobufEmpty
Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. (entityTypes.delete)
get()  : Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType
Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. (entityTypes.get)
listProjectsAgentEnvironmentsUsersSessionsEntityTypes()  : Google_Service_Dialogflow_GoogleCloudDialogflowV2ListSessionEntityTypesResponse
Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.
patch()  : Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType
Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. (entityTypes.patch)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. (entityTypes.create)

public create(string $parent, Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType
Parameters
$parent : string

Required. The session to create a session entity type for. Format: projects//agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

$postBody : Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. (entityTypes.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dialogflow_GoogleProtobufEmpty
Parameters
$name : string

Required. The name of the entity type to delete. Format: projects//agent/sessions//entityTypes/ or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dialogflow_GoogleProtobufEmpty

get()

Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. (entityTypes.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType
Parameters
$name : string

Required. The name of the session entity type. Format: projects//agent/sessions//entityTypes/ or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType

listProjectsAgentEnvironmentsUsersSessionsEntityTypes()

Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

public listProjectsAgentEnvironmentsUsersSessionsEntityTypes(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dialogflow_GoogleCloudDialogflowV2ListSessionEntityTypesResponse

(entityTypes.listProjectsAgentEnvironmentsUsersSessionsEntityTypes)

Parameters
$parent : string

Required. The session to list all session entity types from. Format: projects//agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

opt_param

string pageToken Optional. The next_page_token value returned from a previous list request.

Return values
Google_Service_Dialogflow_GoogleCloudDialogflowV2ListSessionEntityTypesResponse

patch()

Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. (entityTypes.patch)

public patch(string $name, Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType
Parameters
$name : string

Required. The unique identifier of this session entity type. Format: projects//agent/sessions//entityTypes/, or projects//agent/environments//users//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

$postBody : Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Optional. The mask to control which fields get updated.

Return values
Google_Service_Dialogflow_GoogleCloudDialogflowV2SessionEntityType

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results