Skip to content

create_foundation_model_agreement

Operation

create_foundation_model_agreement

create_foundation_model_agreement(request: CreateFoundationModelAgreementInput | CreateFoundationModelAgreementInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateFoundationModelAgreementInputDict]) -> CreateFoundationModelAgreementOutput

Request a model access agreement for the specified model.

Parameters:

Name Type Description Default
request CreateFoundationModelAgreementInput | CreateFoundationModelAgreementInputDict | 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[CreateFoundationModelAgreementInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateFoundationModelAgreementOutput

An instance of CreateFoundationModelAgreementOutput.

create_foundation_model_agreement async

create_foundation_model_agreement(request: CreateFoundationModelAgreementInput | CreateFoundationModelAgreementInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateFoundationModelAgreementInputDict]) -> CreateFoundationModelAgreementOutput

Request a model access agreement for the specified model.

Parameters:

Name Type Description Default
request CreateFoundationModelAgreementInput | CreateFoundationModelAgreementInputDict | 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[CreateFoundationModelAgreementInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateFoundationModelAgreementOutput

An instance of CreateFoundationModelAgreementOutput.

Input

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

CreateFoundationModelAgreementInputDict

Bases: TypedDict

Dictionary form of CreateFoundationModelAgreementInput.

Attributes

model_id instance-attribute
model_id: Required[str]

Model Id of the model for the access request.

offer_token instance-attribute
offer_token: Required[str]

An offer token encapsulates the information for an offer.

CreateFoundationModelAgreementInput dataclass

Bases: _SerdeShape

Dataclass for CreateFoundationModelAgreementInput structure.

Attributes

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

Model Id of the model for the access request.

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

An offer token encapsulates the information for an offer.

Output

CreateFoundationModelAgreementOutput dataclass

Bases: _SerdeShape

Dataclass for CreateFoundationModelAgreementOutput structure.

Attributes

model_id instance-attribute
model_id: str

Model Id of the model for the access request.

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.