Class Interactions

constructor

• new Interactions(options?: SDKOptions): Interactions

  Parameters

  • options: SDKOptions = {}

  Returns Interactions

Readonly_baseURL

Readonly_hooks

Readonly_httpClient

Optional Readonly_logger

Readonly_options

_createRequest

• _createRequest(
      context: HookContext,
      conf: RequestConfig,
      options?: RequestOptions,
  ): Result<Request, UnexpectedClientError | InvalidRequestError>

  Parameters

  • context: HookContext
  • conf: RequestConfig
  • Optionaloptions: RequestOptions

  Returns Result<Request, UnexpectedClientError | InvalidRequestError>

_do

• _do(
      request: Request,
      options: {
          context: HookContext;
          isErrorStatusCode: (statusCode: number) => boolean;
          retryCodes: string[];
          retryConfig: RetryConfig;
      },
  ): Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

  Parameters

  • request: Request
  • options: {
        context: HookContext;
        isErrorStatusCode: (statusCode: number) => boolean;
        retryCodes: string[];
        retryConfig: RetryConfig;
    }

  Returns Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

cancel

• cancel(
      id: string,
      params?: CancelInteractionByIdParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<Interaction>

  Cancels an interaction by id. This only applies to background interactions that are still running.

  Parameters

  • id: string
  • Optionalparams: CancelInteractionByIdParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<Interaction>

create

• create(
      params: CreateAgentInteractionParamsNonStreaming,
      options?: RequestOptions,
  ): APIPromise<Interaction>

  Creates a new interaction.

  Parameters

  • params: CreateAgentInteractionParamsNonStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Interaction>
• create(
      params: CreateModelInteractionParamsNonStreaming,
      options?: RequestOptions,
  ): APIPromise<Interaction>

  Creates a new interaction.

  Parameters

  • params: CreateModelInteractionParamsNonStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Interaction>
• create(
      params: CreateAgentInteractionParamsStreaming,
      options?: RequestOptions,
  ): APIPromise<Stream<InteractionSSEEvent>>

  Creates a new interaction.

  Parameters

  • params: CreateAgentInteractionParamsStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<InteractionSSEEvent>>
• create(
      params: CreateModelInteractionParamsStreaming,
      options?: RequestOptions,
  ): APIPromise<Stream<InteractionSSEEvent>>

  Creates a new interaction.

  Parameters

  • params: CreateModelInteractionParamsStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<InteractionSSEEvent>>
• create(
      params: CreateInteractionParams,
      options?: RequestOptions,
  ): APIPromise<CreateInteractionResponse>

  Creates a new interaction.

  Parameters

  • params: CreateInteractionParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<CreateInteractionResponse>

delete

• delete(
      id: string,
      params?: DeleteInteractionParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<void>

  Deletes the interaction by id.

  Parameters

  • id: string
  • Optionalparams: DeleteInteractionParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<void>

get

• get(
      id: string,
      params?: GetInteractionByIdParamsNonStreaming,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<Interaction>

  Retrieves the full details of a single interaction based on its Interaction.id.

  Parameters

  • id: string
  • Optionalparams: GetInteractionByIdParamsNonStreaming
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<Interaction>
• get(
      id: string,
      params: GetInteractionByIdParamsStreaming,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<Stream<InteractionSSEEvent>>

  Retrieves the full details of a single interaction based on its Interaction.id.

  Parameters

  • id: string
  • params: GetInteractionByIdParamsStreaming
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<Stream<InteractionSSEEvent>>
• get(
      id: string,
      params?: GetInteractionByIdParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<GetInteractionByIdResponse>

  Retrieves the full details of a single interaction based on its Interaction.id.

  Parameters

  • id: string
  • Optionalparams: GetInteractionByIdParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<GetInteractionByIdResponse>