Class CompletionClient (0.5.0)

CompletionClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

A service handles auto completion.

Methods

CompletionClient

CompletionClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters
NameDescription
channel grpc.Channel

DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.

credentials google.auth.credentials.Credentials

The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.

client_config dict

DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

client_options Union[dict, google.api_core.client_options.ClientOptions]

Client options used to set user options on the client. API Endpoint should be set through client_options.

company_path

company_path(project, tenant, company)

Return a fully-qualified company string.

company_without_tenant_path

company_without_tenant_path(project, company)

Return a fully-qualified company_without_tenant string.

complete_query

complete_query(parent, query, page_size, language_codes=None, company=None, scope=None, type_=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.CompletionClient()

parent = client.tenant_path('[PROJECT]', '[TENANT]')

TODO: Initialize query:

query = ''

TODO: Initialize page_size:

page_size = 0

response = client.complete_query(parent, query, page_size)

Parameters
NameDescription
parent str

Required. Resource name of tenant the completion is performed within. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, the default tenant is used, for example, "projects/foo".

query str

Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

page_size int

Required. Completion result count. The maximum allowed page size is 10.

language_codes list[str]

The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages https://tools.ietf.org/html/bcp47__. The maximum number of allowed characters is 255.

company str

If provided, restricts completion to specified company. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used, for example, "projects/foo".

scope CompletionScope

The scope of the completion. The defaults is CompletionScope.PUBLIC.

type_ CompletionType

The completion topic. The default is CompletionType.COMBINED.

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
CompletionClientThe constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
CompletionClientThe constructed client.

project_path

project_path(project)

Return a fully-qualified project string.

tenant_path

tenant_path(project, tenant)

Return a fully-qualified tenant string.