google.ai.generativelanguage.FileServiceClient

An API for uploading and managing files.

credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Optional[Union[str,FileServiceTransport,Callable[..., FileServiceTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the FileServiceTransport constructor. If set to None, a transport is chosen automatically.

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

Custom options for the client.

  1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

  2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

  3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

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.

google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

api_endpoint Return the API endpoint used by the client instance.
transport Returns the transport used by the client instance.
universe_domain Return the universe domain used by the client instance.

Methods

create_file

View source

Creates a File.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   <a href="https://googleapis.dev/python/google-api-core/latest/client_options.html">https://googleapis.dev/python/google-api-core/latest/client_options.html</a>
from google.ai import generativelanguage_v1beta

def sample_create_file():
    # Create a client
    client = generativelanguage_v1beta.FileServiceClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta.CreateFileRequest(
    )

    # Make the request
    response = client.create_file(request=request)

    # Handle the response
    print(response)

Args
request Union[google.ai.generativelanguage.CreateFileRequest, dict]

The request object. Request for CreateFile.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
google.ai.generativelanguage.CreateFileResponse Response for CreateFile.

delete_file

View source

Deletes the File.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   <a href="https://googleapis.dev/python/google-api-core/latest/client_options.html">https://googleapis.dev/python/google-api-core/latest/client_options.html</a>
from google.ai import generativelanguage_v1beta

def sample_delete_file():
    # Create a client
    client = generativelanguage_v1beta.FileServiceClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta.DeleteFileRequest(
        name="name_value",
    )

    # Make the request
    client.delete_file(request=request)

Args
request Union[google.ai.generativelanguage.DeleteFileRequest, dict]

The request object. Request for DeleteFile.

name str

Required. The name of the File to delete. Example: files/abc-123

This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

from_service_account_file

View source

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

Args
filename str

The path to the service account private key json file.

args Additional arguments to pass to the constructor.
kwargs Additional arguments to pass to the constructor.

Returns
FileServiceClient The constructed client.

from_service_account_info

View source

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

Args
info dict

The service account private key info.

args Additional arguments to pass to the constructor.
kwargs Additional arguments to pass to the constructor.

Returns
FileServiceClient The constructed client.

from_service_account_json

View source

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

Args
filename str

The path to the service account private key json file.

args Additional arguments to pass to the constructor.
kwargs Additional arguments to pass to the constructor.

Returns
FileServiceClient The constructed client.

get_file

View source

Gets the metadata for the given File.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   <a href="https://googleapis.dev/python/google-api-core/latest/client_options.html">https://googleapis.dev/python/google-api-core/latest/client_options.html</a>
from google.ai import generativelanguage_v1beta

def sample_get_file():
    # Create a client
    client = generativelanguage_v1beta.FileServiceClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta.GetFileRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_file(request=request)

    # Handle the response
    print(response)

Args
request Union[google.ai.generativelanguage.GetFileRequest, dict]

The request object. Request for GetFile.

name str

Required. The name of the File to get. Example: files/abc-123

This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
google.ai.generativelanguage.File A file uploaded to the API.

get_mtls_endpoint_and_cert_source

View source

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114

Args
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns
Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the client cert source to use.

Raises
google.auth.exceptions.MutualTLSChannelError If any errors happen.

list_files

View source

Lists the metadata for File\ s owned by the requesting project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   <a href="https://googleapis.dev/python/google-api-core/latest/client_options.html">https://googleapis.dev/python/google-api-core/latest/client_options.html</a>
from google.ai import generativelanguage_v1beta

def sample_list_files():
    # Create a client
    client = generativelanguage_v1beta.FileServiceClient()

    # Initialize request argument(s)
    request = generativelanguage_v1beta.ListFilesRequest(
    )

    # Make the request
    page_result = client.list_files(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Args
request Union[google.ai.generativelanguage.ListFilesRequest, dict]

The request object. Request for ListFiles.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
google.ai.generativelanguage_v1beta.services.file_service.pagers.ListFilesPager Response for ListFiles.

Iterating over this object will yield results and resolve additional pages automatically.

__enter__

View source

__exit__

View source

Releases underlying transport's resources.

.. warning:: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

DEFAULT_ENDPOINT 'generativelanguage.googleapis.com'
DEFAULT_MTLS_ENDPOINT 'generativelanguage.mtls.googleapis.com'