Documentation

Google_Service_Dialogflow_Resource_ProjectsAgentEntityTypes 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
batchDelete()  : Google_Service_Dialogflow_GoogleLongrunningOperation
Deletes entity types in the specified agent. Operation (entityTypes.batchDelete)
batchUpdate()  : Google_Service_Dialogflow_GoogleLongrunningOperation
Updates/Creates multiple entity types in the specified agent. Operation (entityTypes.batchUpdate)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Dialogflow_GoogleCloudDialogflowV2EntityType
Creates an entity type in the specified agent. (entityTypes.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Dialogflow_GoogleProtobufEmpty
Deletes the specified entity type. (entityTypes.delete)
get()  : Google_Service_Dialogflow_GoogleCloudDialogflowV2EntityType
Retrieves the specified entity type. (entityTypes.get)
listProjectsAgentEntityTypes()  : Google_Service_Dialogflow_GoogleCloudDialogflowV2ListEntityTypesResponse
Returns the list of all entity types in the specified agent.
patch()  : Google_Service_Dialogflow_GoogleCloudDialogflowV2EntityType
Updates the specified entity type. (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

batchDelete()

Deletes entity types in the specified agent. Operation (entityTypes.batchDelete)

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

Required. The name of the agent to delete all entities types for. Format: projects//agent.

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

Optional parameters.

Return values
Google_Service_Dialogflow_GoogleLongrunningOperation

batchUpdate()

Updates/Creates multiple entity types in the specified agent. Operation (entityTypes.batchUpdate)

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

Required. The name of the agent to update or create entity types in. Format: projects//agent.

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

Optional parameters.

Return values
Google_Service_Dialogflow_GoogleLongrunningOperation

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 an entity type in the specified agent. (entityTypes.create)

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

Required. The agent to create a entity type for. Format: projects//agent.

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

Optional parameters.

Tags
opt_param

string languageCode Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- entity).

Return values
Google_Service_Dialogflow_GoogleCloudDialogflowV2EntityType

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

get()

Retrieves the specified entity type. (entityTypes.get)

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

Required. The name of the entity type. Format: projects//agent/entityTypes/.

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

Optional parameters.

Tags
opt_param

string languageCode Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- entity).

Return values
Google_Service_Dialogflow_GoogleCloudDialogflowV2EntityType

listProjectsAgentEntityTypes()

Returns the list of all entity types in the specified agent.

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

(entityTypes.listProjectsAgentEntityTypes)

Parameters
$parent : string

Required. The agent to list all entity types from. Format: projects//agent.

$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 languageCode Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- entity).

opt_param

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

Return values
Google_Service_Dialogflow_GoogleCloudDialogflowV2ListEntityTypesResponse

patch()

Updates the specified entity type. (entityTypes.patch)

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

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.

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

Optional parameters.

Tags
opt_param

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

opt_param

string languageCode Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- entity).

Return values
Google_Service_Dialogflow_GoogleCloudDialogflowV2EntityType

convertToArrayAndStripNulls()

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

Search results