v1

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 5, 2024 License: Apache-2.0 Imports: 22 Imported by: 1

README

Go API client for v1

API for interacting with AI models from within Confluent Cloud.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./v1"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.confluent.cloud

Class Method HTTP request Description
AvailabilitiesAiV1Api GetAiV1Availability Get /ai/v1/availability Read the organization's ai-assistant setting.
ChatCompletionsAiV1Api GetAiV1ChatCompletion Options /ai/v1/chat-completions Read a Chat Completion
ChatCompletionsAiV1Api QueryAiV1ChatCompletion Post /ai/v1/chat-completions Query a Chat Completion
DocCompletionsDocsAiV1Api QueryDocsAiV1DocCompletion Post /docs-ai/v1/doc-completions Query a Doc Completion
FeedbacksAiV1Api CreateAiV1ChatCompletionFeedback Post /ai/v1/chat-completions/{chat_completion_id}/feedback Create a Feedback
FeedbacksAiV1Api CreateAiV1DocCompletionFeedback Post /docs-ai/v1/doc-completions/{doc_completion_id}/feedback Create a Feedback
OrgPreferencesAiV1Api GetAiV1OrgPreference Get /ai/v1/org-preferences Read the organization's ai-assistant setting in org-preferences.
OrgPreferencesAiV1Api UpdateAiV1OrgPreference Patch /ai/v1/org-preferences Set the organization's ai-assistant setting in org-preferences.

Documentation For Models

Documentation For Authorization

cloud-api-key
  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author of this repo

api-team@confluent.io

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient

type APIClient struct {
	AvailabilitiesAiV1Api AvailabilitiesAiV1Api

	ChatCompletionsAiV1Api ChatCompletionsAiV1Api

	DocCompletionsDocsAiV1Api DocCompletionsDocsAiV1Api

	FeedbacksAiV1Api FeedbacksAiV1Api

	OrgPreferencesAiV1Api OrgPreferencesAiV1Api
	// contains filtered or unexported fields
}

APIClient manages communication with the AI API API v0.0.1 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AiV1Availability

type AiV1Availability struct {
	// APIVersion defines the schema version of this representation of a resource.
	ApiVersion *string `json:"api_version,omitempty"`
	// Kind defines the object this REST resource represents.
	Kind *string `json:"kind,omitempty"`
	// Enabled ai-assist for the organization
	AiAssistantEnabled *bool `json:"ai_assistant_enabled,omitempty"`
}

AiV1Availability Returns '{ ai_assistant_enabled: true|false}' based on if the Confluent AI Assistant is enabled for your organization.

func NewAiV1Availability

func NewAiV1Availability() *AiV1Availability

NewAiV1Availability instantiates a new AiV1Availability object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAiV1AvailabilityWithDefaults

func NewAiV1AvailabilityWithDefaults() *AiV1Availability

NewAiV1AvailabilityWithDefaults instantiates a new AiV1Availability object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AiV1Availability) GetAiAssistantEnabled

func (o *AiV1Availability) GetAiAssistantEnabled() bool

GetAiAssistantEnabled returns the AiAssistantEnabled field value if set, zero value otherwise.

func (*AiV1Availability) GetAiAssistantEnabledOk

func (o *AiV1Availability) GetAiAssistantEnabledOk() (*bool, bool)

GetAiAssistantEnabledOk returns a tuple with the AiAssistantEnabled field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1Availability) GetApiVersion

func (o *AiV1Availability) GetApiVersion() string

GetApiVersion returns the ApiVersion field value if set, zero value otherwise.

func (*AiV1Availability) GetApiVersionOk

func (o *AiV1Availability) GetApiVersionOk() (*string, bool)

GetApiVersionOk returns a tuple with the ApiVersion field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1Availability) GetKind

func (o *AiV1Availability) GetKind() string

GetKind returns the Kind field value if set, zero value otherwise.

func (*AiV1Availability) GetKindOk

func (o *AiV1Availability) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1Availability) HasAiAssistantEnabled

func (o *AiV1Availability) HasAiAssistantEnabled() bool

HasAiAssistantEnabled returns a boolean if a field has been set.

func (*AiV1Availability) HasApiVersion

func (o *AiV1Availability) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*AiV1Availability) HasKind

func (o *AiV1Availability) HasKind() bool

HasKind returns a boolean if a field has been set.

func (AiV1Availability) MarshalJSON

func (o AiV1Availability) MarshalJSON() ([]byte, error)

func (*AiV1Availability) Redact

func (o *AiV1Availability) Redact()

Redact resets all sensitive fields to their zero value.

func (*AiV1Availability) SetAiAssistantEnabled

func (o *AiV1Availability) SetAiAssistantEnabled(v bool)

SetAiAssistantEnabled gets a reference to the given bool and assigns it to the AiAssistantEnabled field.

func (*AiV1Availability) SetApiVersion

func (o *AiV1Availability) SetApiVersion(v string)

SetApiVersion gets a reference to the given string and assigns it to the ApiVersion field.

func (*AiV1Availability) SetKind

func (o *AiV1Availability) SetKind(v string)

SetKind gets a reference to the given string and assigns it to the Kind field.

type AiV1ChatCompletionsHistory

type AiV1ChatCompletionsHistory struct {
	// Question for the AI assistant.
	Question *string `json:"question,omitempty"`
	// Markdown-formatted answer from the AI assistant.
	Answer *string `json:"answer,omitempty"`
}

AiV1ChatCompletionsHistory A question and answer pair from a previous interaction.

func NewAiV1ChatCompletionsHistory

func NewAiV1ChatCompletionsHistory() *AiV1ChatCompletionsHistory

NewAiV1ChatCompletionsHistory instantiates a new AiV1ChatCompletionsHistory object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAiV1ChatCompletionsHistoryWithDefaults

func NewAiV1ChatCompletionsHistoryWithDefaults() *AiV1ChatCompletionsHistory

NewAiV1ChatCompletionsHistoryWithDefaults instantiates a new AiV1ChatCompletionsHistory object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AiV1ChatCompletionsHistory) GetAnswer

func (o *AiV1ChatCompletionsHistory) GetAnswer() string

GetAnswer returns the Answer field value if set, zero value otherwise.

func (*AiV1ChatCompletionsHistory) GetAnswerOk

func (o *AiV1ChatCompletionsHistory) GetAnswerOk() (*string, bool)

GetAnswerOk returns a tuple with the Answer field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsHistory) GetQuestion

func (o *AiV1ChatCompletionsHistory) GetQuestion() string

GetQuestion returns the Question field value if set, zero value otherwise.

func (*AiV1ChatCompletionsHistory) GetQuestionOk

func (o *AiV1ChatCompletionsHistory) GetQuestionOk() (*string, bool)

GetQuestionOk returns a tuple with the Question field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsHistory) HasAnswer

func (o *AiV1ChatCompletionsHistory) HasAnswer() bool

HasAnswer returns a boolean if a field has been set.

func (*AiV1ChatCompletionsHistory) HasQuestion

func (o *AiV1ChatCompletionsHistory) HasQuestion() bool

HasQuestion returns a boolean if a field has been set.

func (AiV1ChatCompletionsHistory) MarshalJSON

func (o AiV1ChatCompletionsHistory) MarshalJSON() ([]byte, error)

func (*AiV1ChatCompletionsHistory) Redact

func (o *AiV1ChatCompletionsHistory) Redact()

Redact resets all sensitive fields to their zero value.

func (*AiV1ChatCompletionsHistory) SetAnswer

func (o *AiV1ChatCompletionsHistory) SetAnswer(v string)

SetAnswer gets a reference to the given string and assigns it to the Answer field.

func (*AiV1ChatCompletionsHistory) SetQuestion

func (o *AiV1ChatCompletionsHistory) SetQuestion(v string)

SetQuestion gets a reference to the given string and assigns it to the Question field.

type AiV1ChatCompletionsReply

type AiV1ChatCompletionsReply struct {
	// APIVersion defines the schema version of this representation of a resource.
	ApiVersion *string `json:"api_version,omitempty"`
	// Kind defines the object this REST resource represents.
	Kind *string `json:"kind,omitempty"`
	// ID is the \"natural identifier\" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted (\"time\"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace (\"space\").
	Id          *string     `json:"id,omitempty"`
	Metadata    *ObjectMeta `json:"metadata,omitempty"`
	AiSessionId *string     `json:"ai_session_id,omitempty"`
	Answer      *string     `json:"answer,omitempty"`
	Question    *string     `json:"question,omitempty"`
}

AiV1ChatCompletionsReply Reply from the AI assistant.

func NewAiV1ChatCompletionsReply

func NewAiV1ChatCompletionsReply() *AiV1ChatCompletionsReply

NewAiV1ChatCompletionsReply instantiates a new AiV1ChatCompletionsReply object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAiV1ChatCompletionsReplyWithDefaults

func NewAiV1ChatCompletionsReplyWithDefaults() *AiV1ChatCompletionsReply

NewAiV1ChatCompletionsReplyWithDefaults instantiates a new AiV1ChatCompletionsReply object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AiV1ChatCompletionsReply) GetAiSessionId

func (o *AiV1ChatCompletionsReply) GetAiSessionId() string

GetAiSessionId returns the AiSessionId field value if set, zero value otherwise.

func (*AiV1ChatCompletionsReply) GetAiSessionIdOk

func (o *AiV1ChatCompletionsReply) GetAiSessionIdOk() (*string, bool)

GetAiSessionIdOk returns a tuple with the AiSessionId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsReply) GetAnswer

func (o *AiV1ChatCompletionsReply) GetAnswer() string

GetAnswer returns the Answer field value if set, zero value otherwise.

func (*AiV1ChatCompletionsReply) GetAnswerOk

func (o *AiV1ChatCompletionsReply) GetAnswerOk() (*string, bool)

GetAnswerOk returns a tuple with the Answer field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsReply) GetApiVersion

func (o *AiV1ChatCompletionsReply) GetApiVersion() string

GetApiVersion returns the ApiVersion field value if set, zero value otherwise.

func (*AiV1ChatCompletionsReply) GetApiVersionOk

func (o *AiV1ChatCompletionsReply) GetApiVersionOk() (*string, bool)

GetApiVersionOk returns a tuple with the ApiVersion field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsReply) GetId

func (o *AiV1ChatCompletionsReply) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*AiV1ChatCompletionsReply) GetIdOk

func (o *AiV1ChatCompletionsReply) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsReply) GetKind

func (o *AiV1ChatCompletionsReply) GetKind() string

GetKind returns the Kind field value if set, zero value otherwise.

func (*AiV1ChatCompletionsReply) GetKindOk

func (o *AiV1ChatCompletionsReply) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsReply) GetMetadata

func (o *AiV1ChatCompletionsReply) GetMetadata() ObjectMeta

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*AiV1ChatCompletionsReply) GetMetadataOk

func (o *AiV1ChatCompletionsReply) GetMetadataOk() (*ObjectMeta, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsReply) GetQuestion

func (o *AiV1ChatCompletionsReply) GetQuestion() string

GetQuestion returns the Question field value if set, zero value otherwise.

func (*AiV1ChatCompletionsReply) GetQuestionOk

func (o *AiV1ChatCompletionsReply) GetQuestionOk() (*string, bool)

GetQuestionOk returns a tuple with the Question field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsReply) HasAiSessionId

func (o *AiV1ChatCompletionsReply) HasAiSessionId() bool

HasAiSessionId returns a boolean if a field has been set.

func (*AiV1ChatCompletionsReply) HasAnswer

func (o *AiV1ChatCompletionsReply) HasAnswer() bool

HasAnswer returns a boolean if a field has been set.

func (*AiV1ChatCompletionsReply) HasApiVersion

func (o *AiV1ChatCompletionsReply) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*AiV1ChatCompletionsReply) HasId

func (o *AiV1ChatCompletionsReply) HasId() bool

HasId returns a boolean if a field has been set.

func (*AiV1ChatCompletionsReply) HasKind

func (o *AiV1ChatCompletionsReply) HasKind() bool

HasKind returns a boolean if a field has been set.

func (*AiV1ChatCompletionsReply) HasMetadata

func (o *AiV1ChatCompletionsReply) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*AiV1ChatCompletionsReply) HasQuestion

func (o *AiV1ChatCompletionsReply) HasQuestion() bool

HasQuestion returns a boolean if a field has been set.

func (AiV1ChatCompletionsReply) MarshalJSON

func (o AiV1ChatCompletionsReply) MarshalJSON() ([]byte, error)

func (*AiV1ChatCompletionsReply) Redact

func (o *AiV1ChatCompletionsReply) Redact()

Redact resets all sensitive fields to their zero value.

func (*AiV1ChatCompletionsReply) SetAiSessionId

func (o *AiV1ChatCompletionsReply) SetAiSessionId(v string)

SetAiSessionId gets a reference to the given string and assigns it to the AiSessionId field.

func (*AiV1ChatCompletionsReply) SetAnswer

func (o *AiV1ChatCompletionsReply) SetAnswer(v string)

SetAnswer gets a reference to the given string and assigns it to the Answer field.

func (*AiV1ChatCompletionsReply) SetApiVersion

func (o *AiV1ChatCompletionsReply) SetApiVersion(v string)

SetApiVersion gets a reference to the given string and assigns it to the ApiVersion field.

func (*AiV1ChatCompletionsReply) SetId

func (o *AiV1ChatCompletionsReply) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*AiV1ChatCompletionsReply) SetKind

func (o *AiV1ChatCompletionsReply) SetKind(v string)

SetKind gets a reference to the given string and assigns it to the Kind field.

func (*AiV1ChatCompletionsReply) SetMetadata

func (o *AiV1ChatCompletionsReply) SetMetadata(v ObjectMeta)

SetMetadata gets a reference to the given ObjectMeta and assigns it to the Metadata field.

func (*AiV1ChatCompletionsReply) SetQuestion

func (o *AiV1ChatCompletionsReply) SetQuestion(v string)

SetQuestion gets a reference to the given string and assigns it to the Question field.

type AiV1ChatCompletionsRequest

type AiV1ChatCompletionsRequest struct {
	// APIVersion defines the schema version of this representation of a resource.
	ApiVersion *string `json:"api_version,omitempty"`
	// Kind defines the object this REST resource represents.
	Kind *string `json:"kind,omitempty"`
	// ID is the \"natural identifier\" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted (\"time\"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace (\"space\").
	Id           *string     `json:"id,omitempty"`
	Metadata     *ObjectMeta `json:"metadata,omitempty"`
	AiSessionId  *string     `json:"ai_session_id,omitempty"`
	Question     *string     `json:"question,omitempty"`
	DriftEnabled *bool       `json:"drift_enabled,omitempty"`
	// Completion objects from previous interactions.
	History *[]AiV1ChatCompletionsHistory `json:"history,omitempty"`
}

AiV1ChatCompletionsRequest Request to the AI assistant.

func NewAiV1ChatCompletionsRequest

func NewAiV1ChatCompletionsRequest() *AiV1ChatCompletionsRequest

NewAiV1ChatCompletionsRequest instantiates a new AiV1ChatCompletionsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAiV1ChatCompletionsRequestWithDefaults

func NewAiV1ChatCompletionsRequestWithDefaults() *AiV1ChatCompletionsRequest

NewAiV1ChatCompletionsRequestWithDefaults instantiates a new AiV1ChatCompletionsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AiV1ChatCompletionsRequest) GetAiSessionId

func (o *AiV1ChatCompletionsRequest) GetAiSessionId() string

GetAiSessionId returns the AiSessionId field value if set, zero value otherwise.

func (*AiV1ChatCompletionsRequest) GetAiSessionIdOk

func (o *AiV1ChatCompletionsRequest) GetAiSessionIdOk() (*string, bool)

GetAiSessionIdOk returns a tuple with the AiSessionId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsRequest) GetApiVersion

func (o *AiV1ChatCompletionsRequest) GetApiVersion() string

GetApiVersion returns the ApiVersion field value if set, zero value otherwise.

func (*AiV1ChatCompletionsRequest) GetApiVersionOk

func (o *AiV1ChatCompletionsRequest) GetApiVersionOk() (*string, bool)

GetApiVersionOk returns a tuple with the ApiVersion field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsRequest) GetDriftEnabled

func (o *AiV1ChatCompletionsRequest) GetDriftEnabled() bool

GetDriftEnabled returns the DriftEnabled field value if set, zero value otherwise.

func (*AiV1ChatCompletionsRequest) GetDriftEnabledOk

func (o *AiV1ChatCompletionsRequest) GetDriftEnabledOk() (*bool, bool)

GetDriftEnabledOk returns a tuple with the DriftEnabled field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsRequest) GetHistory

GetHistory returns the History field value if set, zero value otherwise.

func (*AiV1ChatCompletionsRequest) GetHistoryOk

GetHistoryOk returns a tuple with the History field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsRequest) GetId

GetId returns the Id field value if set, zero value otherwise.

func (*AiV1ChatCompletionsRequest) GetIdOk

func (o *AiV1ChatCompletionsRequest) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsRequest) GetKind

func (o *AiV1ChatCompletionsRequest) GetKind() string

GetKind returns the Kind field value if set, zero value otherwise.

func (*AiV1ChatCompletionsRequest) GetKindOk

func (o *AiV1ChatCompletionsRequest) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsRequest) GetMetadata

func (o *AiV1ChatCompletionsRequest) GetMetadata() ObjectMeta

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*AiV1ChatCompletionsRequest) GetMetadataOk

func (o *AiV1ChatCompletionsRequest) GetMetadataOk() (*ObjectMeta, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsRequest) GetQuestion

func (o *AiV1ChatCompletionsRequest) GetQuestion() string

GetQuestion returns the Question field value if set, zero value otherwise.

func (*AiV1ChatCompletionsRequest) GetQuestionOk

func (o *AiV1ChatCompletionsRequest) GetQuestionOk() (*string, bool)

GetQuestionOk returns a tuple with the Question field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1ChatCompletionsRequest) HasAiSessionId

func (o *AiV1ChatCompletionsRequest) HasAiSessionId() bool

HasAiSessionId returns a boolean if a field has been set.

func (*AiV1ChatCompletionsRequest) HasApiVersion

func (o *AiV1ChatCompletionsRequest) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*AiV1ChatCompletionsRequest) HasDriftEnabled

func (o *AiV1ChatCompletionsRequest) HasDriftEnabled() bool

HasDriftEnabled returns a boolean if a field has been set.

func (*AiV1ChatCompletionsRequest) HasHistory

func (o *AiV1ChatCompletionsRequest) HasHistory() bool

HasHistory returns a boolean if a field has been set.

func (*AiV1ChatCompletionsRequest) HasId

func (o *AiV1ChatCompletionsRequest) HasId() bool

HasId returns a boolean if a field has been set.

func (*AiV1ChatCompletionsRequest) HasKind

func (o *AiV1ChatCompletionsRequest) HasKind() bool

HasKind returns a boolean if a field has been set.

func (*AiV1ChatCompletionsRequest) HasMetadata

func (o *AiV1ChatCompletionsRequest) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*AiV1ChatCompletionsRequest) HasQuestion

func (o *AiV1ChatCompletionsRequest) HasQuestion() bool

HasQuestion returns a boolean if a field has been set.

func (AiV1ChatCompletionsRequest) MarshalJSON

func (o AiV1ChatCompletionsRequest) MarshalJSON() ([]byte, error)

func (*AiV1ChatCompletionsRequest) Redact

func (o *AiV1ChatCompletionsRequest) Redact()

Redact resets all sensitive fields to their zero value.

func (*AiV1ChatCompletionsRequest) SetAiSessionId

func (o *AiV1ChatCompletionsRequest) SetAiSessionId(v string)

SetAiSessionId gets a reference to the given string and assigns it to the AiSessionId field.

func (*AiV1ChatCompletionsRequest) SetApiVersion

func (o *AiV1ChatCompletionsRequest) SetApiVersion(v string)

SetApiVersion gets a reference to the given string and assigns it to the ApiVersion field.

func (*AiV1ChatCompletionsRequest) SetDriftEnabled

func (o *AiV1ChatCompletionsRequest) SetDriftEnabled(v bool)

SetDriftEnabled gets a reference to the given bool and assigns it to the DriftEnabled field.

func (*AiV1ChatCompletionsRequest) SetHistory

SetHistory gets a reference to the given []AiV1ChatCompletionsHistory and assigns it to the History field.

func (*AiV1ChatCompletionsRequest) SetId

func (o *AiV1ChatCompletionsRequest) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*AiV1ChatCompletionsRequest) SetKind

func (o *AiV1ChatCompletionsRequest) SetKind(v string)

SetKind gets a reference to the given string and assigns it to the Kind field.

func (*AiV1ChatCompletionsRequest) SetMetadata

func (o *AiV1ChatCompletionsRequest) SetMetadata(v ObjectMeta)

SetMetadata gets a reference to the given ObjectMeta and assigns it to the Metadata field.

func (*AiV1ChatCompletionsRequest) SetQuestion

func (o *AiV1ChatCompletionsRequest) SetQuestion(v string)

SetQuestion gets a reference to the given string and assigns it to the Question field.

type AiV1Feedback

type AiV1Feedback struct {
	// APIVersion defines the schema version of this representation of a resource.
	ApiVersion *string `json:"api_version,omitempty"`
	// Kind defines the object this REST resource represents.
	Kind *string `json:"kind,omitempty"`
	// ID is the \"natural identifier\" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted (\"time\"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace (\"space\").
	Id          *string     `json:"id,omitempty"`
	Metadata    *ObjectMeta `json:"metadata,omitempty"`
	AiSessionId *string     `json:"ai_session_id,omitempty"`
	// The feedback reaction types are:  'THUMBS_UP': when a user upvotes AI Assistant's answer.  'THUMBS_DOWN': when a user downvotes the AI Assistant's answer.
	Reaction *string `json:"reaction,omitempty"`
	// The feedback copy types are:  'ANSWER': when a user copies the AI Assistant's answer.  'CODE': when a user copies the code snippet from the AI Assistant's answer.
	Copied *string `json:"copied,omitempty"`
	// Additional text feedback optionally provided by a user.
	Comment NullableString `json:"comment,omitempty"`
}

AiV1Feedback Submit feedback on the AI assistant.

func NewAiV1Feedback

func NewAiV1Feedback() *AiV1Feedback

NewAiV1Feedback instantiates a new AiV1Feedback object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAiV1FeedbackWithDefaults

func NewAiV1FeedbackWithDefaults() *AiV1Feedback

NewAiV1FeedbackWithDefaults instantiates a new AiV1Feedback object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AiV1Feedback) GetAiSessionId

func (o *AiV1Feedback) GetAiSessionId() string

GetAiSessionId returns the AiSessionId field value if set, zero value otherwise.

func (*AiV1Feedback) GetAiSessionIdOk

func (o *AiV1Feedback) GetAiSessionIdOk() (*string, bool)

GetAiSessionIdOk returns a tuple with the AiSessionId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1Feedback) GetApiVersion

func (o *AiV1Feedback) GetApiVersion() string

GetApiVersion returns the ApiVersion field value if set, zero value otherwise.

func (*AiV1Feedback) GetApiVersionOk

func (o *AiV1Feedback) GetApiVersionOk() (*string, bool)

GetApiVersionOk returns a tuple with the ApiVersion field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1Feedback) GetComment

func (o *AiV1Feedback) GetComment() string

GetComment returns the Comment field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AiV1Feedback) GetCommentOk

func (o *AiV1Feedback) GetCommentOk() (*string, bool)

GetCommentOk returns a tuple with the Comment field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AiV1Feedback) GetCopied

func (o *AiV1Feedback) GetCopied() string

GetCopied returns the Copied field value if set, zero value otherwise.

func (*AiV1Feedback) GetCopiedOk

func (o *AiV1Feedback) GetCopiedOk() (*string, bool)

GetCopiedOk returns a tuple with the Copied field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1Feedback) GetId

func (o *AiV1Feedback) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*AiV1Feedback) GetIdOk

func (o *AiV1Feedback) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1Feedback) GetKind

func (o *AiV1Feedback) GetKind() string

GetKind returns the Kind field value if set, zero value otherwise.

func (*AiV1Feedback) GetKindOk

func (o *AiV1Feedback) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1Feedback) GetMetadata

func (o *AiV1Feedback) GetMetadata() ObjectMeta

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*AiV1Feedback) GetMetadataOk

func (o *AiV1Feedback) GetMetadataOk() (*ObjectMeta, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1Feedback) GetReaction

func (o *AiV1Feedback) GetReaction() string

GetReaction returns the Reaction field value if set, zero value otherwise.

func (*AiV1Feedback) GetReactionOk

func (o *AiV1Feedback) GetReactionOk() (*string, bool)

GetReactionOk returns a tuple with the Reaction field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1Feedback) HasAiSessionId

func (o *AiV1Feedback) HasAiSessionId() bool

HasAiSessionId returns a boolean if a field has been set.

func (*AiV1Feedback) HasApiVersion

func (o *AiV1Feedback) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*AiV1Feedback) HasComment

func (o *AiV1Feedback) HasComment() bool

HasComment returns a boolean if a field has been set.

func (*AiV1Feedback) HasCopied

func (o *AiV1Feedback) HasCopied() bool

HasCopied returns a boolean if a field has been set.

func (*AiV1Feedback) HasId

func (o *AiV1Feedback) HasId() bool

HasId returns a boolean if a field has been set.

func (*AiV1Feedback) HasKind

func (o *AiV1Feedback) HasKind() bool

HasKind returns a boolean if a field has been set.

func (*AiV1Feedback) HasMetadata

func (o *AiV1Feedback) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*AiV1Feedback) HasReaction

func (o *AiV1Feedback) HasReaction() bool

HasReaction returns a boolean if a field has been set.

func (AiV1Feedback) MarshalJSON

func (o AiV1Feedback) MarshalJSON() ([]byte, error)

func (*AiV1Feedback) Redact

func (o *AiV1Feedback) Redact()

Redact resets all sensitive fields to their zero value.

func (*AiV1Feedback) SetAiSessionId

func (o *AiV1Feedback) SetAiSessionId(v string)

SetAiSessionId gets a reference to the given string and assigns it to the AiSessionId field.

func (*AiV1Feedback) SetApiVersion

func (o *AiV1Feedback) SetApiVersion(v string)

SetApiVersion gets a reference to the given string and assigns it to the ApiVersion field.

func (*AiV1Feedback) SetComment

func (o *AiV1Feedback) SetComment(v string)

SetComment gets a reference to the given NullableString and assigns it to the Comment field.

func (*AiV1Feedback) SetCommentNil

func (o *AiV1Feedback) SetCommentNil()

SetCommentNil sets the value for Comment to be an explicit nil

func (*AiV1Feedback) SetCopied

func (o *AiV1Feedback) SetCopied(v string)

SetCopied gets a reference to the given string and assigns it to the Copied field.

func (*AiV1Feedback) SetId

func (o *AiV1Feedback) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*AiV1Feedback) SetKind

func (o *AiV1Feedback) SetKind(v string)

SetKind gets a reference to the given string and assigns it to the Kind field.

func (*AiV1Feedback) SetMetadata

func (o *AiV1Feedback) SetMetadata(v ObjectMeta)

SetMetadata gets a reference to the given ObjectMeta and assigns it to the Metadata field.

func (*AiV1Feedback) SetReaction

func (o *AiV1Feedback) SetReaction(v string)

SetReaction gets a reference to the given string and assigns it to the Reaction field.

func (*AiV1Feedback) UnsetComment

func (o *AiV1Feedback) UnsetComment()

UnsetComment ensures that no value is present for Comment, not even an explicit nil

type AiV1OrgPreferences

type AiV1OrgPreferences struct {
	// APIVersion defines the schema version of this representation of a resource.
	ApiVersion *string `json:"api_version,omitempty"`
	// Kind defines the object this REST resource represents.
	Kind *string `json:"kind,omitempty"`
	// Enable ai-assist for the organization
	AiAssistantEnabled *bool `json:"ai_assistant_enabled,omitempty"`
}

AiV1OrgPreferences Enable the Confluent AI Assistant for your organization. This operation is only available to users with the `OrganizationAdmin` role. By default, this setting is set to `True`. ## The Org Preferences Model <SchemaDefinition schemaRef=\"#/components/schemas/ai.v1.OrgPreferences\" />

func NewAiV1OrgPreferences

func NewAiV1OrgPreferences() *AiV1OrgPreferences

NewAiV1OrgPreferences instantiates a new AiV1OrgPreferences object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAiV1OrgPreferencesWithDefaults

func NewAiV1OrgPreferencesWithDefaults() *AiV1OrgPreferences

NewAiV1OrgPreferencesWithDefaults instantiates a new AiV1OrgPreferences object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AiV1OrgPreferences) GetAiAssistantEnabled

func (o *AiV1OrgPreferences) GetAiAssistantEnabled() bool

GetAiAssistantEnabled returns the AiAssistantEnabled field value if set, zero value otherwise.

func (*AiV1OrgPreferences) GetAiAssistantEnabledOk

func (o *AiV1OrgPreferences) GetAiAssistantEnabledOk() (*bool, bool)

GetAiAssistantEnabledOk returns a tuple with the AiAssistantEnabled field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1OrgPreferences) GetApiVersion

func (o *AiV1OrgPreferences) GetApiVersion() string

GetApiVersion returns the ApiVersion field value if set, zero value otherwise.

func (*AiV1OrgPreferences) GetApiVersionOk

func (o *AiV1OrgPreferences) GetApiVersionOk() (*string, bool)

GetApiVersionOk returns a tuple with the ApiVersion field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1OrgPreferences) GetKind

func (o *AiV1OrgPreferences) GetKind() string

GetKind returns the Kind field value if set, zero value otherwise.

func (*AiV1OrgPreferences) GetKindOk

func (o *AiV1OrgPreferences) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AiV1OrgPreferences) HasAiAssistantEnabled

func (o *AiV1OrgPreferences) HasAiAssistantEnabled() bool

HasAiAssistantEnabled returns a boolean if a field has been set.

func (*AiV1OrgPreferences) HasApiVersion

func (o *AiV1OrgPreferences) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*AiV1OrgPreferences) HasKind

func (o *AiV1OrgPreferences) HasKind() bool

HasKind returns a boolean if a field has been set.

func (AiV1OrgPreferences) MarshalJSON

func (o AiV1OrgPreferences) MarshalJSON() ([]byte, error)

func (*AiV1OrgPreferences) Redact

func (o *AiV1OrgPreferences) Redact()

Redact resets all sensitive fields to their zero value.

func (*AiV1OrgPreferences) SetAiAssistantEnabled

func (o *AiV1OrgPreferences) SetAiAssistantEnabled(v bool)

SetAiAssistantEnabled gets a reference to the given bool and assigns it to the AiAssistantEnabled field.

func (*AiV1OrgPreferences) SetApiVersion

func (o *AiV1OrgPreferences) SetApiVersion(v string)

SetApiVersion gets a reference to the given string and assigns it to the ApiVersion field.

func (*AiV1OrgPreferences) SetKind

func (o *AiV1OrgPreferences) SetKind(v string)

SetKind gets a reference to the given string and assigns it to the Kind field.

type ApiCreateAiV1ChatCompletionFeedbackRequest

type ApiCreateAiV1ChatCompletionFeedbackRequest struct {
	ApiService FeedbacksAiV1Api
	// contains filtered or unexported fields
}

func (ApiCreateAiV1ChatCompletionFeedbackRequest) AiV1Feedback

func (ApiCreateAiV1ChatCompletionFeedbackRequest) Execute

type ApiCreateAiV1DocCompletionFeedbackRequest

type ApiCreateAiV1DocCompletionFeedbackRequest struct {
	ApiService FeedbacksAiV1Api
	// contains filtered or unexported fields
}

func (ApiCreateAiV1DocCompletionFeedbackRequest) AiV1Feedback

func (ApiCreateAiV1DocCompletionFeedbackRequest) Execute

type ApiGetAiV1AvailabilityRequest

type ApiGetAiV1AvailabilityRequest struct {
	ApiService AvailabilitiesAiV1Api
	// contains filtered or unexported fields
}

func (ApiGetAiV1AvailabilityRequest) Execute

type ApiGetAiV1ChatCompletionRequest

type ApiGetAiV1ChatCompletionRequest struct {
	ApiService ChatCompletionsAiV1Api
	// contains filtered or unexported fields
}

func (ApiGetAiV1ChatCompletionRequest) Execute

type ApiGetAiV1OrgPreferenceRequest

type ApiGetAiV1OrgPreferenceRequest struct {
	ApiService OrgPreferencesAiV1Api
	// contains filtered or unexported fields
}

func (ApiGetAiV1OrgPreferenceRequest) Execute

type ApiQueryAiV1ChatCompletionRequest

type ApiQueryAiV1ChatCompletionRequest struct {
	ApiService ChatCompletionsAiV1Api
	// contains filtered or unexported fields
}

func (ApiQueryAiV1ChatCompletionRequest) AiV1ChatCompletionsRequest

func (r ApiQueryAiV1ChatCompletionRequest) AiV1ChatCompletionsRequest(aiV1ChatCompletionsRequest AiV1ChatCompletionsRequest) ApiQueryAiV1ChatCompletionRequest

func (ApiQueryAiV1ChatCompletionRequest) Execute

type ApiQueryDocsAiV1DocCompletionRequest

type ApiQueryDocsAiV1DocCompletionRequest struct {
	ApiService DocCompletionsDocsAiV1Api
	// contains filtered or unexported fields
}

func (ApiQueryDocsAiV1DocCompletionRequest) AiV1ChatCompletionsRequest

func (r ApiQueryDocsAiV1DocCompletionRequest) AiV1ChatCompletionsRequest(aiV1ChatCompletionsRequest AiV1ChatCompletionsRequest) ApiQueryDocsAiV1DocCompletionRequest

func (ApiQueryDocsAiV1DocCompletionRequest) Execute

type ApiUpdateAiV1OrgPreferenceRequest

type ApiUpdateAiV1OrgPreferenceRequest struct {
	ApiService OrgPreferencesAiV1Api
	// contains filtered or unexported fields
}

func (ApiUpdateAiV1OrgPreferenceRequest) AiV1OrgPreferences

func (ApiUpdateAiV1OrgPreferenceRequest) Execute

type AvailabilitiesAiV1Api

type AvailabilitiesAiV1Api interface {

	/*
		GetAiV1Availability Read the organization's ai-assistant setting.

		[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

	Returns the organization's ai-assistant setting.


		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @return ApiGetAiV1AvailabilityRequest
	*/
	GetAiV1Availability(ctx _context.Context) ApiGetAiV1AvailabilityRequest

	// GetAiV1AvailabilityExecute executes the request
	//  @return AiV1Availability
	GetAiV1AvailabilityExecute(r ApiGetAiV1AvailabilityRequest) (AiV1Availability, *_nethttp.Response, error)
}

type AvailabilitiesAiV1ApiService

type AvailabilitiesAiV1ApiService service

AvailabilitiesAiV1ApiService AvailabilitiesAiV1Api service

func (*AvailabilitiesAiV1ApiService) GetAiV1Availability

GetAiV1Availability Read the organization's ai-assistant setting.

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Returns the organization's ai-assistant setting.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetAiV1AvailabilityRequest

func (*AvailabilitiesAiV1ApiService) GetAiV1AvailabilityExecute

Execute executes the request

@return AiV1Availability

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type ChatCompletionsAiV1Api

type ChatCompletionsAiV1Api interface {

	/*
		GetAiV1ChatCompletion Read a Chat Completion

		[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

	Get the HTTP methods/verbs (if any) the particular authenticated user is allowed to submit

		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @return ApiGetAiV1ChatCompletionRequest
	*/
	GetAiV1ChatCompletion(ctx _context.Context) ApiGetAiV1ChatCompletionRequest

	// GetAiV1ChatCompletionExecute executes the request
	GetAiV1ChatCompletionExecute(r ApiGetAiV1ChatCompletionRequest) (*_nethttp.Response, error)

	/*
		QueryAiV1ChatCompletion Query a Chat Completion

		[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

	Query the Confluent AI assistant, optionally with prior conversation history.

		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @return ApiQueryAiV1ChatCompletionRequest
	*/
	QueryAiV1ChatCompletion(ctx _context.Context) ApiQueryAiV1ChatCompletionRequest

	// QueryAiV1ChatCompletionExecute executes the request
	//  @return AiV1ChatCompletionsReply
	QueryAiV1ChatCompletionExecute(r ApiQueryAiV1ChatCompletionRequest) (AiV1ChatCompletionsReply, *_nethttp.Response, error)
}

type ChatCompletionsAiV1ApiService

type ChatCompletionsAiV1ApiService service

ChatCompletionsAiV1ApiService ChatCompletionsAiV1Api service

func (*ChatCompletionsAiV1ApiService) GetAiV1ChatCompletion

GetAiV1ChatCompletion Read a Chat Completion

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Get the HTTP methods/verbs (if any) the particular authenticated user is allowed to submit

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetAiV1ChatCompletionRequest

func (*ChatCompletionsAiV1ApiService) GetAiV1ChatCompletionExecute

Execute executes the request

func (*ChatCompletionsAiV1ApiService) QueryAiV1ChatCompletion

QueryAiV1ChatCompletion Query a Chat Completion

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Query the Confluent AI assistant, optionally with prior conversation history.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiQueryAiV1ChatCompletionRequest

func (*ChatCompletionsAiV1ApiService) QueryAiV1ChatCompletionExecute

Execute executes the request

@return AiV1ChatCompletionsReply

type Configuration

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type DocCompletionsDocsAiV1Api

type DocCompletionsDocsAiV1Api interface {

	/*
			QueryDocsAiV1DocCompletion Query a Doc Completion

			[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+docs-ai-v1-early-access@confluent.io?subject=Request%20to%20join%20docs-ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20docs-ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

		Query the Docs AI assistant, optionally with prior conversation history.

			 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
			 @return ApiQueryDocsAiV1DocCompletionRequest
	*/
	QueryDocsAiV1DocCompletion(ctx _context.Context) ApiQueryDocsAiV1DocCompletionRequest

	// QueryDocsAiV1DocCompletionExecute executes the request
	//  @return AiV1ChatCompletionsReply
	QueryDocsAiV1DocCompletionExecute(r ApiQueryDocsAiV1DocCompletionRequest) (AiV1ChatCompletionsReply, *_nethttp.Response, error)
}

type DocCompletionsDocsAiV1ApiService

type DocCompletionsDocsAiV1ApiService service

DocCompletionsDocsAiV1ApiService DocCompletionsDocsAiV1Api service

func (*DocCompletionsDocsAiV1ApiService) QueryDocsAiV1DocCompletion

QueryDocsAiV1DocCompletion Query a Doc Completion

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+docs-ai-v1-early-access@confluent.io?subject=Request%20to%20join%20docs-ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20docs-ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Query the Docs AI assistant, optionally with prior conversation history.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiQueryDocsAiV1DocCompletionRequest

func (*DocCompletionsDocsAiV1ApiService) QueryDocsAiV1DocCompletionExecute

Execute executes the request

@return AiV1ChatCompletionsReply

type Error

type Error struct {
	// A unique identifier for this particular occurrence of the problem.
	Id *string `json:"id,omitempty"`
	// The HTTP status code applicable to this problem, expressed as a string value.
	Status *string `json:"status,omitempty"`
	// An application-specific error code, expressed as a string value.
	Code *string `json:"code,omitempty"`
	// A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.
	Title *string `json:"title,omitempty"`
	// A human-readable explanation specific to this occurrence of the problem.
	Detail *string      `json:"detail,omitempty"`
	Source *ErrorSource `json:"source,omitempty"`
}

Error Describes a particular error encountered while performing an operation.

func NewError

func NewError() *Error

NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorWithDefaults

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Error) GetCode

func (o *Error) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*Error) GetCodeOk

func (o *Error) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetDetail

func (o *Error) GetDetail() string

GetDetail returns the Detail field value if set, zero value otherwise.

func (*Error) GetDetailOk

func (o *Error) GetDetailOk() (*string, bool)

GetDetailOk returns a tuple with the Detail field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetId

func (o *Error) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*Error) GetIdOk

func (o *Error) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetSource

func (o *Error) GetSource() ErrorSource

GetSource returns the Source field value if set, zero value otherwise.

func (*Error) GetSourceOk

func (o *Error) GetSourceOk() (*ErrorSource, bool)

GetSourceOk returns a tuple with the Source field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetStatus

func (o *Error) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*Error) GetStatusOk

func (o *Error) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetTitle

func (o *Error) GetTitle() string

GetTitle returns the Title field value if set, zero value otherwise.

func (*Error) GetTitleOk

func (o *Error) GetTitleOk() (*string, bool)

GetTitleOk returns a tuple with the Title field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) HasCode

func (o *Error) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*Error) HasDetail

func (o *Error) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (*Error) HasId

func (o *Error) HasId() bool

HasId returns a boolean if a field has been set.

func (*Error) HasSource

func (o *Error) HasSource() bool

HasSource returns a boolean if a field has been set.

func (*Error) HasStatus

func (o *Error) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*Error) HasTitle

func (o *Error) HasTitle() bool

HasTitle returns a boolean if a field has been set.

func (Error) MarshalJSON

func (o Error) MarshalJSON() ([]byte, error)

func (*Error) Redact

func (o *Error) Redact()

Redact resets all sensitive fields to their zero value.

func (*Error) SetCode

func (o *Error) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*Error) SetDetail

func (o *Error) SetDetail(v string)

SetDetail gets a reference to the given string and assigns it to the Detail field.

func (*Error) SetId

func (o *Error) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*Error) SetSource

func (o *Error) SetSource(v ErrorSource)

SetSource gets a reference to the given ErrorSource and assigns it to the Source field.

func (*Error) SetStatus

func (o *Error) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*Error) SetTitle

func (o *Error) SetTitle(v string)

SetTitle gets a reference to the given string and assigns it to the Title field.

type ErrorSource

type ErrorSource struct {
	// A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/spec\" for a spec object, or \"/spec/title\" for a specific field].
	Pointer *string `json:"pointer,omitempty"`
	// A string indicating which query parameter caused the error.
	Parameter *string `json:"parameter,omitempty"`
}

ErrorSource If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it.

func NewErrorSource

func NewErrorSource() *ErrorSource

NewErrorSource instantiates a new ErrorSource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorSourceWithDefaults

func NewErrorSourceWithDefaults() *ErrorSource

NewErrorSourceWithDefaults instantiates a new ErrorSource object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ErrorSource) GetParameter

func (o *ErrorSource) GetParameter() string

GetParameter returns the Parameter field value if set, zero value otherwise.

func (*ErrorSource) GetParameterOk

func (o *ErrorSource) GetParameterOk() (*string, bool)

GetParameterOk returns a tuple with the Parameter field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorSource) GetPointer

func (o *ErrorSource) GetPointer() string

GetPointer returns the Pointer field value if set, zero value otherwise.

func (*ErrorSource) GetPointerOk

func (o *ErrorSource) GetPointerOk() (*string, bool)

GetPointerOk returns a tuple with the Pointer field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorSource) HasParameter

func (o *ErrorSource) HasParameter() bool

HasParameter returns a boolean if a field has been set.

func (*ErrorSource) HasPointer

func (o *ErrorSource) HasPointer() bool

HasPointer returns a boolean if a field has been set.

func (ErrorSource) MarshalJSON

func (o ErrorSource) MarshalJSON() ([]byte, error)

func (*ErrorSource) Redact

func (o *ErrorSource) Redact()

Redact resets all sensitive fields to their zero value.

func (*ErrorSource) SetParameter

func (o *ErrorSource) SetParameter(v string)

SetParameter gets a reference to the given string and assigns it to the Parameter field.

func (*ErrorSource) SetPointer

func (o *ErrorSource) SetPointer(v string)

SetPointer gets a reference to the given string and assigns it to the Pointer field.

type Failure

type Failure struct {
	// List of errors which caused this operation to fail
	Errors []Error `json:"errors,omitempty"`
}

Failure Provides information about problems encountered while performing an operation.

func NewFailure

func NewFailure(errors []Error) *Failure

NewFailure instantiates a new Failure object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewFailureWithDefaults

func NewFailureWithDefaults() *Failure

NewFailureWithDefaults instantiates a new Failure object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Failure) GetErrors

func (o *Failure) GetErrors() []Error

GetErrors returns the Errors field value

func (*Failure) GetErrorsOk

func (o *Failure) GetErrorsOk() (*[]Error, bool)

GetErrorsOk returns a tuple with the Errors field value and a boolean to check if the value has been set.

func (Failure) MarshalJSON

func (o Failure) MarshalJSON() ([]byte, error)

func (*Failure) Redact

func (o *Failure) Redact()

Redact resets all sensitive fields to their zero value.

func (*Failure) SetErrors

func (o *Failure) SetErrors(v []Error)

SetErrors sets field value

type FeedbacksAiV1Api

type FeedbacksAiV1Api interface {

	/*
			CreateAiV1ChatCompletionFeedback Create a Feedback

			[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

		Submit feedback on the Confluent AI assistant.

			 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
			 @param chatCompletionId The Chat Completion
			 @return ApiCreateAiV1ChatCompletionFeedbackRequest
	*/
	CreateAiV1ChatCompletionFeedback(ctx _context.Context, chatCompletionId string) ApiCreateAiV1ChatCompletionFeedbackRequest

	// CreateAiV1ChatCompletionFeedbackExecute executes the request
	CreateAiV1ChatCompletionFeedbackExecute(r ApiCreateAiV1ChatCompletionFeedbackRequest) (*_nethttp.Response, error)

	/*
			CreateAiV1DocCompletionFeedback Create a Feedback

			[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

		Submit feedback on the Doc AI assistant.

			 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
			 @param docCompletionId The Doc Completion
			 @return ApiCreateAiV1DocCompletionFeedbackRequest
	*/
	CreateAiV1DocCompletionFeedback(ctx _context.Context, docCompletionId string) ApiCreateAiV1DocCompletionFeedbackRequest

	// CreateAiV1DocCompletionFeedbackExecute executes the request
	CreateAiV1DocCompletionFeedbackExecute(r ApiCreateAiV1DocCompletionFeedbackRequest) (*_nethttp.Response, error)
}

type FeedbacksAiV1ApiService

type FeedbacksAiV1ApiService service

FeedbacksAiV1ApiService FeedbacksAiV1Api service

func (*FeedbacksAiV1ApiService) CreateAiV1ChatCompletionFeedback

func (a *FeedbacksAiV1ApiService) CreateAiV1ChatCompletionFeedback(ctx _context.Context, chatCompletionId string) ApiCreateAiV1ChatCompletionFeedbackRequest

CreateAiV1ChatCompletionFeedback Create a Feedback

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Submit feedback on the Confluent AI assistant.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param chatCompletionId The Chat Completion
@return ApiCreateAiV1ChatCompletionFeedbackRequest

func (*FeedbacksAiV1ApiService) CreateAiV1ChatCompletionFeedbackExecute

func (a *FeedbacksAiV1ApiService) CreateAiV1ChatCompletionFeedbackExecute(r ApiCreateAiV1ChatCompletionFeedbackRequest) (*_nethttp.Response, error)

Execute executes the request

func (*FeedbacksAiV1ApiService) CreateAiV1DocCompletionFeedback

func (a *FeedbacksAiV1ApiService) CreateAiV1DocCompletionFeedback(ctx _context.Context, docCompletionId string) ApiCreateAiV1DocCompletionFeedbackRequest

CreateAiV1DocCompletionFeedback Create a Feedback

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Submit feedback on the Doc AI assistant.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param docCompletionId The Doc Completion
@return ApiCreateAiV1DocCompletionFeedbackRequest

func (*FeedbacksAiV1ApiService) CreateAiV1DocCompletionFeedbackExecute

func (a *FeedbacksAiV1ApiService) CreateAiV1DocCompletionFeedbackExecute(r ApiCreateAiV1DocCompletionFeedbackRequest) (*_nethttp.Response, error)

Execute executes the request

type GenericOpenAPIError

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type ListMeta

type ListMeta struct {
	// A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported.
	First NullableString `json:"first,omitempty"`
	// A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported.
	Last NullableString `json:"last,omitempty"`
	// A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported.
	Prev NullableString `json:"prev,omitempty"`
	// A link to the next page of results. If a response does not contain a next link, then there is no more data available.
	Next NullableString `json:"next,omitempty"`
	// Number of records in the full result set. This response may be paginated and have a smaller number of records.
	TotalSize *int32 `json:"total_size,omitempty"`
}

ListMeta ListMeta describes metadata that resource collections may have

func NewListMeta

func NewListMeta() *ListMeta

NewListMeta instantiates a new ListMeta object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListMetaWithDefaults

func NewListMetaWithDefaults() *ListMeta

NewListMetaWithDefaults instantiates a new ListMeta object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListMeta) GetFirst

func (o *ListMeta) GetFirst() string

GetFirst returns the First field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ListMeta) GetFirstOk

func (o *ListMeta) GetFirstOk() (*string, bool)

GetFirstOk returns a tuple with the First field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ListMeta) GetLast

func (o *ListMeta) GetLast() string

GetLast returns the Last field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ListMeta) GetLastOk

func (o *ListMeta) GetLastOk() (*string, bool)

GetLastOk returns a tuple with the Last field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ListMeta) GetNext

func (o *ListMeta) GetNext() string

GetNext returns the Next field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ListMeta) GetNextOk

func (o *ListMeta) GetNextOk() (*string, bool)

GetNextOk returns a tuple with the Next field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ListMeta) GetPrev

func (o *ListMeta) GetPrev() string

GetPrev returns the Prev field value if set, zero value otherwise (both if not set or set to explicit null).

func (*ListMeta) GetPrevOk

func (o *ListMeta) GetPrevOk() (*string, bool)

GetPrevOk returns a tuple with the Prev field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ListMeta) GetTotalSize

func (o *ListMeta) GetTotalSize() int32

GetTotalSize returns the TotalSize field value if set, zero value otherwise.

func (*ListMeta) GetTotalSizeOk

func (o *ListMeta) GetTotalSizeOk() (*int32, bool)

GetTotalSizeOk returns a tuple with the TotalSize field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ListMeta) HasFirst

func (o *ListMeta) HasFirst() bool

HasFirst returns a boolean if a field has been set.

func (*ListMeta) HasLast

func (o *ListMeta) HasLast() bool

HasLast returns a boolean if a field has been set.

func (*ListMeta) HasNext

func (o *ListMeta) HasNext() bool

HasNext returns a boolean if a field has been set.

func (*ListMeta) HasPrev

func (o *ListMeta) HasPrev() bool

HasPrev returns a boolean if a field has been set.

func (*ListMeta) HasTotalSize

func (o *ListMeta) HasTotalSize() bool

HasTotalSize returns a boolean if a field has been set.

func (ListMeta) MarshalJSON

func (o ListMeta) MarshalJSON() ([]byte, error)

func (*ListMeta) Redact

func (o *ListMeta) Redact()

Redact resets all sensitive fields to their zero value.

func (*ListMeta) SetFirst

func (o *ListMeta) SetFirst(v string)

SetFirst gets a reference to the given NullableString and assigns it to the First field.

func (*ListMeta) SetFirstNil

func (o *ListMeta) SetFirstNil()

SetFirstNil sets the value for First to be an explicit nil

func (*ListMeta) SetLast

func (o *ListMeta) SetLast(v string)

SetLast gets a reference to the given NullableString and assigns it to the Last field.

func (*ListMeta) SetLastNil

func (o *ListMeta) SetLastNil()

SetLastNil sets the value for Last to be an explicit nil

func (*ListMeta) SetNext

func (o *ListMeta) SetNext(v string)

SetNext gets a reference to the given NullableString and assigns it to the Next field.

func (*ListMeta) SetNextNil

func (o *ListMeta) SetNextNil()

SetNextNil sets the value for Next to be an explicit nil

func (*ListMeta) SetPrev

func (o *ListMeta) SetPrev(v string)

SetPrev gets a reference to the given NullableString and assigns it to the Prev field.

func (*ListMeta) SetPrevNil

func (o *ListMeta) SetPrevNil()

SetPrevNil sets the value for Prev to be an explicit nil

func (*ListMeta) SetTotalSize

func (o *ListMeta) SetTotalSize(v int32)

SetTotalSize gets a reference to the given int32 and assigns it to the TotalSize field.

func (*ListMeta) UnsetFirst

func (o *ListMeta) UnsetFirst()

UnsetFirst ensures that no value is present for First, not even an explicit nil

func (*ListMeta) UnsetLast

func (o *ListMeta) UnsetLast()

UnsetLast ensures that no value is present for Last, not even an explicit nil

func (*ListMeta) UnsetNext

func (o *ListMeta) UnsetNext()

UnsetNext ensures that no value is present for Next, not even an explicit nil

func (*ListMeta) UnsetPrev

func (o *ListMeta) UnsetPrev()

UnsetPrev ensures that no value is present for Prev, not even an explicit nil

type NullableAiV1Availability

type NullableAiV1Availability struct {
	// contains filtered or unexported fields
}

func NewNullableAiV1Availability

func NewNullableAiV1Availability(val *AiV1Availability) *NullableAiV1Availability

func (NullableAiV1Availability) Get

func (NullableAiV1Availability) IsSet

func (v NullableAiV1Availability) IsSet() bool

func (NullableAiV1Availability) MarshalJSON

func (v NullableAiV1Availability) MarshalJSON() ([]byte, error)

func (*NullableAiV1Availability) Set

func (*NullableAiV1Availability) UnmarshalJSON

func (v *NullableAiV1Availability) UnmarshalJSON(src []byte) error

func (*NullableAiV1Availability) Unset

func (v *NullableAiV1Availability) Unset()

type NullableAiV1ChatCompletionsHistory

type NullableAiV1ChatCompletionsHistory struct {
	// contains filtered or unexported fields
}

func (NullableAiV1ChatCompletionsHistory) Get

func (NullableAiV1ChatCompletionsHistory) IsSet

func (NullableAiV1ChatCompletionsHistory) MarshalJSON

func (v NullableAiV1ChatCompletionsHistory) MarshalJSON() ([]byte, error)

func (*NullableAiV1ChatCompletionsHistory) Set

func (*NullableAiV1ChatCompletionsHistory) UnmarshalJSON

func (v *NullableAiV1ChatCompletionsHistory) UnmarshalJSON(src []byte) error

func (*NullableAiV1ChatCompletionsHistory) Unset

type NullableAiV1ChatCompletionsReply

type NullableAiV1ChatCompletionsReply struct {
	// contains filtered or unexported fields
}

func (NullableAiV1ChatCompletionsReply) Get

func (NullableAiV1ChatCompletionsReply) IsSet

func (NullableAiV1ChatCompletionsReply) MarshalJSON

func (v NullableAiV1ChatCompletionsReply) MarshalJSON() ([]byte, error)

func (*NullableAiV1ChatCompletionsReply) Set

func (*NullableAiV1ChatCompletionsReply) UnmarshalJSON

func (v *NullableAiV1ChatCompletionsReply) UnmarshalJSON(src []byte) error

func (*NullableAiV1ChatCompletionsReply) Unset

type NullableAiV1ChatCompletionsRequest

type NullableAiV1ChatCompletionsRequest struct {
	// contains filtered or unexported fields
}

func (NullableAiV1ChatCompletionsRequest) Get

func (NullableAiV1ChatCompletionsRequest) IsSet

func (NullableAiV1ChatCompletionsRequest) MarshalJSON

func (v NullableAiV1ChatCompletionsRequest) MarshalJSON() ([]byte, error)

func (*NullableAiV1ChatCompletionsRequest) Set

func (*NullableAiV1ChatCompletionsRequest) UnmarshalJSON

func (v *NullableAiV1ChatCompletionsRequest) UnmarshalJSON(src []byte) error

func (*NullableAiV1ChatCompletionsRequest) Unset

type NullableAiV1Feedback

type NullableAiV1Feedback struct {
	// contains filtered or unexported fields
}

func NewNullableAiV1Feedback

func NewNullableAiV1Feedback(val *AiV1Feedback) *NullableAiV1Feedback

func (NullableAiV1Feedback) Get

func (NullableAiV1Feedback) IsSet

func (v NullableAiV1Feedback) IsSet() bool

func (NullableAiV1Feedback) MarshalJSON

func (v NullableAiV1Feedback) MarshalJSON() ([]byte, error)

func (*NullableAiV1Feedback) Set

func (v *NullableAiV1Feedback) Set(val *AiV1Feedback)

func (*NullableAiV1Feedback) UnmarshalJSON

func (v *NullableAiV1Feedback) UnmarshalJSON(src []byte) error

func (*NullableAiV1Feedback) Unset

func (v *NullableAiV1Feedback) Unset()

type NullableAiV1OrgPreferences

type NullableAiV1OrgPreferences struct {
	// contains filtered or unexported fields
}

func NewNullableAiV1OrgPreferences

func NewNullableAiV1OrgPreferences(val *AiV1OrgPreferences) *NullableAiV1OrgPreferences

func (NullableAiV1OrgPreferences) Get

func (NullableAiV1OrgPreferences) IsSet

func (v NullableAiV1OrgPreferences) IsSet() bool

func (NullableAiV1OrgPreferences) MarshalJSON

func (v NullableAiV1OrgPreferences) MarshalJSON() ([]byte, error)

func (*NullableAiV1OrgPreferences) Set

func (*NullableAiV1OrgPreferences) UnmarshalJSON

func (v *NullableAiV1OrgPreferences) UnmarshalJSON(src []byte) error

func (*NullableAiV1OrgPreferences) Unset

func (v *NullableAiV1OrgPreferences) Unset()

type NullableBool

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get

func (v NullableBool) Get() *bool

func (NullableBool) IsSet

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset

func (v *NullableBool) Unset()

type NullableError

type NullableError struct {
	// contains filtered or unexported fields
}

func NewNullableError

func NewNullableError(val *Error) *NullableError

func (NullableError) Get

func (v NullableError) Get() *Error

func (NullableError) IsSet

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON

func (v NullableError) MarshalJSON() ([]byte, error)

func (*NullableError) Set

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON

func (v *NullableError) UnmarshalJSON(src []byte) error

func (*NullableError) Unset

func (v *NullableError) Unset()

type NullableErrorSource

type NullableErrorSource struct {
	// contains filtered or unexported fields
}

func NewNullableErrorSource

func NewNullableErrorSource(val *ErrorSource) *NullableErrorSource

func (NullableErrorSource) Get

func (NullableErrorSource) IsSet

func (v NullableErrorSource) IsSet() bool

func (NullableErrorSource) MarshalJSON

func (v NullableErrorSource) MarshalJSON() ([]byte, error)

func (*NullableErrorSource) Set

func (v *NullableErrorSource) Set(val *ErrorSource)

func (*NullableErrorSource) UnmarshalJSON

func (v *NullableErrorSource) UnmarshalJSON(src []byte) error

func (*NullableErrorSource) Unset

func (v *NullableErrorSource) Unset()

type NullableFailure

type NullableFailure struct {
	// contains filtered or unexported fields
}

func NewNullableFailure

func NewNullableFailure(val *Failure) *NullableFailure

func (NullableFailure) Get

func (v NullableFailure) Get() *Failure

func (NullableFailure) IsSet

func (v NullableFailure) IsSet() bool

func (NullableFailure) MarshalJSON

func (v NullableFailure) MarshalJSON() ([]byte, error)

func (*NullableFailure) Set

func (v *NullableFailure) Set(val *Failure)

func (*NullableFailure) UnmarshalJSON

func (v *NullableFailure) UnmarshalJSON(src []byte) error

func (*NullableFailure) Unset

func (v *NullableFailure) Unset()

type NullableFloat32

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset

func (v *NullableFloat32) Unset()

type NullableFloat64

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset

func (v *NullableFloat64) Unset()

type NullableInt

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get

func (v NullableInt) Get() *int

func (NullableInt) IsSet

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset

func (v *NullableInt) Unset()

type NullableInt32

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset

func (v *NullableInt32) Unset()

type NullableInt64

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset

func (v *NullableInt64) Unset()

type NullableListMeta

type NullableListMeta struct {
	// contains filtered or unexported fields
}

func NewNullableListMeta

func NewNullableListMeta(val *ListMeta) *NullableListMeta

func (NullableListMeta) Get

func (v NullableListMeta) Get() *ListMeta

func (NullableListMeta) IsSet

func (v NullableListMeta) IsSet() bool

func (NullableListMeta) MarshalJSON

func (v NullableListMeta) MarshalJSON() ([]byte, error)

func (*NullableListMeta) Set

func (v *NullableListMeta) Set(val *ListMeta)

func (*NullableListMeta) UnmarshalJSON

func (v *NullableListMeta) UnmarshalJSON(src []byte) error

func (*NullableListMeta) Unset

func (v *NullableListMeta) Unset()

type NullableObjectMeta

type NullableObjectMeta struct {
	// contains filtered or unexported fields
}

func NewNullableObjectMeta

func NewNullableObjectMeta(val *ObjectMeta) *NullableObjectMeta

func (NullableObjectMeta) Get

func (v NullableObjectMeta) Get() *ObjectMeta

func (NullableObjectMeta) IsSet

func (v NullableObjectMeta) IsSet() bool

func (NullableObjectMeta) MarshalJSON

func (v NullableObjectMeta) MarshalJSON() ([]byte, error)

func (*NullableObjectMeta) Set

func (v *NullableObjectMeta) Set(val *ObjectMeta)

func (*NullableObjectMeta) UnmarshalJSON

func (v *NullableObjectMeta) UnmarshalJSON(src []byte) error

func (*NullableObjectMeta) Unset

func (v *NullableObjectMeta) Unset()

type NullableObjectReference

type NullableObjectReference struct {
	// contains filtered or unexported fields
}

func NewNullableObjectReference

func NewNullableObjectReference(val *ObjectReference) *NullableObjectReference

func (NullableObjectReference) Get

func (NullableObjectReference) IsSet

func (v NullableObjectReference) IsSet() bool

func (NullableObjectReference) MarshalJSON

func (v NullableObjectReference) MarshalJSON() ([]byte, error)

func (*NullableObjectReference) Set

func (*NullableObjectReference) UnmarshalJSON

func (v *NullableObjectReference) UnmarshalJSON(src []byte) error

func (*NullableObjectReference) Unset

func (v *NullableObjectReference) Unset()

type NullableString

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString

func NewNullableString(val *string) *NullableString

func (NullableString) Get

func (v NullableString) Get() *string

func (NullableString) IsSet

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset

func (v *NullableString) Unset()

type NullableTime

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset

func (v *NullableTime) Unset()

type ObjectMeta

type ObjectMeta struct {
	// Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
	Self string `json:"self,omitempty"`
	// Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
	ResourceName *string `json:"resource_name,omitempty"`
	// The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
	// The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
}

ObjectMeta ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

func NewObjectMeta

func NewObjectMeta(self string) *ObjectMeta

NewObjectMeta instantiates a new ObjectMeta object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewObjectMetaWithDefaults

func NewObjectMetaWithDefaults() *ObjectMeta

NewObjectMetaWithDefaults instantiates a new ObjectMeta object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ObjectMeta) GetCreatedAt

func (o *ObjectMeta) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*ObjectMeta) GetCreatedAtOk

func (o *ObjectMeta) GetCreatedAtOk() (*time.Time, bool)

GetCreatedAtOk returns a tuple with the CreatedAt field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ObjectMeta) GetDeletedAt

func (o *ObjectMeta) GetDeletedAt() time.Time

GetDeletedAt returns the DeletedAt field value if set, zero value otherwise.

func (*ObjectMeta) GetDeletedAtOk

func (o *ObjectMeta) GetDeletedAtOk() (*time.Time, bool)

GetDeletedAtOk returns a tuple with the DeletedAt field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ObjectMeta) GetResourceName

func (o *ObjectMeta) GetResourceName() string

GetResourceName returns the ResourceName field value if set, zero value otherwise.

func (*ObjectMeta) GetResourceNameOk

func (o *ObjectMeta) GetResourceNameOk() (*string, bool)

GetResourceNameOk returns a tuple with the ResourceName field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ObjectMeta) GetSelf

func (o *ObjectMeta) GetSelf() string

GetSelf returns the Self field value

func (*ObjectMeta) GetSelfOk

func (o *ObjectMeta) GetSelfOk() (*string, bool)

GetSelfOk returns a tuple with the Self field value and a boolean to check if the value has been set.

func (*ObjectMeta) GetUpdatedAt

func (o *ObjectMeta) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value if set, zero value otherwise.

func (*ObjectMeta) GetUpdatedAtOk

func (o *ObjectMeta) GetUpdatedAtOk() (*time.Time, bool)

GetUpdatedAtOk returns a tuple with the UpdatedAt field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ObjectMeta) HasCreatedAt

func (o *ObjectMeta) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*ObjectMeta) HasDeletedAt

func (o *ObjectMeta) HasDeletedAt() bool

HasDeletedAt returns a boolean if a field has been set.

func (*ObjectMeta) HasResourceName

func (o *ObjectMeta) HasResourceName() bool

HasResourceName returns a boolean if a field has been set.

func (*ObjectMeta) HasUpdatedAt

func (o *ObjectMeta) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

func (ObjectMeta) MarshalJSON

func (o ObjectMeta) MarshalJSON() ([]byte, error)

func (*ObjectMeta) Redact

func (o *ObjectMeta) Redact()

Redact resets all sensitive fields to their zero value.

func (*ObjectMeta) SetCreatedAt

func (o *ObjectMeta) SetCreatedAt(v time.Time)

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*ObjectMeta) SetDeletedAt

func (o *ObjectMeta) SetDeletedAt(v time.Time)

SetDeletedAt gets a reference to the given time.Time and assigns it to the DeletedAt field.

func (*ObjectMeta) SetResourceName

func (o *ObjectMeta) SetResourceName(v string)

SetResourceName gets a reference to the given string and assigns it to the ResourceName field.

func (*ObjectMeta) SetSelf

func (o *ObjectMeta) SetSelf(v string)

SetSelf sets field value

func (*ObjectMeta) SetUpdatedAt

func (o *ObjectMeta) SetUpdatedAt(v time.Time)

SetUpdatedAt gets a reference to the given time.Time and assigns it to the UpdatedAt field.

type ObjectReference

type ObjectReference struct {
	// ID of the referred resource
	Id string `json:"id,omitempty"`
	// Environment of the referred resource, if env-scoped
	Environment *string `json:"environment,omitempty"`
	// API URL for accessing or modifying the referred object
	Related string `json:"related,omitempty"`
	// CRN reference to the referred resource
	ResourceName string `json:"resource_name,omitempty"`
	// API group and version of the referred resource
	ApiVersion *string `json:"api_version,omitempty"`
	// Kind of the referred resource
	Kind *string `json:"kind,omitempty"`
}

ObjectReference ObjectReference provides information for you to locate the referred object

func NewObjectReference

func NewObjectReference(id string, related string, resourceName string) *ObjectReference

NewObjectReference instantiates a new ObjectReference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewObjectReferenceWithDefaults

func NewObjectReferenceWithDefaults() *ObjectReference

NewObjectReferenceWithDefaults instantiates a new ObjectReference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ObjectReference) GetApiVersion

func (o *ObjectReference) GetApiVersion() string

GetApiVersion returns the ApiVersion field value if set, zero value otherwise.

func (*ObjectReference) GetApiVersionOk

func (o *ObjectReference) GetApiVersionOk() (*string, bool)

GetApiVersionOk returns a tuple with the ApiVersion field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ObjectReference) GetEnvironment

func (o *ObjectReference) GetEnvironment() string

GetEnvironment returns the Environment field value if set, zero value otherwise.

func (*ObjectReference) GetEnvironmentOk

func (o *ObjectReference) GetEnvironmentOk() (*string, bool)

GetEnvironmentOk returns a tuple with the Environment field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ObjectReference) GetId

func (o *ObjectReference) GetId() string

GetId returns the Id field value

func (*ObjectReference) GetIdOk

func (o *ObjectReference) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*ObjectReference) GetKind

func (o *ObjectReference) GetKind() string

GetKind returns the Kind field value if set, zero value otherwise.

func (*ObjectReference) GetKindOk

func (o *ObjectReference) GetKindOk() (*string, bool)

GetKindOk returns a tuple with the Kind field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ObjectReference) GetRelated

func (o *ObjectReference) GetRelated() string

GetRelated returns the Related field value

func (*ObjectReference) GetRelatedOk

func (o *ObjectReference) GetRelatedOk() (*string, bool)

GetRelatedOk returns a tuple with the Related field value and a boolean to check if the value has been set.

func (*ObjectReference) GetResourceName

func (o *ObjectReference) GetResourceName() string

GetResourceName returns the ResourceName field value

func (*ObjectReference) GetResourceNameOk

func (o *ObjectReference) GetResourceNameOk() (*string, bool)

GetResourceNameOk returns a tuple with the ResourceName field value and a boolean to check if the value has been set.

func (*ObjectReference) HasApiVersion

func (o *ObjectReference) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*ObjectReference) HasEnvironment

func (o *ObjectReference) HasEnvironment() bool

HasEnvironment returns a boolean if a field has been set.

func (*ObjectReference) HasKind

func (o *ObjectReference) HasKind() bool

HasKind returns a boolean if a field has been set.

func (ObjectReference) MarshalJSON

func (o ObjectReference) MarshalJSON() ([]byte, error)

func (*ObjectReference) Redact

func (o *ObjectReference) Redact()

Redact resets all sensitive fields to their zero value.

func (*ObjectReference) SetApiVersion

func (o *ObjectReference) SetApiVersion(v string)

SetApiVersion gets a reference to the given string and assigns it to the ApiVersion field.

func (*ObjectReference) SetEnvironment

func (o *ObjectReference) SetEnvironment(v string)

SetEnvironment gets a reference to the given string and assigns it to the Environment field.

func (*ObjectReference) SetId

func (o *ObjectReference) SetId(v string)

SetId sets field value

func (*ObjectReference) SetKind

func (o *ObjectReference) SetKind(v string)

SetKind gets a reference to the given string and assigns it to the Kind field.

func (*ObjectReference) SetRelated

func (o *ObjectReference) SetRelated(v string)

SetRelated sets field value

func (*ObjectReference) SetResourceName

func (o *ObjectReference) SetResourceName(v string)

SetResourceName sets field value

type OrgPreferencesAiV1Api

type OrgPreferencesAiV1Api interface {

	/*
			GetAiV1OrgPreference Read the organization's ai-assistant setting in org-preferences.

			[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

		Returns the organization's ai-assistant setting in org-preferences.


			 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
			 @return ApiGetAiV1OrgPreferenceRequest
	*/
	GetAiV1OrgPreference(ctx _context.Context) ApiGetAiV1OrgPreferenceRequest

	// GetAiV1OrgPreferenceExecute executes the request
	//  @return AiV1OrgPreferences
	GetAiV1OrgPreferenceExecute(r ApiGetAiV1OrgPreferenceRequest) (AiV1OrgPreferences, *_nethttp.Response, error)

	/*
			UpdateAiV1OrgPreference Set the organization's ai-assistant setting in org-preferences.

			[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

		Updates the organization's ai-assistant setting in org-preferences.




			 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
			 @return ApiUpdateAiV1OrgPreferenceRequest
	*/
	UpdateAiV1OrgPreference(ctx _context.Context) ApiUpdateAiV1OrgPreferenceRequest

	// UpdateAiV1OrgPreferenceExecute executes the request
	//  @return AiV1OrgPreferences
	UpdateAiV1OrgPreferenceExecute(r ApiUpdateAiV1OrgPreferenceRequest) (AiV1OrgPreferences, *_nethttp.Response, error)
}

type OrgPreferencesAiV1ApiService

type OrgPreferencesAiV1ApiService service

OrgPreferencesAiV1ApiService OrgPreferencesAiV1Api service

func (*OrgPreferencesAiV1ApiService) GetAiV1OrgPreference

GetAiV1OrgPreference Read the organization's ai-assistant setting in org-preferences.

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Returns the organization's ai-assistant setting in org-preferences.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetAiV1OrgPreferenceRequest

func (*OrgPreferencesAiV1ApiService) GetAiV1OrgPreferenceExecute

Execute executes the request

@return AiV1OrgPreferences

func (*OrgPreferencesAiV1ApiService) UpdateAiV1OrgPreference

UpdateAiV1OrgPreference Set the organization's ai-assistant setting in org-preferences.

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To AI API v1](https://img.shields.io/badge/-Request%20Access%20To%20AI%20API%20v1-%23bc8540)](mailto:ccloud-api-access+ai-v1-early-access@confluent.io?subject=Request%20to%20join%20ai/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ai/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Updates the organization's ai-assistant setting in org-preferences.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiUpdateAiV1OrgPreferenceRequest

func (*OrgPreferencesAiV1ApiService) UpdateAiV1OrgPreferenceExecute

Execute executes the request

@return AiV1OrgPreferences

type ServerConfiguration

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL