All Implemented Interfaces:: com.openai.core.Params


public final class SessionCreateParams
 implements Params

Create a ChatKit session

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`SessionCreateParams.Builder`	A builder for SessionCreateParams.
`public final class`	`SessionCreateParams.Body`	Parameters for provisioning a new ChatKit session.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`user()`	A free-form string that identifies your end user; ensures this Session can access other objects that have the same `user` scope.
`final ChatSessionWorkflowParam`	`workflow()`	Workflow that powers the session.
`final Optional<ChatSessionChatKitConfigurationParam>`	`chatkitConfiguration()`	Optional overrides for ChatKit runtime configuration features
`final Optional<ChatSessionExpiresAfterParam>`	`expiresAfter()`	Optional override for session expiration timing in seconds from creation.
`final Optional<ChatSessionRateLimitsParam>`	`rateLimits()`	Optional override for per-minute request limits.
`final JsonField<String>`	`_user()`	Returns the raw JSON value of user.
`final JsonField<ChatSessionWorkflowParam>`	`_workflow()`	Returns the raw JSON value of workflow.
`final JsonField<ChatSessionChatKitConfigurationParam>`	`_chatkitConfiguration()`	Returns the raw JSON value of chatkitConfiguration.
`final JsonField<ChatSessionExpiresAfterParam>`	`_expiresAfter()`	Returns the raw JSON value of expiresAfter.
`final JsonField<ChatSessionRateLimitsParam>`	`_rateLimits()`	Returns the raw JSON value of rateLimits.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final SessionCreateParams.Builder`	`toBuilder()`
`final SessionCreateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static SessionCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of SessionCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - user
```
 final String user()
```
    A free-form string that identifies your end user; ensures this Session can access other objects that have the same user scope.
  - workflow
```
 final ChatSessionWorkflowParam workflow()
```
    Workflow that powers the session.
  - chatkitConfiguration
```
 final Optional<ChatSessionChatKitConfigurationParam> chatkitConfiguration()
```
    Optional overrides for ChatKit runtime configuration features
  - expiresAfter
```
 final Optional<ChatSessionExpiresAfterParam> expiresAfter()
```
    Optional override for session expiration timing in seconds from creation. Defaults to 10 minutes.
  - rateLimits
```
 final Optional<ChatSessionRateLimitsParam> rateLimits()
```
    Optional override for per-minute request limits. When omitted, defaults to 10.
  - _user
```
 final JsonField<String> _user()
```
    Returns the raw JSON value of user.
    Unlike user, this method doesn't throw if the JSON field has an unexpected type.
  - _workflow
```
 final JsonField<ChatSessionWorkflowParam> _workflow()
```
    Returns the raw JSON value of workflow.
    Unlike workflow, this method doesn't throw if the JSON field has an unexpected type.
  - _chatkitConfiguration
```
 final JsonField<ChatSessionChatKitConfigurationParam> _chatkitConfiguration()
```
    Returns the raw JSON value of chatkitConfiguration.
    Unlike chatkitConfiguration, this method doesn't throw if the JSON field has an unexpected type.
  - _expiresAfter
```
 final JsonField<ChatSessionExpiresAfterParam> _expiresAfter()
```
    Returns the raw JSON value of expiresAfter.
    Unlike expiresAfter, this method doesn't throw if the JSON field has an unexpected type.
  - _rateLimits
```
 final JsonField<ChatSessionRateLimitsParam> _rateLimits()
```
    Returns the raw JSON value of rateLimits.
    Unlike rateLimits, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final SessionCreateParams.Builder toBuilder()
```
  - _body
```
 final SessionCreateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static SessionCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of SessionCreateParams.
    The following fields are required:
    .user() .workflow()

Class SessionCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

user

workflow

chatkitConfiguration

expiresAfter

rateLimits

_user

_workflow

_chatkitConfiguration

_expiresAfter

_rateLimits

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder