Module common 

Common types shared across multiple xAI API endpoints.

Structs

Annotation

Annotation on text output.

ApiKey

API key information.

CompleteRequest

(Legacy) Anthropic compatible complete request on /v1/complete endpoint.

CompleteResponse

(Legacy) Anthropic compatible complete response on /v1/complete endpoint.

ContentPart

A part of content in a message.

DebugOutput

Debug output. Only available to trusted testers.

DocumentsSource

DocumentsSource defines the source of documents to search over.

FileRef

File reference for file attachments.

ImageUrl

Image URL object of image prompt.

IncompleteDetails

Details about why a response is incomplete.

MessageMetadata

Message metadata.

SampleChoice

A choice in a sample response.

SampleRequest

(Legacy) Request for /v1/completions endpoint.

SampleResponse

(Legacy) Response for /v1/completions endpoint.

StartDeferredChatResponse

A unique request ID for deferred chat response.

StreamOptions

Options available when using streaming response.

SystemMessagePart

A part of system message content.

Enums

Content

Content of each chat message.

RankingMetric

Deprecated: Metric now comes from collection creation.

ResponseFormat

Response format parameter for structured outputs.

SampleContent

Sample content input.

SystemMessageContent

System message content.