Skip to content

get_foundation_model_availability

Operation

get_foundation_model_availability

get_foundation_model_availability(request: GetFoundationModelAvailabilityInput | GetFoundationModelAvailabilityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFoundationModelAvailabilityInputDict]) -> GetFoundationModelAvailabilityOutput

Get information about the Foundation model availability.

Parameters:

Name Type Description Default
request GetFoundationModelAvailabilityInput | GetFoundationModelAvailabilityInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetFoundationModelAvailabilityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFoundationModelAvailabilityOutput

An instance of GetFoundationModelAvailabilityOutput.

get_foundation_model_availability async

get_foundation_model_availability(request: GetFoundationModelAvailabilityInput | GetFoundationModelAvailabilityInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFoundationModelAvailabilityInputDict]) -> GetFoundationModelAvailabilityOutput

Get information about the Foundation model availability.

Parameters:

Name Type Description Default
request GetFoundationModelAvailabilityInput | GetFoundationModelAvailabilityInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetFoundationModelAvailabilityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFoundationModelAvailabilityOutput

An instance of GetFoundationModelAvailabilityOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetFoundationModelAvailabilityInputDict

Bases: TypedDict

Dictionary form of GetFoundationModelAvailabilityInput.

Attributes

model_id instance-attribute
model_id: Required[str]

The model Id of the foundation model.

GetFoundationModelAvailabilityInput dataclass

Bases: _SerdeShape

Dataclass for GetFoundationModelAvailabilityInput structure.

Attributes

model_id class-attribute instance-attribute
model_id: str | None = ...

The model Id of the foundation model.

Output

GetFoundationModelAvailabilityOutput dataclass

Bases: _SerdeShape

Dataclass for GetFoundationModelAvailabilityOutput structure.

Attributes

agreement_availability instance-attribute
agreement_availability: AgreementAvailability

Agreement availability.

authorization_status instance-attribute
authorization_status: str

Authorization status.

entitlement_availability instance-attribute
entitlement_availability: str

Entitlement availability.

model_id instance-attribute
model_id: str

The model Id of the foundation model.

region_availability instance-attribute
region_availability: str

Region availability.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.