Class ModelServiceClient (2.30.0-rc)

Provides methods for getting metadata information about Generative Models.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ModelServiceClient(ModelServiceClient const &)

Copy and move support

Parameter
Name	Description
	`ModelServiceClient const &`

ModelServiceClient(ModelServiceClient &&)

Copy and move support

Parameter
Name	Description
	`ModelServiceClient &&`

ModelServiceClient(std::shared_ptr< ModelServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< ModelServiceConnection >`
`opts`	`Options`

Operators

operator=(ModelServiceClient const &)

Copy and move support

Parameter
Name	Description
	`ModelServiceClient const &`

Returns
Type	Description
`ModelServiceClient &`

operator=(ModelServiceClient &&)

Copy and move support

Parameter
Name	Description
	`ModelServiceClient &&`

Returns
Type	Description
`ModelServiceClient &`

Functions

GetModel(std::string const &, Options)

Gets information about a specific Model such as its version number, token limits, parameters and other metadata.

Refer to the Gemini models guide for detailed model information.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the model. This name should match a model name returned by the `ListModels` method. Format: `models/{model}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::ai::generativelanguage::v1::Model >`	the result of the RPC. The response message type (google.ai.generativelanguage.v1.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetModel(google::ai::generativelanguage::v1::GetModelRequest const &, Options)

Gets information about a specific Model such as its version number, token limits, parameters and other metadata.

Refer to the Gemini models guide for detailed model information.

Parameters
Name	Description
`request`	`google::ai::generativelanguage::v1::GetModelRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.ai.generativelanguage.v1.GetModelRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::ai::generativelanguage::v1::Model >`	the result of the RPC. The response message type (google.ai.generativelanguage.v1.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListModels(std::int32_t, std::string const &, Options)

Lists the Models available through the Gemini API.

Parameters
Name	Description
`page_size`	`std::int32_t` The maximum number of `Models` to return (per page). If unspecified, 50 models will be returned per page. This method returns at most 1000 models per page, even if you pass a larger page_size.
`page_token`	`std::string const &` A page token, received from a previous `ListModels` call. Provide the `page_token` returned by one request as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListModels` must match the call that provided the page token.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::ai::generativelanguage::v1::Model >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.ai.generativelanguage.v1.Model, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListModels(google::ai::generativelanguage::v1::ListModelsRequest, Options)

Lists the Models available through the Gemini API.

Parameters
Name	Description
`request`	`google::ai::generativelanguage::v1::ListModelsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.ai.generativelanguage.v1.ListModelsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::ai::generativelanguage::v1::Model >